Explorar documentação
Exemplos
Transforme um vídeo YouTube ID em um registro salvo de seu título, canal, duração e contagens disponíveis. Mantenha a resposta original e use ao lado dela.
Nesta página
Antes de começar
Use uma chave com permissão youtube_metadata e créditos disponíveis. Escolha Python 3.10+ com pedidos, ou Bash com cURL 7.76+ e jq. Em Windows, use Git Bash para a versão Bash.
1. Escolha um vídeo
Crie uma pasta de metadados e salve o request.json lá. Abra um terminal nessa pasta. Substitua video_id pelo 11-caracter ID de um relógio URL ou um resultado YouTube Search; não passe o URL completo.
Defina ambas as bandeiras opcionais explicitamente: este primeiro pedido omite formatos de mídia e capítulos. Recupera metadados sem baixar o vídeo ou suas legendas.
{
"source": "youtube_metadata",
"video_id": "FUfGcZ092b0",
"params": {
"include_formats": false,
"include_chapters": false
}
}2. Busque e salve os metadados
Escolha uma versão e salve seu script ao lado de request.json. Ele lê FLASHDATA_API_KEY ou pede sua chave em um alerta oculto. Os agentes devem carregar essa variável de ambiente da loja secreta.
Corra com o instantâneo-001 como a pasta de saída. Uma nova pasta envia uma consulta de metadados e salva seu uso relatado. O script verifica uma resposta bem sucedida contendo exatamente um vídeo com o ID solicitado antes de escrever video.json.
python -m pip install requestsimport argparse
import getpass
import json
import os
import re
from datetime import datetime, timezone
from pathlib import Path
import requests
parser = argparse.ArgumentParser()
parser.add_argument("folder", help="New output folder, or an existing saved snapshot")
out = Path(parser.parse_args().folder)
if not out.exists():
body = Path("request.json").read_bytes()
request = json.loads(body)
if (not isinstance(request, dict) or request.get("source") != "youtube_metadata"
or not isinstance(request.get("video_id"), str)
or not re.fullmatch(r"[A-Za-z0-9_-]{11}", request["video_id"])):
raise SystemExit("Use youtube_metadata and an 11-character video_id, not a URL")
key = os.environ.get("FLASHDATA_API_KEY") or getpass.getpass("FlashData API key: ")
if not key.strip():
raise SystemExit("An API key is required")
out.mkdir()
(out / "request.json").write_bytes(body)
(out / "requested-at.txt").write_text(
datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), encoding="utf-8"
)
try:
response = requests.post(
"https://data.flashdata.dev/v1/queries/realtime",
headers={"X-API-Key": key, "Content-Type": "application/json",
"Accept": "application/json"},
data=body, timeout=120, allow_redirects=False,
)
except requests.RequestException:
raise SystemExit(f"Request interrupted. Keep {out} and check History before retrying.")
(out / "result.json").write_bytes(response.content)
(out / "response-headers.txt").write_text(
"\n".join(f"{k}: {v}" for k, v in response.headers.items()), encoding="utf-8"
)
(out / "http-status.txt").write_text(str(response.status_code), encoding="utf-8")
else:
print(f"Reading saved response from {out}; no API call.")
if not (out / "http-status.txt").exists():
raise SystemExit("Incomplete attempt. Keep the folder and check History before retrying.")
status = (out / "http-status.txt").read_text().strip()
if status != "200":
raise SystemExit(f"HTTP {status}: inspect {out}/result.json and response-headers.txt")
try:
data = json.loads((out / "result.json").read_bytes())
except ValueError:
raise SystemExit("Invalid JSON; inspect the saved result.json")
request = json.loads((out / "request.json").read_bytes())
if not isinstance(data, dict) or data.get("source") != "youtube_metadata" or data.get("status") != "done":
raise SystemExit("Metadata request did not finish successfully; inspect result.json")
videos = data.get("results")
if (not isinstance(videos, list) or len(videos) != 1 or not isinstance(videos[0], dict)
or videos[0].get("videoId") != request["video_id"]):
raise SystemExit("Expected one metadata object matching the requested video_id")
record = {
"request": request,
"requested_at": (out / "requested-at.txt").read_text().strip(),
"usage": data.get("usage"), "result_file": "result.json",
}
for filename, value in (("video.json", videos[0]), ("record.json", record)):
(out / filename).write_text(json.dumps(value, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
print(f"Saved {videos[0]['videoId']} to {out}/video.json")
python metadata.py snapshot-001curl --version
jq --version#!/usr/bin/env bash
set -euo pipefail
out="${1:?Usage: bash metadata.sh OUTPUT_FOLDER}"
if [[ ! -e "$out" ]]; then
jq -e '.source == "youtube_metadata" and
(.video_id | if type == "string" then length == 11 and test("^[A-Za-z0-9_-]{11}$")
else false end)' request.json > /dev/null
if [[ -z "${FLASHDATA_API_KEY:-}" ]]; then
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
fi
: "${FLASHDATA_API_KEY:?An API key is required}"
mkdir -- "$out"
cp request.json "$out/request.json"
date -u +'%Y-%m-%dT%H:%M:%SZ' > "$out/requested-at.txt"
curl --fail-with-body --silent --show-error --max-time 120 \
--request POST 'https://data.flashdata.dev/v1/queries/realtime' \
--header "X-API-Key: $FLASHDATA_API_KEY" \
--header 'Content-Type: application/json' --header 'Accept: application/json' \
--data-binary "@$out/request.json" \
--dump-header "$out/response-headers.txt" --output "$out/result.json" \
--write-out '%{http_code}' > "$out/http-status.txt" || {
printf 'Request failed. Keep %s and inspect its saved files before retrying.\n' "$out" >&2
exit 1
}
else
printf 'Reading saved response from %s; no API call.\n' "$out"
fi
if [[ ! -f "$out/http-status.txt" ]] || [[ "$(cat "$out/http-status.txt")" != 200 ]]; then
printf 'Incomplete or failed attempt. Inspect the saved files and History before retrying.\n' >&2
exit 1
fi
video=$(jq -e --slurpfile request "$out/request.json" '
if .source != "youtube_metadata" or .status != "done"
then error("Expected a successful youtube_metadata response") else . end
| .results
| if type != "array" then error("Expected a metadata array")
elif length != 1 then error("Expected exactly one video") else .[0] end
| if type != "object" then error("Expected a metadata object")
elif .videoId != $request[0].video_id then error("Returned videoId does not match the request")
else . end' "$out/result.json")
printf '%s\n' "$video" > "$out/video.json"
jq --slurpfile request "$out/request.json" \
--arg requested_at "$(tr -d '\r\n' < "$out/requested-at.txt")" \
'{request: $request[0], requested_at: $requested_at, usage, result_file: "result.json"}' \
"$out/result.json" > "$out/record.json"
printf 'Saved %s to %s/video.json\n' "$(jq -r .videoId "$out/video.json")" "$out"
bash metadata.sh snapshot-0013. Leia o registro do vídeo
Impressões de sucesso salvas ID> Para snapshot-001/video.json. Leia o arquivo para o objeto de metadados completo e record.json para o pedido exato, requested_at e uso. Ler esses arquivos não faz nenhuma ligação do API.
python -m json.tool snapshot-001/video.json
python -m json.tool snapshot-001/record.jsoncat snapshot-001/video.json
cat snapshot-001/record.jsonExemplo de saída
Abreviado, ilustrador video.json. Os valores retornados variam. O script preserva todos os campos disponíveis, incluindo os valores null, e mantém a resposta completa em result.json.
{
"videoId": "FUfGcZ092b0",
"title": "Example research video",
"channel": "Example channel",
"duration": 120,
"viewCount": null,
"transcriptLanguages": [
"en"
]
}Leia os campos
| Campo | Use-o para |
|---|---|
| videoId | O registro é a chave estável. Nomes de exibição de títulos e canais podem mudar. |
| duration | Comprimento do vídeo em segundos. Preservar valores desaparecidos ou null como desconhecidos. |
| viewCount / likeCount / commentCount | Contagens disponíveis nesta foto. Nulo ou desaparecido é desconhecido, zero é uma contagem relatada. |
| transcriptLanguages | Códigos de língua para um pedido de legenda separada. Esta lista não identifica se uma faixa é automática ou manual. |
Reutilize o instantâneo ou peça outro
Execute o mesmo comando para reconstruir video.json e record.json da resposta salva. Nenhuma chave ou pedido de rede é necessário. Editar o nível superior request.json não muda a entrada armazenada com instantâneo-001.
python metadata.py snapshot-001bash metadata.sh snapshot-001Inclua capítulos disponíveis
Para incluir marcadores de capítulo, substitua request.json com esta versão e use uma nova pasta de saída. include_chapters: true retorna capítulos quando disponíveis, não os cria. include_chapters e include_formats padrão para true quando omitido.
{
"source": "youtube_metadata",
"video_id": "FUfGcZ092b0",
"params": {
"include_formats": false,
"include_chapters": true
}
}python metadata.py snapshot-002bash metadata.sh snapshot-002Se os metadados não estiverem disponíveis
| O que aconteceu? | O que fazer |
|---|---|
| video_id inválido | Use apenas o 11-caracter ID. A validação de entrada para antes de enviar o pedido. |
| Vídeo privado, removido ou restrito | Mantenha a falha para esse ID. Verifique o erro de origem e escolha um vídeo acessível em vez de enviar repetidamente o mesmo item. |
| Resultado vazio ou um videoId diferente | O roteiro para sem escrever video.json. Inspecione o pedido e a resposta antes de usar o registro. |
| Contagens em falta, capítulos ou línguas | Um registro de metadados pode ser bem sucedido. Preservar campos indisponível como desconhecidos; não preenchê-los com valores inventados. |
| 401 / 403 / 402 | Verifique a chave, permissão youtube_metadata e equilíbrio, respectivamente, antes de uma nova tentativa. |
| 429 | Leia Retry-After em response-headers.txt e espere. O roteiro nunca se repete automaticamente. |
| Tempo limite, 5xx, JSON inválido ou uma pasta incompleta | Mantenha a tentativa e verifique History antes de enviar novamente. Reutilizar sua pasta não faz nenhum novo pedido. |
Salve inspect_metadata.py ao lado de metadata.py, então execute-o.
from pathlib import Path
for name in ("http-status.txt", "response-headers.txt", "result.json"):
path = Path("snapshot-001") / name
print(f"--- {name} ---")
print(path.read_text(encoding="utf-8", errors="replace") if path.exists() else "Not saved")python inspect_metadata.pyfor name in http-status.txt response-headers.txt result.json; do
printf '\n--- %s ---\n' "$name"
if [[ -f "snapshot-001/$name" ]]; then cat "snapshot-001/$name"; else printf 'Not saved\n'; fi
doneUse o vídeo em seu fluxo de trabalho
Use videoId para juntar este registro aos resultados de sua pesquisa ou conjunto de dados. Para o conteúdo falado, recupere uma faixa de legenda específica. Para vários IDs, use o guia de enriquecimento. Estes são pedidos separados com suas próprias permissões e acusações.