Przejdź do treści
PL
Uzyskaj klucz API
Przeglądaj dokumentację

Dokumentacja API

YouTube Suggestions API

Uzyskaj klucz API

Retrieve YouTube autocomplete sugestie dla słowa kluczowego lub frazy, z kontrolą języka i regionu.

Utwórz żądanie

Podpis lub sugestia kod języka, takich jak pl.

Dwuliterowy kod kraju, taki jak USA.

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))
Wyniki w odpowiedzi na HTTPUwierzytelnianie X-API-Key

Parametry

Wyślij source oraz query na najwyższym poziomie. Opcje źródłowe należą do params. Można pominąć pola opcjonalne.

Treść żądania

sourcestring / Wymagane
Ustaw na youtube_suggestions.
querystring / Wymagane
Przeszukajcie przedrostek.
1 do 2000 znakiDomyślnie: Nieustawione
paramsobject / Opcjonalne
Settings dla tego wniosku.
Domyślnie: {}
callback_urlstring · nullable / Opcjonalne
Async i tylko partia. Publiczne ukończenie HTTPS URL na porcie 443, do znaków 2,048. Brak danych uwierzytelniających użytkownika lub fragmentu URL. Omit, użyj null lub pustego łańcucha bez powiadomienia. W partii, ustawić to na każdym zapytaniu, na zewnątrz params.
Domyślnie: Nieustawione

Język i region

params.languagestring / Opcjonalne
Kod języka.
1 do 35 znakiDomyślnie: "en"
Format zaakceptowany^[A-Za-z0-9-]+$
params.regionstring / Opcjonalne
Dwuliterowy kod kraju, taki jak USA, GB lub DE.
Dokładnie 2 znakiDomyślnie: "US"
Format zaakceptowany^[A-Za-z]{2}$

Odpowiedź

Realtime zwraca status: done. Odczytaj wyjście źródłowe w results[0]; usage.credits Zapisuje zarzuty.

Rezultaty [0] to tablica sugerowanych fraz wyszukiwania, a nie obiektów wideo. Może być pusty; w tej odpowiedzi nie ma wideo IDs ani liczenia zaręczyn.

Przeczytaj wynik

Zapisz udane odpowiedzi JSON jako response.json. Zapisz to jako read-response.py i uruchom python read-response.py. Wykorzystuje tylko standardową bibliotekę Python i nie składa nowego wniosku.

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))

Wyślij przedrostek wyszukiwania jako query. język i region dwuliterowy należą do paramów; domyślne są en i USA. Wpływają one na autokompletny kontekst, a nie na metadane wideo.

Użyj wyszukiwania lub rozszerzonego wyszukiwania z sugerowaną frazą do wideo discover. Sugestie nie obsługują max_results ani filtrów wyszukiwania.

Wszystkie pola odpowiedzi
PoleOpis
sourcestringŻądane źródło API.
statusstringzrobić, gdy realtime wniosek się powiedzie.
created_atstringCzas tworzenia odpowiedzi w formacie ISO 8601.
usage.creditsnumberZasługi naliczane za wniosek, w oparciu o twój plan.
results[0]array<string>Automatyczne sugestie. Każdy wpis tablicy jest sugerowaną frazą wyszukiwania.

Powyższe pola opisują domyślną odpowiedź JSON. Formaty JSON, proste teksty i Markdown.

Async zwraca jeden pokwitowanie zadania; partia zwraca jeden na zapytanie. Sprawdź status każdego zadania i odzyskaj jego wyniki za pomocą zwróconych linków.

Async i cykl życia serii

Składanie zwraca pokwitowanie, nie wyniki. Async tworzy jedno zadanie; wsadowe zwraca osobne zadanie w queries[] dla każdego akceptowanego zapytania. Śledź i odzyskaj każdą pracę niezależnie.

Prześlij do data.flashdata.dev; odczyt statusu pracy i wyniki api.flashdata.dev z tym samym X-API-Key. API podstawowe przykłady używać Python i cURL.

  1. 1. Zapisz zadanie IDs

    Podczas przełączania na Async należy zachować pola żądania tego źródła. Dla Batch, umieścić każde żądanie wewnątrz tablicy zapytań obiektu JSON. Zapisz każdą zwróconą pracę ID.

    Async wniosek i odbiór · Organ wnioskujący Batch

  2. 2. Sprawdź status

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

    pending / processing: ankieta z opóźnieniem i szacunkiem Retry-After gdy jest obecny. completed: pobrać wyniki. failed: Kontrola job.error.

    Przeczytaj job.status, a nie status potwierdzenia zgłoszenia.

    Sprawdź status · Python i cURL

    Status zatrudnienia API
  3. 3. Wyniki pobierania

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

    Po zakończeniu, uwierzytelnić wynik odczytywany, a następnie pobrać 302 pamięci URL bez klucza API. Zapisać JSON w ciągu 24 godzin po zakończeniu.

    Wyniki pobierania · Python i cURL · Formaty odpowiedzi

    Wynik pobrania API reference

