# Настройка задач 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` ограничивает глубину чтения чарта. Асинхронно: при отправке возвращается `id` задачи в `tasks[0].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 — высокий приоритет выполнения Задачи с высоким приоритетом выполнения оплачиваются дополнительно. Стоимость можно рассчитать на странице Pricing."
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "глубина парсинга необязательное поле количество приложений, возвращаемых из SERP App Store; значение по умолчанию: 100 максимальное значение: 100 С каждого SERP, содержащего до 100 результатов, с вашего аккаунта взимается плата; Стоимость можно рассчитать на странице Pricing."
          },
          "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 для отправки результатов задачи необязательное поле после завершения задачи мы отправим POST-запрос с её результатами, сжатыми в формате gzip, на указанный вами postback_url строку ‘$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 подробнее читайте в Help Center"
          },
          "postback_data": {
            "type": [
              "string",
              "null"
            ],
            "description": "тип данных postback_url обязательное поле, если указан postback_url соответствует типу данных, который будет отправлен на ваш сервер возможные значения: advanced"
          },
          "pingback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL уведомления о завершении задачи необязательное поле когда задача будет завершена, мы уведомим вас GET-запросом на указанный вами URL строку ‘$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 подробнее читайте в Help Center"
          }
        },
        "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 — Требуется действительный API-ключ Felo.

### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.

### 403 — Аккаунту не разрешено выполнять эту операцию.

### 429 — Достигнут лимит запросов или расходов.

### 502 — Сервис не смог выполнить запрос.

### 503 — API или сервис биллинга временно недоступны.

### 504 — Истекло время ожидания обработки запроса.

### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

**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": "массив результатов\nв этом случае значение будет 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": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 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-запросе"
    }
  }
}
```