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

Przykłady

Pobieranie metadanych z jednego filmu

Obróć YouTube wideo ID do zapisanego rekordu jego tytułu, kanału, czasu trwania i dostępnych liczników. Zachować oryginalną odpowiedź i użycie obok niej.

Na tej stronie

Zanim zaczniesz

Użyj klucza z pozwoleniem youtube_metadata i dostępnymi kredytami. Wybierz Python 3.10 + z życzeniami lub Bash z cURL 7.76 + i jq. Na Windows, użyj Git Bash dla wersji Bash.

1. Wybierz jeden film

Utwórz folder z metadanymi wideo i zapisz tam request.json. Otwórz terminal w tym folderze. Zastąp video_id znakiem 11- ID z zegarka URL lub wynikiem YouTube Search; nie zdawaj pełnego URL.

Ustaw obie flagi opcjonalne wyraźnie: to pierwsze żądanie pomija formaty i rozdziały mediów. Pobiera metadane bez pobierania nagrania wideo lub jego podpisy.

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

2. Pobierz i zapisz metadane

Wybierz jedną wersję i zapisz jej skrypt obok request.json. Odczytuje FLASHDATA_API_KEY lub prosi o klucz w ukrytym trybie. Agenci powinni załadować tę zmienną środowiskową ze swojego tajnego sklepu.

Uruchom snapshot- 001 jako folder wyjściowy. Nowy folder wysyła zapytanie o metadane i zapisuje zgłoszone użycie. Skrypt sprawdza udane odpowiedzi zawierające dokładnie jeden film z żądanym ID przed napisaniem video.json.

Zainstaluj w środowisku 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")
Uruchom z metadanych wideo /
python metadata.py snapshot-001

3. Przeczytaj nagranie wideo

Odciski sukcesów Saved < video ID > do snapshot-001/video.json. Przeczytaj ten plik dla pełnego obiektu metadanych i record.json dla dokładnego złożonego wniosku, requested_at i wykorzystania. Czytanie tych plików nie powoduje wywołania API.

Czytaj lokalnie
python -m json.tool snapshot-001/video.json
python -m json.tool snapshot-001/record.json

Przykład wyjścia

Skrócony, ilustracyjny video.json. Zwrócone wartości różnią się. Skrypt zachowuje wszystkie dostępne pola, w tym wartości null, i zachowuje pełną odpowiedź w result.json.

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

Przeczytaj pola

PoleUżyj go do
videoIdZapis jest stabilny. Nazwy tytułów i kanałów mogą ulec zmianie.
durationDługość wideo w sekundach. Zachować brakujące lub wartości null jako nieznane.
viewCount / likeCount / commentCountLiczy dostępne w tym migawce. Null lub brak jest nieznany; zero jest zapisaną liczbą.
transcriptLanguagesKody językowe kandydata na odrębny wniosek o podpisanie. Lista ta nie określa, czy utwór jest automatyczny czy ręczny.

Ponownie użyj migawki lub żądaj innego

Uruchom to samo polecenie, aby odbudować video.json i record.json z zapisanej odpowiedzi. Nie jest potrzebny żaden klucz ani żądanie sieciowe. Edycja poziomu górnego request.json nie zmienia wejścia zapisanego za pomocą snapshot- 001.

Ponowne wykorzystanie zapisanych danych
python metadata.py snapshot-001

Dołącz dostępne rozdziały

Aby włączyć znaczniki rozdziałów, zastąp request.json tą wersją i użyj nowego folderu wyjściowego. include_chapters: true zwraca rozdziały, gdy jest dostępny; nie tworzy ich. Zarówno include_chapters, jak i include_formats domyślne do true, gdy pominięto.

video-metadata/request.json
{
  "source": "youtube_metadata",
  "video_id": "FUfGcZ092b0",
  "params": {
    "include_formats": false,
    "include_chapters": true
  }
}
Poproś o kolejne zdjęcie
python metadata.py snapshot-002

Jeżeli metadane są niedostępne

Co się stało?Co zrobić
Nieprawidłowy video_idUżyj tylko znaku 11- ID. Przed wysłaniem wniosku wstrzymuje się walidacja wejścia.
Prywatne, usunięte lub ograniczone wideoZachowaj porażkę dla ID. Zaznacz błąd źródła i wybierz dostępny film zamiast wielokrotnie przesyłać ten sam element.
Pusty wynik lub inny videoIdSkrypt zatrzymuje się bez zapisu video.json. Przed użyciem rekordu należy sprawdzić zapisaną prośbę i odpowiedź.
Zaginione liczby, rozdziały lub językiPasujące rekordy metadanych mogą być nadal skuteczne. Zachowaj niedostępne pola jako nieznane; nie wypełniaj ich wymyślonymi wartościami.
401 / 403 / 402Przed nową próbą należy sprawdzić klucz, pozwolenie youtube_metadata i saldo.
429Przeczytaj Retry-After w response-headers.txt i czekaj. Skrypt nigdy nie powtarza się automatycznie.
Timeout, 5xx, nieprawidłowy JSON lub niekompletny folderPrzed ponownym złożeniem należy zachować próbę i sprawdzić History. Ponowne użycie folderu nie powoduje nowego żądania.

Zapisz inspect_metadata.py obok metadata.py, a następnie uruchom go.

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")
Sprawdzić lokalnie
python inspect_metadata.py

Użyj wideo w swoim strumieniu pracy

Użyj videoId, aby dołączyć ten rekord do wyników wyszukiwania lub zbioru danych. Dla zawartości mówionej, pobrać konkretny utwór podpisy dalej. W przypadku kilku IDs należy stosować przewodnik wzbogacania. Są to oddzielne prośby z ich własnymi uprawnieniami i opłatami.