# Apple App List タスクの設定

**API:** Data API

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

**Tags:** DataForSEO

App Store のキュレーションコレクションの 1 つを `app_collection` で選んでキューに登録し、タスク `id` を返します。`depth` はチャートをどこまで読むかを制限します。非同期です。送信すると `tasks[0].id` にタスク `id` が返り、フェッチツールは準備ができ次第結果を返します。`get_dataforseo_app_apple_app_list_fetch` で取得します。Apple 側には HTML バリアントはありません。

### 料金の参考情報

- 計測方法: 報告されたレスポンスコスト。
- 参考リクエスト見積もり: 0.012 USD。
- 参照用の顧客乗数: 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 を指定する必要はありません location_name を付した検索エンジンの利用可能な所在地のリストは、https://api.dataforseo.com/v3/app_data/apple/locations に個別にリクエストして取得できます 例：West Los Angeles,California,United States"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "検索エンジンの所在地コード location_name を指定しない場合は必須フィールド このフィールドを使用する場合、location_name を指定する必要はありません location_code を付した検索エンジンの利用可能な所在地のリストは、https://api.dataforseo.com/v3/app_data/apple/locations に個別にリクエストして取得できます 例：9061121"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "検索エンジンの言語の正式名 language_code を指定しない場合は必須フィールド このフィールドを使用する場合、language_code を指定する必要はありません language_name を付した利用可能な言語のリストは、https://api.dataforseo.com/v3/app_data/apple/languages に個別にリクエストして取得できます 例：English"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "検索エンジンの言語コード language_name を指定しない場合は必須フィールド このフィールドを使用する場合、language_name を指定する必要はありません language_code を付した利用可能な言語のリストは、https://api.dataforseo.com/v3/app_data/apple/languages に個別にリクエストして取得できます 例：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 です このパラメーターを使用してタスクを識別し、結果と照合できます 指定した tag の値はレスポンスの data オブジェクトに含まれます"
          },
          "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": "タスクの総コスト（USD）",
      "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": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 10000-60000\nレスポンスコードの完全な一覧はこちらです"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "タスクの情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "実行時間（秒）"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "タスクの総コスト（USD）",
      "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 リクエストで指定したものと同じパラメーターを含みます"
    }
  }
}
```