Sondaże i pobieranie istniejących wyników nie zużywają kredytów zapytania. Czas ankiety nie anuluje zadania: zachować ID zamiast przedkładania duplikatu pracy billable. Kody błędów i powtarzanie zachowania.

Webhooki zakończenia

Subskrybuj na zapytanie

Ustaw callback_url na najwyższym poziomie żądania async, lub wewnątrz każdego zapytania w partii, na zewnątrz params. Nie jest wymagany oddzielny wniosek o rejestrację webhook- rejestracji. Żądania Realtime nie wysyłają zwrotów.

Użyj publicznego HTTPS URL na porcie 443. FlashData POST powiadomienie dla każdego zadania osiągającego completed lub failed; zdarzenie zawiera linki, a nie sam wynik.

Potwierdzenie i weryfikacja

Powrót 2xx po trwałym przyjęciu wydarzenia. Kopiowanie według delivery_id, również wysłane jako X-Delivery-Id. Przekierowanie nie jest przestrzegane.

Nieudane dostawy ponownie spróbować z wykładniczym backupu, aż do 8 próbuje w sumie i co najwyżej 24 godziny po zakończeniu. Kontynuuj sondaże jako zapas.

Przekazy są niepodpisane. Potwierdź zadanie ID, źródło i status terminala poprzez Uwierzytelniony punkt końcowy stanu przed rozpatrzeniem powiadomienia. Dostawa ID jest dla dedukcji, a nie dowód autentyczności.

Przykład zdarzenia i pól haka webowego
Ilustracyjne powiadomienie o zakończeniu
{
  "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"
    }
  ]
}
PoleOpis
delivery_idstringStabilny identyfikator dostawy. Notyfikacje kopiujące przy użyciu tej wartości; jest również wysyłane w nagłówku X-Delivery-Id.
idstringJob ID.
sourcestringWymagane źródło danych.
statusstringukończone lub nie.
linksarrayPowiązania stanu i wyników. Powiadomienia nie zawierają treści wyników ani klucza API.
links[].relstringsiebie lub wyników.
links[].hrefstringAbsolute Management API URL; uwierzytelniaj kluczykiem API.
links[].methodstringGET.

Pełna umowa na haczyk i ograniczenia URL

Błąd przy odzyskiwaniu

Brak sugestii dla przedrostka jest udane puste odpowiedzi. Dostosuj przedrostek, język lub region w razie potrzeby; nie traktuj pustej tablicy jako nieudanego zadania.

W przypadku błędów w uwierzytelnianiu, równowadze, formacie request- format i limicie rate- limit, użyj współdzielonego odniesienia błędu. Czas składania może jeszcze utworzyć pracę; sprawdzić istniejącą pracę przed ponownym uruchomieniem.

Błędy i kody statusu · Kiedy spróbować ponownie · Limity stóp procentowych

Przewodnik po krokach: Zamień sugestie w wyszukiwanie

Cennik

PlanyWskaźniki stosowaniaza 1 000 standardowych żądańSubskrypcjeZawarte kredyty na okres rozliczeniowy
Płatność za użycie0,50 USDBez opłaty miesięcznejDoładuj w razie potrzeby
Micro0,40 USD49,00 USD / miesiącKredyty 1000 (50,00 USD wykorzystania API) włączone do
Starter0,35 USD199,00 USD / miesiącKredyty 4000 (200,00 USD wykorzystania API) włączone do
Pro0,30 USD499,00 USD / miesiącKredyty 10 000 (500,00 USD wykorzystania API) włączone do
Scale0,25 USD999,00 USD / miesiącKredyty 20 000 (1000,00 USD wykorzystania API) włączone do
Business0,20 USD1999,00 USD / miesiącKredyty 40 000 (2000,00 USD wykorzystania API) włączone do

Jeden plan konta. Wspólne kredyty dla trzech produktów. Użycie pokryte kredytami w planie nie jest naliczane ponownie.

Ceny bieżące i limity dotyczące planów