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

API リファレンス

YouTube Trainability API

API キーを取得する

YouTubeビデオのライセンスメタデータをクリエイティブ・コモンズラベルにチェックし、その結果をJSONとして取得します。

リクエストを作成

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

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_trainability",
    "video_id": "dQw4w9WgXcQ",
}

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 最上位レベル。 このソースには、ソース固有のパラメータはありません。 オプションのフィールドは省略可能です。

リクエストボディ

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

レスポンス

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

結果は、videoIdをechoesし、種類、etagを報告し、許可します。 ワーカーは、検出されたクリエイティブ・コモンズ・ラベルの ["all"] の動画のライセンス・ラベルをチェックします。そうしないと、["none"] は、ライセンスの不足分メタデータを含みます。

結果を読む

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 = {"videoId": result.get("videoId"), "permitted": result.get("permitted", [])}
# Keep the label values; this is not a training-rights authorization.
print(json.dumps(output, ensure_ascii=False, indent=2))

このソースには、ソース固有のオプションはありません。 video_idをトップレベルに送る; 省略パラメータ。

このエンドポイントは、作成者のYouTubeサードパーティのトレーニング設定を受け取りません。 許可されている値がトレーニングの権利を付与します。フィールドは、このライセンスラベルチェックの出力のみです。

すべての応答フィールド
フィールド説明:
sourcestring要求されたAPIの源。
statusstringリアルタイムリクエストが成功したときに行われる。
created_atstringISO 8601 形式の応答作成時間。
usage.creditsnumberリクエストに応じて請求されるクレジットは、プランに基づいて行われます。
results[0].videoIdstring要求されたビデオID。
results[0].kindstringFlashData 結果タイプ: youtube#videoTrainability.
results[0].etagstring応答タグとしてechoedビデオID。
results[0].permittedarray<string>["all"] クリエイティブ・コモンズ・ラベルが検出されると、["none"] が、ライセンス・メタデータが見つからない場合。 これらの値は、作成者のYouTubeサードパーティのトレーニング設定を報告しません。

上記のフィールドは、デフォルトの 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_trainability",
  "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_trainability. 共有オプションは、ファイル内のすべてのIDに適用されます。

このソースには、ソース固有のオプションはありません。 ソースを設定し、IDファイルをアップロードします。

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

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

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

エラー回復

A ["none"] 結果は、失敗したジョブではなく、完全なライセンスチェックです。 ライセンスラベルが不在であることがわかります。 抽出中に削除またはアクセス不能なビデオが失敗する可能性があります。

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

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

ステップバイステップガイド: ライセンスラベルの解釈

料金

プラン使用法率標準リクエスト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製品でクレジットを共有します。付属クレジットで支払った使用量に追加で課金されることはありません。

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