# 設定 Apple App List 任務

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/app_data/apple/app_list/task_post`

**Tags:** DataForSEO

將 App Store 精選系列之一排入佇列，以 `app_collection` 選擇，並回傳任務 `id`。`depth` 限制排行榜讀取到多深。非同步：提交會在 `tasks[0].id` 回傳任務 `id`，擷取工具會在結果就緒後回傳結果。以 `get_dataforseo_app_apple_app_list_fetch` 取得結果。Apple 這一半沒有 HTML 版本。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.012 美元。
- 參考客戶倍率：1.0。不得對已結算的客戶金額再次套用。

僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "app_collection": {
            "type": "string",
            "description": "應用程式集合 必填欄位 App Store 上用來收集應用程式的應用程式集合；可指定以下值：top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "搜尋引擎地點全名 未指定 location_code 時為必填欄位 如果使用此欄位，則無需指定 location_code 可個別向 https://api.dataforseo.com/v3/app_data/apple/locations 發出請求，取得搜尋引擎的可用地點及其 location_name 清單 範例：West Los Angeles,California,United States"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "搜尋引擎地點代碼 未指定 location_name 時為必填欄位 如果使用此欄位，則無需指定 location_name 可個別向 https://api.dataforseo.com/v3/app_data/apple/locations 發出請求，取得搜尋引擎的可用地點及其 location_code 清單 範例：9061121"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "搜尋引擎語言全名 未指定 language_code 時為必填欄位 如果使用此欄位，則無需指定 language_code 可個別向 https://api.dataforseo.com/v3/app_data/apple/languages 發出請求，取得支援的語言及其 language_name 清單 範例：English"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "搜尋引擎語言代碼 未指定 language_name 時為必填欄位 如果使用此欄位，則無需指定 language_name 可個別向 https://api.dataforseo.com/v3/app_data/apple/languages 發出請求，取得支援的語言及其 language_code 清單 範例：en"
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ],
            "description": "任務優先順序 選填欄位 可取以下值：1 – 一般執行優先順序（預設設定）2 – 高執行優先順序 高執行優先順序的任務將額外收費。費用可在定價頁計算。"
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "解析深度 選填欄位 從 App Store SERP 傳回的應用程式數量；預設值：100 最大值：100 每個最多包含 100 筆結果的 SERP 都會計入你的帳戶費用；費用可在定價頁計算。"
          },
          "app_category": {
            "type": [
              "string",
              "null"
            ],
            "description": "App Store 上的應用程式類別 選填欄位 可依應用程式類別篩選結果；範例：lifestyle；可在此處檢視可用類別的完整清單，或個別向 https://api.dataforseo.com/v3/app_data/apple/categories 發出請求"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "使用者自訂任務識別碼 選填欄位 字元數上限為 255 可使用此參數識別任務，並將其與結果對應 可在回應的 data 物件中找到指定的 tag 值"
          },
          "postback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "用於傳送任務結果的 URL 選填欄位 任務完成後，我們會將其結果以 gzip 格式壓縮，並向你指定的 postback_url 傳送 POST 請求 可將 ‘$id’ 字串用作 $id 變數，將 ‘$tag’ 用作經 URL 編碼的 $tag 變數。傳送請求前我們會設定必要的值。範例：http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag 注意：postback_url 中的特殊字元會進行 URL 編碼；例如，# 字元會編碼為 %23 詳情請參閱我們的說明中心"
          },
          "postback_data": {
            "type": [
              "string",
              "null"
            ],
            "description": "postback_url 資料類型 指定 postback_url 時為必填欄位 對應將傳送到你伺服器的資料類型 可能的值：advanced"
          },
          "pingback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "任務完成通知 URL 選填欄位 任務完成後，我們會向你指定的 URL 傳送 GET 請求進行通知 可將 ‘$id’ 字串用作 $id 變數，將 ‘$tag’ 用作經 URL 編碼的 $tag 變數。傳送請求前我們會設定必要的值。範例：http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag 注意：pingback_url 中的特殊字元會進行 URL 編碼；例如，# 字元會編碼為 %23 詳情請參閱我們的說明中心"
          }
        },
        "example": [
          {
            "app_collection": "top_free_ios",
            "location_code": 2840,
            "language_code": "en",
            "app_category": "games"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "app_collection": "top_free_ios",
      "location_code": 2840,
      "language_code": "en",
      "app_category": "games"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListTaskPostResponseInfo"
    }
  ]
}
```

### 400 — 無法處理該要求。請檢查請求參數。

### 401 — 需要有效的 Felo API 金鑰。

### 402 — 由於未符合計費要求，要求無法繼續。

### 403 — 該帳戶無權執行此操作。

### 429 — 已達到要求或支出上限。

### 502 — 服務無法完成該要求。

### 503 — API 或計費服務暫時無法使用。

### 504 — 服務在處理要求時逾時。

### default — 錯誤回應；上游透傳回應可能採用供應商格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AppDataAppleAppListTaskPostResponseInfo

`#/components/schemas/Response36Afe1097B20_AppDataAppleAppListTaskPostResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_AppDataAppleAppListTaskPostTaskInfo"
              }
            ]
          },
          "description": "任務陣列"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_AppDataAppleAppListTaskPostTaskInfo

`#/components/schemas/Response36Afe1097B20_AppDataAppleAppListTaskPostTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "object",
            "null"
          ],
          "description": "結果陣列在此情況下，該值將為 null"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的目前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "一般狀態碼\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "一般資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "總執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中的任務數",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中傳回錯誤的任務數",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務識別碼\n我們系統中 UUID 格式的唯一任務識別碼"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任務的狀態碼\n由 DataForSEO 產生，範圍如下：10000-60000\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務的資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 陣列中的元素數",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路徑"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 請求中指定的相同參數"
    }
  }
}
```