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

API リファレンス

YouTube Transcript API

API キーを取得する

YouTubeのトランスクリプトテキストをタイムスタンプと完全なトランスクリプトで取得します。 デフォルトで自動キャプションが選択されます。

リクエストを作成

URL 全体ではなく、動画 URL に含まれる 11 文字の ID。

空欄の場合は en-orig、次に en を試し、1 トラックを返します。言語を指定する場合は、重複しないコードを 1〜10 個、カンマで区切って入力します。

キャプショントラック auto
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_transcript",
    "video_id": "dQw4w9WgXcQ",
    "params": {
        "language": "en",
        "auto": True,
    },
}

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))
HTTP応答での結果X-API-Key認証

パラメーター

送信 source とりあえず video_id 最上位レベル。 ソースのオプションは、 params. オプションのフィールドは省略可能です。

リクエストボディ

sourcestring / 必須
youtube_transcriptに設定します。
video_idstring / 必須
11-character YouTubeビデオID、FUfGcZ092b0などの。 手紙、数字、アンダースコア、ハイフンを受け入れる。
正確に 11 キャラクターデフォルト: 設定なし
受け入れられたフォーマット^[A-Za-z0-9_-]{11}$
paramsobject / 任意
この要求のためのSettings。
デフォルト: {}
callback_urlstring · nullable / 任意
Asyncとバッチだけ。 パブリック HTTPS エントリーフォーム URL 港に 443まで、 2,048 文字。 ユーザーの資格情報や URL フラグメントはありません。 Omit は、通知なしの null または空の文字列を使用します。 バッチでは、各クエリで、外部のパラメータで設定します。
デフォルト: 設定なし

キャプションの選択

params.languagestring | array / 任意
英語(en-orig, then en)の省略。 auto=true では、各コードは -orig のトラックを最初に試み、要求されたコード。 Explicit -orig コードと auto=false は正確です。 配列は、1–10の異なる言語を要求します。
デフォルト: en-orig → en
params.autoboolean / 任意
true は YouTube 生成されたキャプションを選択します。false は、アップローダーで提供されるキャプションを選択します。 これは、言語の検出や新しい転写ではなく、キャプションの起源を選択します。
true または falseデフォルト: true

レスポンス

Realtime のリターン status: done. ソースの出力を読んで下さい results[0]; usage.credits チャージを記録します。

結合されたトランスクリプトのテキストと fullText のセグメントを読みます。 セグメントの開始と終了は秒です。 languageCodeとisAutoGeneratedは、選択したトラックを識別します。

結果を読む

response.jsonとして成功するJSON応答を保存します。 これをread-response.pyとして保存し、python read-response.pyを実行します。 Pythonの標準ライブラリのみを使用し、新しいリクエストは使用しません。

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 = {
    "tracks": result.get("tracks", [result]),
    "errors": result.get("errors", []),
}
print(json.dumps(output, ensure_ascii=False, indent=2))

エンオリグを好む言語を省略し、エントに戻って1つのトラックを返します。 auto=true では、各リクエストされたコードは、その -orig のトラックを好み、その後、プレーンコードを優先します。 explicit -orig と auto=false は正確です。 配列は、要求されたすべての言語を試し、トラックとエラーを順番に返します。 languageCodeは、選択したトラックを識別します。 requestedLanguageCodeは異なる場合に含まれています。

言語の配列を指定した場合は、errors で取得に失敗したトラックを確認してください。トラックを 1 件も取得できない場合、リクエストは失敗し、確保済みのクレジットは返還されます。動画の抽出エラーやリクエストの期限切れでも失敗します。

自動キャプションの true への自動デフォルト。 false は、アップロード機能搭載のキャプション用に設定します。 APIは、キャプションソースを切り替えることはありません。

API は既存の YouTube のキャプションを読み込み、新しいトランスクリプトを生成しません。 デフォルト応答には、正規化 JSON テキストが含まれています。 Acceptは、プレーンテキストとX-Respond-With:マークダウンはMarkdownを選択します。 languageNameはnullです。

複数の言語

追跡と言語のエラーを受け取るために言語配列を送信します。 この例では、英語が利用でき、スペイン語が利用できなくなったりします。

