# Постановка задач органической выдачи YouTube

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/youtube/organic/task_post`

**Tags:** DataForSEO

Ставит в очередь ранжированные результаты по ключевому слову в YouTube и возвращает `id` задачи в `tasks[0].id`. Ответ обёрнут в конверт DataForSEO: данные в `tasks[0].result`, результат в `tasks[0].status_code` — отклонённый запрос всё равно возвращает HTTP 200. Живой двойник отвечает сразу и проще для одного запроса; ставьте в очередь, когда пакет не укладывается во время вызова инструмента.

### Справочные цены

- Тарификация: стоимость ответа по данным провайдера.
- Справочная оценка запроса: USD 0.02.
- Справочный множитель для клиента: 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": "ключевое слово\nобязательное поле\nв поле keyword можно указать до 700 символов\nвсе %## будут декодированы (символ «+» декодируется в пробел)\nесли в keyword нужен символ «%», укажите его как «%25»;\nесли в keyword нужен символ «+», укажите его как «%2B»;\nподробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в этой статье Help Center"
          },
          "location_code": {
            "type": [
              "integer",
              "null"
            ],
            "description": "код местоположения поисковой системы\nобязательное поле, если не указан location_name\nесли используете это поле, location_name указывать не нужно\nсписок доступных местоположений поисковых систем с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/locations\nпример:\n2840"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "код языка поисковой системы\nобязательное поле, если не указан language_name\nесли используете это поле, language_name указывать не нужно\nсписок доступных языков поисковой системы с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/languages\nпример:\nen"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "тип устройства\nнеобязательное поле\nвозвращать результаты для определённого типа устройства\nдоступные значения: desktop, mobile"
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ],
            "description": "приоритет задачи\nнеобязательное поле\nможет принимать следующие значения:\n1 — обычный приоритет выполнения (устанавливается по умолчанию)\n2 — высокий приоритет выполнения\nЗа задачи с высоким приоритетом выполнения взимается дополнительная плата.\nСтоимость можно рассчитать на странице Pricing."
          },
          "pingback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL уведомления о завершённой задаче\nнеобязательное поле\nкогда задача выполнена, мы уведомим вас GET-запросом на указанный вами URL\nстроку «$id» можно использовать как переменную $id, а «$tag» — как urlencoded-переменную $tag. Перед отправкой запроса мы подставим нужные значения.\nпример:\nhttp://your-server.com/pingscript?id=$id\nhttp://your-server.com/pingscript?id=$id&tag=$tag\nПримечание: специальные символы в pingback_url будут закодированы в URL;\nв частности, символ # будет закодирован как %23\nподробнее — в нашем справочном центре"
          },
          "postback_url": {
            "type": [
              "string",
              "null"
            ],
            "description": "URL для отправки результатов задачи\nнеобязательное поле\nкогда задача будет выполнена, мы отправим POST-запрос с результатами, сжатыми в формате gzip, на указанный вами postback_url\nстроку «$id» можно использовать как переменную $id, а «$tag» — как urlencoded-переменную $tag. Перед отправкой запроса мы подставим нужные значения.\nпример:\nhttp://your-server.com/postbackscript?id=$id\nhttp://your-server.com/postbackscript?id=$id&tag=$tag\nПримечание: специальные символы в postback_url будут закодированы в URL;\nв частности, символ # будет закодирован как %23\nподробнее — в нашем справочном центре"
          },
          "postback_data": {
            "type": [
              "string",
              "null"
            ],
            "description": "тип данных postback_url\nобязательное поле, если указан postback_url\nсоответствует типу данных, который будет отправлен на ваш сервер\nвозможное значение:\nadvanced"
          },
          "location_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "полное название местоположения поисковой системы\nобязательное поле, если не указан location_code\nесли используете это поле, location_code указывать не нужно\nсписок доступных местоположений поисковой системы с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/locations\nпример:\nUnited States"
          },
          "language_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "полное название языка поисковой системы\nобязательное поле, если не указан language_code\nесли используете это поле, language_code указывать не нужно\nсписок доступных языков поисковой системы с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/youtube/languages\nпример:\nEnglish"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "операционная система устройства\nнеобязательное поле\nесли в поле device указано desktop, выберите одно из следующих значений: windows, macos\nзначение по умолчанию: windows\nесли в поле device указано mobile, выберите одно из следующих значений: android, ios\nзначение по умолчанию: android"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "пользовательский идентификатор задачи\nнеобязательное поле\nограничение — 255 символов\nэтот параметр позволяет идентифицировать задачу и сопоставить её с результатом\nуказанное значение tag можно найти в объекте data ответа"
          },
          "search_param": {
            "type": [
              "string",
              "null"
            ],
            "description": "дополнительные параметры поискового запроса\nнеобязательное поле\nпример:\nsp=EgIQAg%253D%253D"
          },
          "block_depth": {
            "type": [
              "integer",
              "null"
            ],
            "description": "глубина парсинга\nнеобязательное поле\nколичество блоков результатов в SERP\nзначение по умолчанию: 20\nмаксимальное значение: 700\nПримечание: оплата взимается за каждый SERP, содержащий до 20 блоков результатов;\nпоэтому установка глубины блоков выше 20 может привести к дополнительным расходам, если поисковая система возвращает более 20 результатов;\nесли указанная глубина блоков превышает количество результатов в ответе, разница автоматически вернётся на баланс вашего аккаунта"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "audi"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "audi"
    }
  ]
}
```

## Responses

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

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

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

### Response36Afe1097B20_SerpYoutubeOrganicTaskPostResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicTaskPostResponseInfo`

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

### Response36Afe1097B20_SerpYoutubeOrganicTaskPostTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpYoutubeOrganicTaskPostTaskInfo`

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