Перейти к содержимому
RU
Ключ API
Обзор документации

Справочник API

Найдите видео на сайтах с видео Google. Извлеките заголовки, видео ссылки, миниатюры, продолжительность и исходную информацию.

Создать запрос

Дополнительные параметры

Начинается с 1. Каждая страница представляет собой отдельный запрос.

Фильтр времени Google, такой как qdr:d за прошедший день.

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": "google_videos",
    "query": "me at the zoo",
    "params": {
        "gl": "us",
        "hl": "en",
        "num": 10,
        "page": 1,
    },
}

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 / Обязательно
Настройка на google_videos.
querystring / Обязательно
Поисковый запрос. Поддерживает поисковые операторы Google, такие как site: и intitle:.
1 то 2 000 персонажиПо умолчанию: Не установлен
paramsobject / Необязательно
Settings для этого запроса.
По умолчанию: {}
callback_urlstring · nullable / Необязательно
Async и пакетные. Публичный HTTPS завершает URL на порте 443, вплоть до символов 2,048. Никаких учетных данных пользователя или фрагмента URL. Omit, используйте null или пустую строку без уведомления. В партии, установите это на каждый запрос, вне парамов.
По умолчанию: Не установлен

Страна, язык и местоположение

params.glstring / Необязательно
Двухбуквенный код страны, например, gb, de или sg. Настройте явно, чтобы выбрать страну.
Точно. 2 персонажиПо умолчанию: Не установлен
Принятый формат^[A-Za-z]{2}$
params.hlstring / Необязательно
Язык интерфейса Google. Настройте явно, чтобы выбрать язык.
1 то 35 персонажиПо умолчанию: Не установлен
Принятый формат^[A-Za-z0-9-]+$
params.locationstring / Необязательно
Запрашиваемое место поиска, предпочтительно город, такой как "London, England, United Kingdom". Доступность зависит от типа поиска.
1 то 200 персонажиПо умолчанию: Не установлен

Начинание

params.numinteger / Необязательно
Запрошенный результат подсчитан. FlashData не добавляет фиксированный по умолчанию, когда он опущен. Возвращенное количество может отличаться по типу запроса и поиска.
1 то 100, целые числаПо умолчанию: Не установлен
params.pageinteger / Необязательно
Запрошенная страница результатов. Устанавливается явно. Каждая страница представляет собой отдельный запрос API.
1 то 100, целые числаПо умолчанию: Не установлен

Поисковые фильтры

params.tbsstring / Необязательно
Запрошенные фильтры поиска Google, такие как qdr:d за прошедший день или qdr:w за прошлую неделю. Доступность зависит от типа поиска.
1 то 200 персонажиПо умолчанию: Не установлен
params.autocorrectboolean / Необязательно
Запросить исправление орфографии с помощью true или запросить его отключение с помощью false. Прикладное поведение зависит от типа поиска; не использовать поведение Google.
true или falseПо умолчанию: Не установлен

Ответ

Realtime возвращается status: done с выходом поиска в results[0]. Матчи проходят results[0].videos. usage.credits Записывает обвинение.

Результаты описывают видео и ссылки на их страницы; они не содержат загружаемых носителей. Дополнительные поля продолжительности, даты и канала возвращаются в соответствии с Google.

Прочитайте результат

Сохраните успешный ответ 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 = [
    {"title": item.get("title"), "url": item.get("link"), "duration": item.get("duration")}
    for item in result.get("videos", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))

Доступные поля зависят от типа запроса и поиска. Факультативные поля могут отсутствовать, а дополнительные поля могут быть возвращены.

Количество возвращенных предметов и searchParameters.num может отличаться от params.num. Используйте возвращенный массив для определения фактического количества результатов.

Все поля ответов
ПолеОписание
sourcestringЗапрошенный источник API.
statusstringДелается, когда запрос в режиме реального времени успешен.
created_atstringВремя создания ответов в формате ISO 8601.
usage.creditsnumberКредиты, взимаемые за запрос, исходя из вашего плана.
results[0].searchParametersobjectНастройки поиска, сообщенные Google, с запросом, записанным как q. Возвращенные настройки могут отличаться от запрашиваемых значений.
results[0].videosarrayРезультаты поиска видео от Google.
results[0].videos[].titlestringНазвание видео.
results[0].videos[].linkstringВидео-страница URL.
results[0].videos[].snippetstring · optionalВыдержка из описания видео.
results[0].videos[].durationstring · optionalФорматированная продолжительность видео.
results[0].videos[].sourcestring · optionalХостинг сайта.
results[0].videos[].channelstring · optionalИздательство или название канала.
results[0].videos[].datestring · optionalДата публикации: Google.
results[0].videos[].imageUrlstring · optionalВидео миниатюра URL.
results[0].videos[].positionintegerИтоговая позиция.
results[0].videos[].videoUrlstring · optionalВидео URL, представленное Google, когда оно доступно.

Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.

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: Принесите результаты. 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 вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение 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": "google_videos",
  "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

Восстановление ошибок

Завершенный поиск может содержать меньше совпадений, чем запрашивалось. Проверить gl, hl, расположение и фильтры; необязательные поля с богатыми результатами могут отсутствовать.

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

Ошибки и коды состояния · Когда повторно · Ограничения по ставкам

Пошаговое руководство: Выберите и уточните поиск Google

Цены

ПланыСтавки использованияза 1 000 запросовПодпискиВключенные кредиты за расчетный период
Оплата по использованию1,00 $Без ежемесячной платыПополняйте по мере необходимости
Micro0,80 $49,00 $ / месяц1 000 кредиты ()50,00 $ из API использование, включая
Starter0,65 $199,00 $ / месяц4 000 кредиты ()200,00 $ из API использование, включая
Pro0,60 $499,00 $ / месяц10 000 кредиты ()500,00 $ из API использование, включая
Scale0,50 $999,00 $ / месяц20 000 кредиты ()1 000,00 $ из API использование, включая
Business0,40 $1 999,00 $ / месяц40 000 кредиты ()2 000,00 $ из API использование, включая

Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.

Текущие цены и лимиты плана