Обзор документации
Справочник API
YouTube Suggestions API
Восстановите предложения автозаполнения YouTube для ключевого слова или фразы с контролем языка и региона.
Создать запрос
Языковые коды, такие как en.
Двухбуквенный код страны, например, США.
https://data.flashdata.dev/v1/queries/realtimeПараметры
Отправить source и query на высшем уровне. Варианты источника принадлежат params. Факультативные поля можно опустить.
Тело запроса
sourcestring / Обязательно- Настройка на youtube_suggestions.
querystring / Обязательно- Приставка поиска.1 то 2 000 персонажиПо умолчанию:
Не установлен paramsobject / Необязательно- Settings для этого запроса.По умолчанию:
{} callback_urlstring · nullable / Необязательно- Async и пакетные. Публичный HTTPS завершает URL на порте 443, вплоть до символов 2,048. Никаких учетных данных пользователя или фрагмента URL. Omit, используйте null или пустую строку без уведомления. В партии, установите это на каждый запрос, вне парамов.По умолчанию:
Не установлен
Язык и регион
params.languagestring / Необязательно- Языковой код.1 то 35 персонажиПо умолчанию:
"en"Принятый формат
^[A-Za-z0-9-]+$ params.regionstring / Необязательно- Двухбуквенный код страны, такой как US, GB или DE.Точно. 2 персонажиПо умолчанию:
"US"Принятый формат
^[A-Za-z]{2}$
Ответ
Realtime возвращается status: done. Прочитайте исходный текст на results[0]; usage.credits Записывает обвинение.
results[0] — это набор предложенных поисковых фраз, а не видеообъектов. Он может быть пустым; в этом ответе нет видео IDs или вовлеченности.
Прочитайте результат
Сохраните успешный ответ JSON как response.json. Сохраните это как read-response.py и запустите python read-response.py. Он использует только стандартную библиотеку Python и не делает никаких новых запросов.
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = result # An array of phrases, including an empty array.
print(json.dumps(output, ensure_ascii=False, indent=2))Отправьте префикс поиска в виде запроса. язык и область с двумя буквами принадлежат парам; по умолчанию находятся en и US. Они влияют на контекст автозаполнения, а не на метаданные видео.
Используйте поиск или расширенный поиск с предложенной фразой для видео discover. Предложения не поддерживают max_results или поисковые фильтры.
Все поля ответов
| Поле | Описание |
|---|---|
sourcestring | Запрошенный источник API. |
statusstring | Делается, когда запрос в режиме реального времени успешен. |
created_atstring | Время создания ответов в формате ISO 8601. |
usage.creditsnumber | Кредиты, взимаемые за запрос, исходя из вашего плана. |
results[0]array<string> | Автозаполнение предложений. Каждая запись массива представляет собой предложенную поисковую фразу. |
Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.
Async возвращает одну квитанцию о приеме на работу; партия возвращает одну за одну работу запрос. Проверяйте статус каждой работы и извлекайте ее результаты, используя возвращенные ссылки.
Async и пакетный жизненный цикл
Подача возвращает квитанцию, а не результаты. Async создает одну работу; партия возвращает отдельную работу в queries[] на каждый принятый запрос. Отслеживайте и извлекайте каждую работу самостоятельно.
Представить data.flashdata.dev; читать статус работы и результаты api.flashdata.dev С тем же X-API-Key. Связанные базовые примеры API используют Python и cURL.
1. Сохранить работу IDs
Держите поля запросов этого источника при переходе на Async. Для Batch поместите каждый запрос в массив запросов объекта JSON. Сохраните все возвращенные работы ID.
2. Проверьте статус
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: Опрос с задержкой и уважениемRetry-Afterкогда присутствует.completed: Принесите результаты.failed: Проверитьjob.error.Читайте job.status, а не статус квитанции о представлении.
Проверить статус: Python и cURL
Статус работы API ссылка3. Получить результаты
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsПосле завершения аутентификации считывайте результат, а затем возьмите хранилище 302 URL без ключа API. Сохраните JSON в течение часов завершения 24.
Результаты поиска: Python и cURL · Форматы ответов
Результат скачивания ссылки API
Опросы и получение существующих результатов не потребляют кредиты запросов. Тайм-аут для голосования не отменяет работу: сохраняйте свой ID вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение retry.
Вебхуки завершения
Подписаться на запрос
Настройка callback_url на верхнем уровне асинхронного запроса, или Внутри каждого запроса в партии, снаружи params. Отдельного запроса на регистрацию webhook не требуется. Запросы Realtime не отправляют обратные вызовы.
Используйте общедоступный HTTPS URL на порту 443. FlashData POST - уведомление для каждой работы completed или failed; Событие содержит ссылки, а не сам результат.
Признать и проверить
Возвращение 2xx После того, как он принял это событие. Дублировать через delivery_id, Также посланный как X-Delivery-Id. Переадресации не выполняются.
Неудачные поставки с экспоненциальным обратным откатом, вплоть до 8 - полная версия и в большинстве 24 часов после завершения. Продолжайте опросы как запасной вариант.
Обратные звонки не подписаны. Подтвердить работу ID, исходный и терминальный статус через аутентифицированная конечная точка статуса перед обработкой уведомления. Поставка ID предназначена для дедупликации, а не для подтверждения подлинности.
Пример события web-cook и полей
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_suggestions",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| Поле | Описание |
|---|---|
delivery_idstring | Стабильный идентификатор доставки. Дублировать уведомления с использованием этого значения; он также отправляется в заголовке X-Delivery-Id. |
idstring | Работать ID. |
sourcestring | Запрошенный источник данных. |
statusstring | завершены или не выполнены. |
linksarray | Статус и результат ссылки. Уведомления не включают контент результата или ключ API. |
links[].relstring | себя или результаты. |
links[].hrefstring | Абсолютный менеджмент API URL; аутентифицируйтесь с помощью ключа API. |
links[].methodstring | GET. |
Восстановление ошибок
Никакие предложения для приставки не являются успешным пустым ответом. При необходимости отрегулируйте префикс, язык или регион; не рассматривайте пустой массив как неудачную работу.
Для аутентификации, баланса, сбоев формата запроса и ограничения скорости используйте общую ссылку на ошибку. Тайм-аут может все еще создать работу; проверьте существующую работу перед повторным использованием.
Ошибки и коды состояния · Когда повторно · Ограничения по ставкам
Пошаговое руководство: Превратите предложения в поиск
Цены
| Планы | Ставки использованияза 1 000 стандартных запросов | Подписки | Включенные кредиты за расчетный период |
|---|---|---|---|
| Оплата по использованию | 0,50 $ | Без ежемесячной платы | Пополняйте по мере необходимости |
| Micro | 0,40 $ | 49,00 $ / месяц | 1 000 кредиты ()50,00 $ из API использование, включая |
| Starter | 0,35 $ | 199,00 $ / месяц | 4 000 кредиты ()200,00 $ из API использование, включая |
| Pro | 0,30 $ | 499,00 $ / месяц | 10 000 кредиты ()500,00 $ из API использование, включая |
| Scale | 0,25 $ | 999,00 $ / месяц | 20 000 кредиты ()1 000,00 $ из API использование, включая |
| Business | 0,20 $ | 1 999,00 $ / месяц | 40 000 кредиты ()2 000,00 $ из API использование, включая |
Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.
Текущие цены и лимиты плана