# Настройка задач Apple App Searches

**API:** Data API

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

**Tags:** DataForSEO

Ставит в очередь поиск в App Store по `keyword` и возвращает `id` задачи. Его формируют `location_code`, `language_code` и `depth`. Асинхронно: при отправке возвращается `id` задачи в `tasks[0].id`, а инструмент получения возвращает результат, когда он готов. ⚠️ В отличие от аналога для Google, часть Apple не предлагает HTML-вариант — единственная форма — разобранный результат. Получите результат с помощью `get_dataforseo_app_apple_app_searches_fetch`.

### Справочная информация о цене

- Тарификация: по заявленной стоимости ответа.
- Ориентировочная стоимость запроса: 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": {
          "keyword": {
            "type": "string",
            "description": "<em>ключевое слово</em><br><strong>обязательное поле</strong><br><strong>до 700 символов</strong> можно указать в поле <code>keyword</code>;<br>все последовательности %## декодируются (‘+’ декодируется в пробел);<br>если в <code>keyword</code> нужен символ “%”, укажите его как “%25”;<br>если в <code>keyword</code> нужен символ “+”, укажите его как “%2B”<p>Подробнее о правилах и ограничениях полей <code>keyword</code> и <code>keywords</code> в API DataForSEO читайте в этой <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">статье Help Center</a>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>полное название местоположения поисковой системы</em><br><strong>обязательное поле, если не указан <code>location_code</code></strong><br><strong>если вы используете это поле, указывать <code>location_code</code> не нужно</strong><br>список доступных местоположений поисковой системы с их <code>location_name</code> можно получить, сделав отдельный запрос к <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>пример:<br><code class=\"long-string\">West Los Angeles,California,United States</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>код местоположения поисковой системы</em><br><strong>обязательное поле, если не указан <code>location_name</code></strong><br><strong>если вы используете это поле, указывать <code>location_name</code> не нужно</strong><br>список доступных местоположений поисковой системы с их <code>location_code</code> можно получить, сделав отдельный запрос к <code>https://api.dataforseo.com/v3/app_data/apple/locations</code><br>пример:<br><code class=\"long-string\">9061121</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>полное название языка поисковой системы</em><br><strong>обязательное поле, если <code>language_code</code> не указан</strong><br>если вы используете это поле, указывать <code>language_code</code> не нужно<br>список доступных языков с их <code>language_name</code> можно получить, сделав отдельный запрос к <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><br>пример:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": "string",
            "description": "<em>код языка поисковой системы</em><br><strong>обязательное поле, если <code>language_name</code> не указан</strong><br>если вы используете это поле, указывать <code>language_name</code> не нужно<br>список доступных языков с их <code>language_code</code> можно получить, сделав отдельный запрос к <code>https://api.dataforseo.com/v3/app_data/apple/languages</code><em><br></em>пример:<em><br></em><code class=\"long-string\">en</code>"
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>приоритет задачи</em><br>необязательное поле<br>может принимать следующие значения:<br>1 — обычный приоритет выполнения (устанавливается по умолчанию)<br>2 — высокий приоритет выполнения Задачи с высоким приоритетом выполнения оплачиваются дополнительно.<br>Стоимость можно рассчитать на странице <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/api/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a>."
          },
          "depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>глубина парсинга</em><br>необязательное поле<br>количество результатов, возвращаемых из SERP App Store;<br>мы настоятельно рекомендуем задавать глубину парсинга кратной 100, так как наша система обрабатывает по 100 результатов подряд;<br>значение по умолчанию: <code>100</code><br>максимальное значение: <code>700</code><br><strong>С каждого SERP, содержащего до 100 результатов, с вашего аккаунта взимается плата;</strong> <br>Установка глубины выше 100 может привести к дополнительным расходам, если поисковая система вернёт больше 100 результатов</a>;<br>Стоимость можно рассчитать на странице <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/app-data/app-store\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a>."
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>пользовательский идентификатор задачи</em><br>необязательное поле<br><em>ограничение — 255 символов</em><br>этот параметр позволяет идентифицировать задачу и сопоставить её с результатом<br>указанное значение <code>tag</code> вы найдёте в объекте <code>data</code> ответа"
          },
          "postback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>URL для отправки результатов задачи</em><br>необязательное поле<br>когда задача будет выполнена, мы отправим POST-запрос с результатами, сжатыми в формате <code>gzip</code>, на указанный вами <code>postback_url</code><br>строку «$id» можно использовать как переменную <code>$id</code>, а «$tag» — как urlencoded-переменную <code>$tag</code>. Перед отправкой запроса мы подставим нужные значения.<br>пример:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&amp;tag=$tag</code><br><strong>Примечание:</strong> специальные символы в <code>postback_url</code> будут urlencoded;<br>в частности, символ <code>#</code> кодируется как <code>%23</code><p>Подробнее см. в <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>"
          },
          "postback_data": {
            "type": "string",
            "description": "<em>тип данных postback_url</em><br><strong>обязательное поле, если указан <code>postback_url</code></strong><br>соответствует типу данных, который будет отправлен на ваш сервер<br>возможные значения:<br><code>advanced</code>"
          },
          "pingback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>URL уведомления о завершении задачи</em><br>необязательное поле<br>когда задача будет выполнена, мы отправим GET-запрос на указанный вами URL<br>строку «$id» можно использовать как переменную <code>$id</code>, а «$tag» — как urlencoded-переменную <code>$tag</code>. Перед отправкой запроса мы подставим нужные значения.<br>пример:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&amp;tag=$tag</code><br><strong>Примечание:</strong> специальные символы в <code>pingback_url</code> будут urlencoded;<br>в частности, символ <code>#</code> кодируется как <code>%23</code><p>Подробнее см. в <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>"
          }
        },
        "example": [
          {
            "keyword": "vpn",
            "location_code": 2840,
            "language_code": "en",
            "depth": 200
          }
        ]
      }
    ]
  },
  "example": [
    {
      "keyword": "vpn",
      "location_code": 2840,
      "language_code": "en",
      "depth": 200
    }
  ]
}
```

## Responses

### 200 — Успешная операция

Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.

**application/json**

Schema: object | null

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

### 400 — Запрос не удалось обработать. Проверьте параметры запроса.

### 401 — Требуется действительный API-ключ Felo.

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AppDataAppleAppSearchesTaskPostResponseInfo

`#/components/schemas/Response36Afe1097B20_AppDataAppleAppSearchesTaskPostResponseInfo`

```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_AppDataAppleAppSearchesTaskPostTaskInfo"
              }
            ]
          },
          "description": "<em>массив задач</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_AppDataAppleAppSearchesTaskPostTaskInfo

`#/components/schemas/Response36Afe1097B20_AppDataAppleAppSearchesTaskPostTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "object",
            "null"
          ],
          "description": "<em>массив результатов</em><br>в этом случае значение будет <code>null</code>"
        }
      }
    }
  ]
}
```

### 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-запросе"
    }
  }
}
```
