Pular para o conteúdo
PT
Obter chave API
Explorar documentação

Referência da API

YouTube Suggestions API

Obtenha uma chave de API

Recuperar YouTube sugestões autocompletas para uma palavra-chave ou frase, com controle de linguagem e região.

Monte uma requisição

Código do idioma das legendas ou sugestões, como en.

Código do país com duas letras, como US.

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))
Resultados na resposta HTTPX-API-Key autenticação

Parâmetros

Enviar source e.. query no nível superior. As opções de origem pertencem a params. Campos opcionais podem ser omitidos.

Corpo da requisição

sourcestring / Obrigatório
Preparar para youtube_suggestions.
querystring / Obrigatório
Prefixo de busca.
1 para 2.000 personagensPredefinição: Não está pronto
paramsobject / Opcional
Settings para este pedido.
Predefinição: {}
callback_urlstring · nullable / Opcional
Async e apenas lote. HTTPS conclusão URL na porta 443, até caracteres 2,048. Sem credenciais de usuário ou fragmento URL. Omit, use null ou uma string vazia para nenhuma notificação. Em um lote, coloque isso em cada consulta, fora dos parâmetros.
Predefinição: Não está pronto

Linguagem e região

params.languagestring / Opcional
Código de linguagem.
1 para 35 personagensPredefinição: "en"
Formato aceito^[A-Za-z0-9-]+$
params.regionstring / Opcional
Código de país de duas letras, como EUA, GB ou DE.
Exatamente 2 personagensPredefinição: "US"
Formato aceito^[A-Za-z]{2}$

Resposta

Realtime retorna status: done. Leia a saída da fonte em results[0]; usage.credits Registra a acusação.

resultados[0] é uma variedade de frases de busca sugeridas, não objetos de vídeo. Pode estar vazio, não há vídeo IDs ou o engajamento conta nesta resposta.

Leia o resultado

Salve a resposta JSON bem sucedida como response.json. Guarde isso como read-response.py e execute python read-response.py. Ele usa apenas a biblioteca padrão do Python e não faz nenhum novo pedido.

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

Envie o prefixo de busca como consulta. Eles afetam o contexto autocompleto, não os metadados de vídeo.

Use busca ou busca estendida com uma frase sugerida para vídeos discover. Sugestões não suportam max_results ou filtros de busca.

Todos os campos de resposta
CampoDescrição
sourcestringA fonte API solicitada.
statusstringFeito quando o pedido em tempo real for bem sucedido.
created_atstringTempo de criação de resposta no formato ISO 8601.
usage.creditsnumberCréditos cobrados pelo pedido, baseado no seu plano.
results[0]array<string>Sugestão completa automática. Cada entrada de array é uma frase de busca sugerida.

Os campos acima descrevem a resposta padrão JSON. JSON, texto simples e formatos Markdown.

Async retorna um recibo de trabalho; lote retorna um por Consulta. Verifique o status de cada trabalho e recupere seus resultados usando os links devolvidos.

Async & ciclo de vida em lote

A submissão devolve um recibo, não resultados. Async cria um trabalho; lote retorna um trabalho separado em queries[] para cada consulta aceita. Rastreie e recupere cada trabalho independentemente.

Submeta-se a data.flashdata.dev; ler status de trabalho e resultados de api.flashdata.dev com o mesmo X-API-Key. Os exemplos básicos do API ligados usam Python e cURL.

  1. 1. Salve o trabalho IDs

    Mantenha os campos de solicitação desta fonte ao mudar para Async. Para Batch, coloque cada pedido dentro da matriz de consultas de um objeto JSON. Salve todos os trabalhos devolvidos ID.

    Async pedido e recibo · Batch solicita corpo

  2. 2. Verifique o status

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

    pending / processing: pesquisa com um atraso e respeito Retry-After quando presente. completed: obter resultados. failed: Inspecione job.error.

    Leia job.status, não o status do recibo de submissão.

    Verifique o status de Python e cURL

    Situação do trabalho referência API
  3. 3. Recupere os resultados

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

    Após a conclusão, autentique o resultado lido, e depois vá buscar o 302 de armazenamento URL sem sua chave API. Salve o JSON dentro de 24 horas de conclusão.

    Obter resultados · Python e cURL · Formatos de resposta

    Resultado do download da referência API

