Saltar al contenido
ES
Obtener clave API
Explorar documentación

Ejemplos

Obtén los metadatos de un vídeo

A partir de un ID de YouTube, guarda el título, canal, duración y recuentos disponibles del vídeo. Conserva también la respuesta original y el consumo.

En esta página

Antes de empezar

Use una llave con youtube_metadata permiso y créditos disponibles. Elija Python 3.10+ con solicitudes, o Bash con cURL 7.76+ y jq. On Windows, uso Git Bash para el Bash versión.

1. Elige un vídeo

Cree una carpeta de metadatos de vídeo y guarde request.json allí. Abra una terminal en esa carpeta. Reemplace video_id con el 11-character ID de un reloj URL o un YouTube Resultado de búsqueda; no pase el URL completo.

Establecer ambas banderas opcionales explícitamente: esta primera solicitud omite formatos de medios y capítulos. Recupera metadatos sin descargar el vídeo o sus subtítulos.

video-metadata/request.json
{
  "source": "youtube_metadata",
  "video_id": "FUfGcZ092b0",
  "params": {
    "include_formats": false,
    "include_chapters": false
  }
}

2. Coge y guarda los metadatos

Elija una versión y guarde su script junto a request.json. Lee FLASHDATA_API_KEY o pide su clave en un aviso oculto. Los agentes deben cargar esa variable de entorno de su tienda secreta.

Corre con snapshot-001 como la carpeta de salida. Una nueva carpeta envía una consulta de metadatos y guarda su uso reportado. El script comprueba una respuesta exitosa que contiene exactamente un vídeo con el ID solicitado antes de escribir video.json.

Instalar en su entorno Python
python -m pip install requests
video-metadata/metadata.py
import 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")
Ejecutarse de los metadatos de vídeo/
python metadata.py snapshot-001

3. Lea el registro de vídeo

Impresión de éxito Ahorradas <unk>video ID ES para snapshot-001/video.json. Lea el archivo para el objeto de metadatos completo y record.json para la solicitud de envío exacta, requested_at y el uso. Leer estos archivos no hace ninguna llamada API.

Lea localmente
python -m json.tool snapshot-001/video.json
python -m json.tool snapshot-001/record.json

Producto de ejemplo

Abreviado, ilustrativo video.json. Los valores devueltos varían. El script conserva todos los campos disponibles, incluyendo los valores nulos, y mantiene la respuesta completa en result.json.

video-metadata/snapshot-001/video.json
{
  "videoId": "FUfGcZ092b0",
  "title": "Example research video",
  "channel": "Example channel",
  "duration": 120,
  "viewCount": null,
  "transcriptLanguages": [
    "en"
  ]
}

Lea los campos

CampoÚsalo para
videoIdEl registro es una llave estable, los nombres de la pantalla de título y canal pueden cambiar.
durationLongitud de vídeo en segundos. Preserve valores perdidos o nulos como desconocidos.
viewCount / likeCount / commentCountCuentas disponibles en esta instantánea. Null o desaparecido es desconocido; cero es un recuento reportado.
transcriptLanguagesCódigos de idiomas candidatos para una solicitud de capción separada. Esta lista no identifica si una pista es automática o manual.

Reutilizar la instantánea o solicitar otra

Ejecute el mismo comando para reconstruir video.json y record.json de la respuesta guardada. No se necesita ninguna solicitud de clave o de red. Editar el request.json de nivel superior no cambia la entrada almacenada con snapshot-001.

Reutilizar datos guardados
python metadata.py snapshot-001

Incluir los capítulos disponibles

Para incluir los marcadores de capítulo, sustitúyase request.json con esta versión y utilice una nueva carpeta de salida. include_chapters: los capítulos verdaderos devuelve cuando esté disponible; no los crea. Tanto include_chapters como include_formats predeterminado para ser cierto cuando se omite.

video-metadata/request.json
{
  "source": "youtube_metadata",
  "video_id": "FUfGcZ092b0",
  "params": {
    "include_formats": false,
    "include_chapters": true
  }
}
Solicitar otra instantánea
python metadata.py snapshot-002

Si los metadatos no están disponibles

Qué pasó.Qué hacer
Inválido video_idUtilice sólo el 11-character ID. La validación de entrada se detiene antes de enviar la solicitud.
Vídeo privado, eliminado o restringidoMantenga el fallo de ID. Compruebe el error de fuente y elegir un vídeo accesible en lugar de enviar repetidamente el mismo artículo.
Resultado vacío o un videoId diferenteEl script se detiene sin escribir video.json. Inspeccione la solicitud guardada y la respuesta antes de usar el registro.
Falta de cargos, capítulos o idiomasUn registro de metadatos coincidente todavía puede ser exitoso. Preserve campos no disponibles como desconocidos; no llenarlos con valores inventados.
401 / 403 / 402Compruebe la clave, permiso y equilibrio youtube_metadata, respectivamente, antes de un nuevo intento.
429Lea Retry-After en response-headers.txt y espere. El script nunca se reinicia automáticamente.
Timeout, 5xx, JSON inválido o una carpeta incompletaMantener el intento y comprobar Historia antes de enviar de nuevo. Reutilizar su carpeta no hace ninguna nueva solicitud.

Guardar inspect_metadata.py junto a metadata.py, y luego ejecutarlo.

video-metadata/inspect_metadata.py
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")
Inspeccionar localmente
python inspect_metadata.py

Utilice el vídeo en su flujo de trabajo

Utilice videoId para unirse a este registro a sus resultados de búsqueda o conjunto de datos. Para el contenido hablado, recupere una pista de captura específica después. Para varios IDs, utilice la guía de enriquecimiento. Estas son solicitudes separadas con sus propios permisos y cargos.