Documentatie bekijken
API-referentie
YouTube Suggestions API
YouTube automatisch aanvullen suggesties voor een trefwoord of zin, met taal en regio controles.
Stel een aanvraag samen
Taalcode voor ondertiteling of suggesties, bijvoorbeeld en.
Landcode van twee letters, bijvoorbeeld US.
https://data.flashdata.dev/v1/queries/realtimeParameters
Verzenden source en query op het bovenste niveau. Bronopties horen in params. Optionele velden kunnen worden weggelaten.
Aanvraaginhoud
sourcestring / Vereist- Instellen op youtube_suggestions.
querystring / Vereist- Zoek voorvoegsel.1 tot 2.000 tekensStandaard:
Niet ingesteld paramsobject / Optioneel- Settings voor dit verzoek.Standaard:
{} callback_urlstring · nullable / Optioneel- Async en alleen batch. Publieke HTTPS voltooiing URL op poort 443, tot 2,048 tekens. Geen gebruikersgegevens of URL-fragment. Gebruik null of een lege tekenreeks zonder melding. In een batch, zet dit op elke query, buiten params.Standaard:
Niet ingesteld
Taalgebied
params.languagestring / Optioneel- Taalcode.1 tot 35 tekensStandaard:
"en"Geaccepteerd formaat
^[A-Za-z0-9-]+$ params.regionstring / Optioneel- Tweeletterige landcode, zoals VS, GB of DE.Precies 2 tekensStandaard:
"US"Geaccepteerd formaat
^[A-Za-z]{2}$
Antwoord
Realtime geeft terug status: done. Lees de bron uitvoer op results[0]; usage.credits neemt de aanklacht op.
resultaten[0] is een reeks van voorgestelde zoekzinnen, geen video objecten. Het kan leeg zijn; er zijn geen video IDs of betrokkenheid telt in deze reactie.
Lees het resultaat
Bewaar de succesvolle JSON respons als response.json. Sla dit op als read-response.py en voer python read-response.py uit. Het gebruikt alleen de standaardbibliotheek van Python en doet geen nieuw verzoek.
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))Stuur het zoekvoorvoegsel als query. language en het tweeletterige gebied horen in params; de standaardwaarden zijn en en US. Ze beïnvloeden de autocomplete context, geen videometadata.
Gebruik Search of Extended Search met een voorgestelde zin voor discover-video's. Suggesties ondersteunen geen max_results of zoekfilters.
Alle responsvelden
| Veld | Omschrijving |
|---|---|
sourcestring | De gevraagde API bron. |
statusstring | gedaan wanneer het real-time verzoek slaagt. |
created_atstring | Aanmaaktijd voor respons in ISO 8601-formaat. |
usage.creditsnumber | Credits in rekening gebracht voor het verzoek, op basis van uw plan. |
results[0]array<string> | Stelt u zelf voorstellen in. Elke array-invoer is een voorgestelde zoekzin. |
De velden hierboven beschrijven het standaard JSON antwoord. JSON, platte tekst en Markdown-formaten.
Async geeft één opdrachtbon terug; batch geeft één per query. Controleer de status van elke taak en haal de resultaten ervan op met behulp van de teruggekeerde links.
Async & batch lifecycle
Indiening geeft een ontvangstbewijs terug, geen resultaten. Async creëert één taak; batch geeft een aparte taak terug in queries[] voor elke geaccepteerde vraag. Traceer en haal elke taak zelfstandig op.
Verzenden naar data.flashdata.dev; lees jobstatus en resultaten van api.flashdata.dev met dezelfde X-API-Key. De gekoppelde API basisvoorbeelden gebruiken Python en cURL.
1. De taak IDs opslaan
De verzoekenvelden van deze bron behouden bij het overschakelen naar Async. Zet voor Batch elk verzoek in de query array van een JSON object. Bewaar elke teruggekeerde baan ID.
2. Status controleren
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: peiling met vertraging en respectRetry-Afterwanneer aanwezig.completed: resultaten halen.failed: inspectiejob.error.Lees job.status, niet de status van het inzendingsbewijs.
Controleer status · Python en cURL
Job status API referentie3. Resultaten ophalen
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsNa voltooiing, authenticeer het resultaat gelezen, dan halen de 302 opslag URL zonder uw API sleutel. Bewaar de JSON binnen 24 uren na voltooiing.
Resultaten · Python en cURL ophalen · Antwoordformaten
Resultaat download API referentie
Bestudering en het ophalen van bestaande resultaten verbruiken geen query credits. Een polling timeout annuleert de taak niet: houd de ID in plaats van het indienen van dubbele factureerbare werk. Foutcodes en opnieuw proberen gedrag.
Webhooks bij voltooiing
Abonneren per query
Instellen callback_url op het hoogste niveau van een async-verzoek, of binnen elke query in een partij, buiten params. Er is geen afzonderlijk verzoek om webhook-registratie vereist. Realtime-verzoeken sturen geen terugbellers.
Gebruik een publieke HTTPS URL op poort 443. FlashData POST een melding voor elke taak bereiken completed of failed; het evenement bevat links, niet het resultaat zelf.
Bevestigen en verifiëren
Terugkeer 2xx na het duurzaam accepteren van de gebeurtenis. Dedupliceren door delivery_id, ook verzonden als X-Delivery-Id. Redirects worden niet gevolgd.
Mislukte leveringen opnieuw proberen met exponentiële backoff, tot 8 probeert totaal en maximaal 24 uren na voltooiing. Blijf peilen als een terugval.
De terugbellen zijn niet ondertekend. Bevestig de taak ID, bron- en terminalstatus via de geauthentiseerd status-eindpunt vóór de verwerking van de kennisgeving. De levering ID is voor deduplicatie, geen bewijs van authenticiteit.
Voorbeeld webhook event en velden
{
"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"
}
]
}| Veld | Omschrijving |
|---|---|
delivery_idstring | Stabiele leveringsidentificatiecode. Notificatieberichten dedupliceren met deze waarde; het wordt ook verzonden in de X-Delivery-Id header. |
idstring | Job ID. |
sourcestring | Gevraagde databron. |
statusstring | voltooid of mislukt. |
linksarray | Status en resultaat links. Meldingen bevatten geen resultaatinhoud of een API-sleutel. |
links[].relstring | zelf of resultaten. |
links[].hrefstring | Absolute Management API URL; authenticeer met je API sleutel. |
links[].methodstring | GET. |
Foutherstel
Geen suggesties voor een voorvoegsel is een succesvol leeg antwoord. Pas het voorvoegsel, taal of gebied aan indien nodig; behandel een lege array niet als een mislukte taak.
Gebruik de gedeelde foutreferentie voor authenticatie, saldo, verzoek-formaat en snelheidslimietfouten. Een inzending timeout kan nog steeds een baan hebben gecreëerd; controleer bestaand werk voordat opnieuw te proberen.
Fouten en statuscodes · Wanneer opnieuw proberen · Maximumtarieven
Stapsgewijze handleiding: Suggesties omzetten in een zoekopdracht
Prijzen
| Plannen | Gebruikspercentagesper 1.000 standaardaanvragen | Abonnementen | Inclusief credits per facturatieperiode |
|---|---|---|---|
| Betalen naar gebruik | US$ 0,50 | Geen maandelijkse kosten | Opwaarderen wanneer nodig |
| Micro | US$ 0,40 | US$ 49,00 / maand | 1.000 credits (US$ 50,00 of API usance) inclusief |
| Starter | US$ 0,35 | US$ 199,00 / maand | 4.000 credits (US$ 200,00 of API usance) inclusief |
| Pro | US$ 0,30 | US$ 499,00 / maand | 10.000 credits (US$ 500,00 of API usance) inclusief |
| Scale | US$ 0,25 | US$ 999,00 / maand | 20.000 credits (US$ 1.000,00 of API usance) inclusief |
| Business | US$ 0,20 | US$ 1.999,00 / maand | 40.000 credits (US$ 2.000,00 of API usance) inclusief |
Eén accountabonnement. Gedeelde credits voor alle drie de producten. Gebruik dat door inbegrepen credits wordt gedekt, wordt niet opnieuw in rekening gebracht.
Lopende prijzen en maxima van het plan