Pesquisando e buscando resultados existentes não consomem créditos de consulta. Um tempo de votação não cancela o trabalho: mantenha seu ID em vez de enviar duplicado trabalho billable. Códigos de erro e comportamento de repetição.

Webhooks de conclusão

Inscreva-se por consulta

Preparar callback_url no nível superior de um pedido de assincronização, ou dentro de cada consulta em um lote, fora params. Não é necessário nenhum pedido de registro separado. Pedidos Realtime não enviam chamadas de volta.

Use um HTTPS URL público no porto 443. FlashData POSTS uma notificação para cada trabalho chegando completed ou failed; O evento contém links, não o resultado em si.

Reconheça e verifique

Retorne 2xx depois de aceitar o evento. Deduplicar por delivery_id, também enviado como X-Delivery-Id. Redirecionamentos não são seguidos.

Entregas falhadas tentam novamente com retrocesso exponencial, até 8 tenta total e no máximo 24 horas após a conclusão. Continue pesquisando como um retrocesso.

As chamadas não foram assinadas. Confirme o trabalho ID, fonte e status terminal através do Endpoint de status autenticado Antes de processar a notificação. A entrega ID é para deduplicação, não prova de autenticidade.

Exemplo de eventos webhook e campos
Notificação de conclusão ilustrativa
{
  "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"
    }
  ]
}
CampoDescrição
delivery_idstringIdentificador de entrega estável. Deduplicar notificações usando este valor; também é enviado no cabeçalho X-Delivery-Id.
idstringTrabalho ID.
sourcestringSolicitamos fonte de dados.
statusstringcompleto ou fracassado.
linksarrayStatus e links de resultados. Notificações não incluem conteúdo de resultado ou uma chave API.
links[].relstringauto ou resultados.
links[].hrefstringGestão absoluta API URL, autentice com sua chave API.
links[].methodstringGET.

Contrato completo e restrições URL

Recuperação de erros

Nenhuma sugestão para um prefixo é uma resposta vazia bem sucedida. Ajuste o prefixo, idioma ou região, se necessário; não trate um array vazio como um trabalho fracassado.

Para autenticação, equilíbrio, formatação de pedidos e falhas de taxa, use a referência de erro compartilhado. Um intervalo de submissão ainda pode ter criado um trabalho, verificar o trabalho existente antes de tentar novamente.

Erros e códigos de status · Quando tentar novamente · Limites de taxa

Guia passo-a-passo: Transforme sugestões em uma busca

Preços

PlanosTaxas de usopor 1.000 solicitações padrãoAssinaturasIncluindo créditos por período de faturamento
Pague pelo usoUS$ 0,50Sem mensalidadeRecarregue quando precisar
MicroUS$ 0,40US$ 49,00 / Mês1.000 créditos (US$ 50,00 de API uso) incluído
StarterUS$ 0,35US$ 199,00 / Mês4.000 créditos (US$ 200,00 de API uso) incluído
ProUS$ 0,30US$ 499,00 / Mês10.000 créditos (US$ 500,00 de API uso) incluído
ScaleUS$ 0,25US$ 999,00 / Mês20.000 créditos (US$ 1.000,00 de API uso) incluído
BusinessUS$ 0,20US$ 1.999,00 / Mês40.000 créditos (US$ 2.000,00 de API uso) incluído

Um plano por conta. Créditos compartilhados entre os três produtos. O uso coberto pelos créditos incluídos não é cobrado novamente.

Preços atuais e limites do plano