Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

YouTube Suggestions API

Отримайте API-ключ

Отримайте автоматичні пропозиції YouTube для ключового слова або фрази, з управлінням мови та області.

Створити запит

Забороняється або припуск мовного коду, наприклад,

Двосторонній код країни, наприклад, США.

POSThttps://data.flashdata.dev/v1/queries/realtime
Python 3 · requests
python3 -m pip install requests
import json

import requests

api_key = "YOUR_API_KEY"
payload = {
    "source": "youtube_suggestions",
    "query": "python",
    "params": {
        "language": "en",
        "region": "us",
    },
}

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": api_key, "Accept": "application/json"},
    json=payload,
    timeout=120,
)
response.raise_for_status()
print(json.dumps(response.json(), ensure_ascii=False, indent=2))
Результати у відповідь HTTPавтентифікації X-API-Key

Параметри

Відправити source і query на рівні вершини. Параметри джерела відносяться до params. Додаткові поля можуть бути використані.

Тіло запиту

sourcestring / Обов’язково
Набір до youtube_suggestions.
querystring / Обов’язково
Пошук префікса.
1 до 2 000 ЗіркиЗа замовчуванням: Не встановити
paramsobject / Необов’язково
Settings для цього запиту.
За замовчуванням: {}
callback_urlstring · nullable / Необов’язково
Async і партії тільки. Public HTTPS завершена URL на порту 443, до 2,048 символів. Немає облікових даних користувача або фрагмента URL. Omit, використовуйте null або порожній рядок для повідомлення. У партії, встановивши це на кожному запиту, за межами парам.
За замовчуванням: Не встановити

Мова та регіон

params.languagestring / Необов’язково
Код мови.
1 до 35 ЗіркиЗа замовчуванням: "en"
Прийнятий формат^[A-Za-z0-9-]+$
params.regionstring / Необов’язково
Двосторонній код країни, наприклад, США, 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- стандартна бібліотека і не дає нового запиту.

read-response.py
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))

Відправте префіксацію пошуку як запиту. мова та двостороння область належать до парам; за замовчуванням є і США. Вони впливають на автоматичний контекст, а не метаданих відео.

Використовуйте пошук або розширений пошук з запропонованою фразою до відео 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. 1. Заощаджуйте роботу IDs

    Зберігати поля запиту джерела при переході на Async. Для Batch викласти кожен запит у масив запитів об'єкта JSON. Заощаджуйте кожну подану роботу ID.

    Async запит та отримання · Batch запит тіла

  2. 2. Статус на сервери

    GET https://api.flashdata.dev/v2/jobs/{jobId}

    pending / processing: опитування з затримкою та повагою Retry-After присутні. completed: результати fetch. failed: огляд job.error.

    Читать job.status, не статус отримання інформації.

    Перевірити статус · Python і cURL

    Статус на сервери API посилання
  3. 3. Результати Фетт

    GET https://api.flashdata.dev/v2/jobs/{jobId}/results

    Після завершення перевірте результат читати, після чого викинути 302 пам'ять URL без ключа API. Заощаджуйте JSON в межах 24 годин завершення.

    Результати розрахунків · Python і cURL · Формати відповідей

    Завантажити API

Половлення та вилучення існуючих результатів не споживають кредитні запити. Час вилучення не скасовує роботу: зберігайте ID замість подання дублікатів, які запроваджують роботу. Коди помилок та поведінка птиця.

Вебхуки завершення

Підписатися на запит

Комплекти callback_url на рівні асинхронного запиту, або всередині кожного запиту в партії, поза params. Не потрібно окремий запит на веб-візію. Realtime не надсилайте зворотні дзвінки.

Використовуйте публічний HTTPS URL на порту 443. FlashData POSTS повідомлення для кожного досягнення роботи completed або failed; подія містить посилання, не сам результат.

Acknowledge і перевірка

Повернутися 2xx після того, як багато хто приймає захід. Дублікат delivery_id, також відправлений як X-Delivery-Id. Не слідувати перенаправлення.

В'язані поставки птиця з експоненціальним відключенням, до 8 намагатися всього і в більшості 24 годин після завершення. Зберігайте опитування як падлогу.

Відкликання не відмічаються. Підтвердіть роботу ID, джерело та статус терміналу через автентифікована кінцева точка стану перед обробкою повідомлення. Доставка ID призначена для дедупації, не вистосування автентичності.

Приклад подій та полів вебхока
Ілюстрація повідомлення про завершення
{
  "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[].methodstringGET.

Повна угода вебхока та обмеження URL

Відновлення пароля

Відповіді на префікс – це успішна порожня відповідь. Налаштуйте префікс, мову або область, якщо це необхідно; не лікуйте порожній масив як не вдалося працювати.

Для автентифікації, балансу, запиту та обмеження, використовуйте посилання на спільну помилку. Термін подачі може бути ще створено роботу; перевірити існуючу роботу перед спрацьовуванням.

Помилки й коди стану · Коли птиця · Обмеження ставок

Покроковий посібник: Поверніть пропозиції в пошук

Ціни

ПланиТарифи на користуванняза 1 000 стандартних запитівАбонентиВключені кредити за вексельний період
Оплата за використання0,50 USDБез щомісячної платиПоповнюйте за потреби
Micro0,40 USD49,00 USD / місяць1 000 кредити (50,00 USD використання API) включені
Starter0,35 USD199,00 USD / місяць4 000 кредити (200,00 USD використання API) включені
Pro0,30 USD499,00 USD / місяць10 000 кредити (500,00 USD використання API) включені
Scale0,25 USD999,00 USD / місяць20 000 кредити (1 000,00 USD використання API) включені
Business0,20 USD1 999,00 USD / місяць40 000 кредити (2 000,00 USD використання API) включені

Один тариф облікового запису. Спільні кредити для трьох продуктів. Використання, покрите включеними кредитами, повторно не оплачується.

Поточні ціни та ліміти плану