コンテンツへスキップ
JA
APIキーを取得する
ドキュメントを探す

サンプル

1つのビデオのメタデータを取得します。

YouTubeビデオIDをタイトル、チャンネル、期間、利用可能なカウントの保存されたレコードに変換します。 元の応答と使用状況をそのままにしてください。

このページの内容

はじめる前に

youtube_metadataの許可と利用可能なクレジットでキーを使用してください。 Python 3.10+ とリクエスト、Bash と cURL 7.76+ と jq+ を選択します。 Windowsでは、BashバージョンのGit Bashを使用しています。

1. 1つのビデオを選択

ビデオメタデータフォルダーを作成し、そこにrequest.jsonを保存します。 そのフォルダのターミナルを開きます。 リプレース video_id と、 11-キャラクター ID 時計から URL または YouTube Search 結果; 完全パスしません URL.

オプションのフラグを明示的に設定します。: この最初のリクエストは、メディアフォーマットとチャプターを省略します。 ビデオやそのキャプションをダウンロードすることなくメタデータを取得します。

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

2. メタデータの取得と保存

1つのバージョンを選択し、request.jsonの横にあるスクリプトを保存します。 FLASHDATA_API_KEY を読み込み、鍵を隠しプロンプトで要求します。 エージェントは、秘密ストアから環境変数を読み込む必要があります。

出力フォルダとしてsnapshot-001で実行します。 新規フォルダは1つのメタデータクエリを送信し、報告された使用量を保存します。 スクリプトは、video.json を記述する前に、要求されたIDと正確に1つのビデオを含む成功した応答をチェックします。

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")
ビデオ・メタデータから実行/
python metadata.py snapshot-001

3. ビデオ レコードを読む

snapshot-001/video.json.に保存された<ビデオID>を成功プリント 送信された要求、requested_atおよび使用法のための完全なメタデータ オブジェクトおよびrecord.jsonのためのそのファイルを読んで下さい。 これらのファイルを読み込むと、API 呼び出しは行いません。

ローカルで読む
python -m json.tool snapshot-001/video.json
python -m json.tool snapshot-001/record.json

出力例

吸収性、イラスト video.json. 返された値が異なります。 スクリプトは、null 値を含むすべての利用可能なフィールドを保持し、result.json で完全な応答を維持します。

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

フィールドを読む

フィールド利用する
videoId記録の安定したキー。 タイトルとチャンネル表示名を変更できます。
duration秒単位のビデオ長さ。 見つかりないか、null 値が不明であるように保存します。
viewCount / likeCount / commentCountこのスナップショットで利用可能なカウント。 数値または欠落が不明である; 0 は報告されたカウントである。
transcriptLanguages別々のキャプション要求のための言語コードをcandidate。 このリストは、トラックが自動または手動かどうかを識別しません。

スナップショットまたは別のリクエストを再利用する

保存された応答から video.json と record.json を再構築するために同じコマンドを実行します。 鍵やネットワークのリクエストは必要ありません。 request.json の編集はスナップショット-001 で保存された入力を変更しません。

保存したデータを再利用する
python metadata.py snapshot-001

利用可能な章を含める

チャプターマーカーを含めるには、request.jsonをこのバージョンに置き換え、新しい出力フォルダを使用します。 include_chapters: trueは、利用可能なときにチャプターを返します。 それらは作成しません。 include_chapters と include_formats のデフォルトは、省略時に true のデフォルトです。

video-metadata/request.json
{
  "source": "youtube_metadata",
  "video_id": "FUfGcZ092b0",
  "params": {
    "include_formats": false,
    "include_chapters": true
  }
}
別のスナップショットをリクエストする
python metadata.py snapshot-002

メタデータが利用できなくなった場合

何が起こったのか対処方法
無効な video_id11-character ID だけを使用して下さい。 入力検証はリクエストを送信する前に停止します。
プライベート、削除または制限されたビデオID の失敗を保ちましょう。 ソースのエラーを確認し、同じ項目を繰り返し送信するのではなく、アクセス可能なビデオを選択します。
空の結果か別のvideoIdスクリプトは、video.json を記述せずに停止します。 保存されたリクエストとレスポンスを調べて、レコードを使用する前に確認します。
カウント、チャプター、または言語の欠損マッチングメタデータレコードは、まだ成功することができます。 未利用のフィールドを未知の状態に保ち、発明された値で埋めてはいけません。
401 / 403 / 402新しい試みの前に、キー、youtube_metadataのパーミッションと残高、それぞれを確認してください。
429response-headers.txt で Retry-After を読み、待ちます。 スクリプトは、自動的に削除されることはありません。
タイムアウト、5xx、無効なJSON、または不完全なフォルダ再度提出する前に、Historyを試行して確認してください。 フォルダを再利用すると、新しいリクエストは発生しません。

metadata.pyの横にあるinspect_metadata.pyを保存し、実行します。

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")
現地で探す
python inspect_metadata.py

ワークフローでビデオを使用する

videoIdを使用して、このレコードを検索結果やデータセットに結合します。 音声コンテンツでは、次の特定のキャプショントラックを取得します。 複数 IDs, 濃縮ガイドを使用してください。. これらは、独自の許可と料金の別々の要求です。