リクエスト
{
  "source": "youtube_transcript",
  "video_id": "jNQXAC9IVRw",
  "params": {
    "language": [
      "en",
      "es"
    ],
    "auto": true
  }
}
results[0]
{
  "videoId": "jNQXAC9IVRw",
  "isAutoGenerated": true,
  "tracks": [
    {
      "videoId": "jNQXAC9IVRw",
      "languageCode": "en-orig",
      "requestedLanguageCode": "en",
      "languageName": null,
      "isAutoGenerated": true,
      "segments": [
        {
          "start": 0,
          "end": 1.5,
          "text": "Hello world."
        }
      ],
      "fullText": "Hello world."
    }
  ],
  "errors": [
    {
      "languageCode": "es",
      "code": "language_unavailable",
      "message": "Auto-generated subtitles not available for language: es"
    }
  ]
}
すべての応答フィールド
フィールド説明:
sourcestring要求されたAPIの源。
statusstringリアルタイムリクエストが成功したときに行われる。
created_atstringISO 8601 形式の応答作成時間。
usage.creditsnumberリクエストに応じて請求されるクレジットは、プランに基づいて行われます。
results[0].videoIdstring要求されたビデオID。
results[0].languageCodestring実際の選択されたキャプション・トラック コード、例えば en-orig のような。
results[0].languageNamestring · nullable利用できる場合の言語表示名。
results[0].requestedLanguageCodestring · optionalリクエストされたコードは、languageCodeと異なる場合、例えば en-orig が選択されたとき。
results[0].isAutoGeneratedboolean選択したキャプションが自動的に生成されるかどうか。
results[0].segmentsarray慢性的な順序のキャプションの区分。
results[0].segments[].startnumber秒単位の開始時間。
results[0].segments[].endnumber秒単位で終了時刻をセグメント化します。
results[0].segments[].textstringキャプションテキスト。
results[0].fullTextstringすべてのセグメントのテキストは、トランスクリプトに結合しました。
results[0].tracksarray · optional言語配列のみ。 リクエスト順に利用可能なトラック。それぞれに上記のシングルトラックフィールドがあります。
results[0].errorsarray · optional言語配列のみ。 リクエストの注文で失敗した言語。 すべてのトラックが成功すると空に。
results[0].errors[].languageCodestring失敗した要求された言語。
results[0].errors[].codestringlanguage_unavailable 選択したトラックが存在しない場合。 retrieval_failed ダウンロードや解析ができない場合。
results[0].errors[].messagestring言語障害の説明。

上記のフィールドは、デフォルトの JSON 応答を記述します。 JSON, テキストとMarkdownフォーマット.

Asyncは1つの仕事のレシートを戻します; バッチは1つ/ ビデオ ID. 各ジョブのステータスを確認し、返されたリンクを使用して結果を取得します。

Async及びバッチ ライフサイクル

提出は、結果ではなく、領収書を返します。 Async は 1 つのジョブを作成します。 バッチは別のジョブを返します。 queries[] あらゆる問い合わせに対応。 各ジョブを独立して追跡し、取得します。

提出する data.flashdata.dev; ジョブの状態と結果を読みます api.flashdata.dev 同じ X-API-Key を使って。 リンクしたAPIの基本例では、PythonとcURLを使用しています。

  1. 1. ジョブを保存 IDs

    Asyncに切り替えるときに、このソースの要求フィールドをキープします。 Batch では、JSON オブジェクトのクエリ配列に各リクエストを入力します。 ID を返すジョブを全て保存します。

    Asyncリクエストとレシート · Batchリクエストボディ

  2. 2. ステータスの確認

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

    pending / processing: 遅延と敬意のある投票 Retry-After 現時点では completed: 結果を取得します。 failed: 検査 job.error.

    job.status を読んでください。投稿レシートのステータスはありません。

    ステータス・Python・cURL

    ジョブステータス API 参照
  3. 3. フェッチ結果

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

    完了後、結果が読み込まれたことを認証し、取得します。 302 ストレージ URL あなたなしで API キー。 24 内の JSON を完成時間内に保存します。

    フェッチ結果 · Python と cURL · レスポンス形式

    結果は、APIリファレンスをダウンロード

既存の結果のポーリングとフェッチは、クエリクレジットを消費しません。 ポーリングのタイムアウトはジョブをキャンセルしません。重複した課金の作業を投稿する代わりに、IDをキープします。 エラーコードと再試行動作.

完了通知 Webhook

クエリごとに購読する

セットセット callback_url 非同期リクエストのトップレベル、または 各クエリの内部 バッチで、外側 params. 別途のwebhook-registrationリクエストが必要です。 Realtime リクエストはコールバックを送信しません。

公共利用 HTTPS URL 港に 443. FlashData POSTsは、各ジョブが到達する通知を送信します completed または failed; イベントは、結果自体ではなく、リンクが含まれています。

アクノレッジと検証

返品について 2xx イベントを厳しく受け入れた後。 重複排除 delivery_id, 、またとして送られます X-Delivery-Id. リダイレクトは続行しません。

緊急の配送再試行、最大 8 は合計を試みます そして最も 24 完了後時間. フォールバックとして花粉を保ちます。

コールバックは未署名です。 ジョブの ID、ソース、ターミナルの状態を経由して確認する 認証されたステータスエンドポイント 通知を処理する前に。 配達IDは信憑性の証拠ではなく、解読のためです。

Webhookイベントとフィールドの例
Illustrative 完了通知
{
  "delivery_id": "completion:job_example0001",
  "id": "job_example0001",
  "source": "youtube_transcript",
  "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"
    }
  ]
}
フィールド説明:
delivery_idstring安定した配達識別子。 この値を使用して通知を複製します。また、X-Delivery-Id ヘッダーに送信されます。
idstring求人 ID.
sourcestringリクエストされたデータソース。
statusstring完了または失敗。
linksarrayステータスと結果のリンク。 結果のコンテンツやAPIキーは、通知は含まれていません。
links[].relstring自己または結果。
links[].hrefstring絶対管理 API URL;あなたのAPIのキーと認証して下さい。
links[].methodstringGET.の特長

完全なwebhook契約とURL制限

Bulkファイル処理

1 行につき 1 つのビデオ ID をアップロードし、ソースで Bulk ジョブを作成します。: youtube_transcript. 共有オプションは、ファイル内のすべてのIDに適用されます。

ソースオプション: 言語、自動. Bulkジョブを作成するときにオプションにそれらを置きます。

完成したコレクションをマニフェストとgzip-compressed NDJSON 結果の部分として取得します。 Bulkジョブを作成するときに、データソースは、options.result_storageを設定することで、クラウドストレージに結果部品を配信することもできます。 Bulkジョブ全体が完了した後、24時間以内にマニフェストと部品を保存します。

Bulk 加工プロセス API · Python とりあえず cURL · Batch JSON リクエスト

Bulkのワークフローをこのソースにビルドする · ポーズ、再開、回復

エラー回復

リクエストされたトラックが利用できなくなったら、メタデータ API の transcriptLanguages を点検し、サポートされる language/track のタイプを明示的に要求して下さい。 変更されていない選択を繰り返すと、そのトラックは作成されません。

Metadataで利用可能なキャプション言語をチェックする. 新規では、リクエストのクレジットが使用されます。トラックの変更は既存のジョブを変更しません。

認証、残高、リクエスト形式、レート制限の失敗については、共有エラー参照を使用します。 提出期限は、まだジョブを作成している可能性があります。 再試行する前に、既存の作業を確認してください。

エラーとステータスコード · 再試行するとき · レート制限

ステップバイステップガイド: トランスクリプト言語を選択し、追跡する

料金

プラン使用法率標準リクエスト1,000件あたりサブスクリプション請求期間ごとのクレジットを含む
従量課金$0.50月額料金なし必要に応じてチャージ
Micro$0.40$49.00 / 月 月 日1,000クレジット($50.00のAPI使用)付属
Starter$0.35$199.00 / 月 月 日4,000クレジット($200.00のAPI使用)付属
Pro$0.30$499.00 / 月 月 日10,000クレジット($500.00のAPI使用)付属
Scale$0.25$999.00 / 月 月 日20,000クレジット($1,000.00のAPI使用)付属
Business$0.20$1,999.00 / 月 月 日40,000クレジット($2,000.00のAPI使用)付属

アカウントごとに1つのプラン。3製品でクレジットを共有します。付属クレジットで支払った使用量に追加で課金されることはありません。

現在の価格とプランの制限