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

API リファレンス

YouTube 拡張検索 API

API キーを取得する

リクエストごとの700 YouTubeの検索結果、ビデオの詳細、サムネイル、検索フィルタなどを取得します。

リクエストを作成

返す検索結果の最大件数。

詳細パラメーター
機能
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_search_extended",
    "query": "python",
    "params": {
        "max_results": 20,
    },
}

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 とりあえず query 最上位レベル。 ソースのオプションは、 params. オプションのフィールドは省略可能です。

リクエストボディ

sourcestring / 必須
youtube_search_extendedに設定します。
querystring / 必須
クエリを検索します。
1 へ へ へ へ 2,000 キャラクターデフォルト: 設定なし
paramsobject / 任意
この要求のためのSettings。
デフォルト: {}
callback_urlstring · nullable / 任意
Asyncとバッチだけ。 パブリック HTTPS エントリーフォーム URL 港に 443まで、 2,048 文字。 ユーザーの資格情報や URL フラグメントはありません。 Omit は、通知なしの null または空の文字列を使用します。 バッチでは、各クエリで、外部のパラメータで設定します。
デフォルト: 設定なし

結果のカウント

params.max_resultsinteger / 任意
リクエストされた結果のカウント。 フェアーターの結果は、利用可能な場合があります。
1 へ へ へ へ 700, 数字全体デフォルト: 20

フィルターを検索

params.filtersobject · nullable / 任意
オプションのアップロード日付、結果タイプ、期間、ソートおよび機能フィルタ。 フィルタなしのnullを省略または使用。
デフォルト: 設定なし
params.filters.upload_datestring / 任意
アップロード日付でフィルタリングします。
1 へ へ へ へ 2,000 キャラクター値: today / last_hour / this_week / this_month / this_yearデフォルト: 設定なし
params.filters.typestring / 任意
結果型でフィルタリングします。
1 へ へ へ へ 2,000 キャラクター値: video / channel / playlist / movieデフォルト: 設定なし
params.filters.durationstring / 任意
数分でビデオの長さでフィルタリングします。
1 へ へ へ へ 2,000 キャラクター値: <4 / 4-20 / >20デフォルト: 設定なし
params.filters.sort_bystring / 任意
結果の注文。 Omit は、YouTube のデフォルト注文を使用する。
1 へ へ へ へ 2,000 キャラクター値: rating / relevance / view_count / upload_dateデフォルト: 設定なし
params.filters.360boolean / 任意
true をセットして、360 機能が必要です。
true または falseデフォルト: 設定なし
params.filters.3dboolean / 任意
trueを3dの機能を要求するために置きます。
true または falseデフォルト: 設定なし
params.filters.4kboolean / 任意
trueを4kの機能を要求するために置きます。
true または falseデフォルト: 設定なし
params.filters.creative_commonsboolean / 任意
true をセットして、クリエイティブな共通機能を要求します。
true または falseデフォルト: 設定なし
params.filters.hdboolean / 任意
hd 機能を必要とする true を設定します。
true または falseデフォルト: 設定なし
params.filters.hdrboolean / 任意
true を設定し、HDr 機能が必要です。
true または falseデフォルト: 設定なし
params.filters.liveboolean / 任意
trueをセットしてライブ機能が必要です。
true または falseデフォルト: 設定なし
params.filters.locationboolean / 任意
true を設定し、位置情報を必要とする。
true または falseデフォルト: 設定なし
params.filters.purchasedboolean / 任意
trueをセットして、購入した機能が必要です。
true または falseデフォルト: 設定なし
params.filters.subtitlesboolean / 任意
true を設定し、字幕機能が必要です。
true または falseデフォルト: 設定なし
params.filters.vr180boolean / 任意
true を vr180 機能を必要とするように設定します。
true または falseデフォルト: 設定なし

レスポンス

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

検索出力には、クエリ、totalResults、および返された項目が含まれています。 totalResultsは、この応答の項目をカウントします。 YouTubeのマッチング動画の合計数ではありません。

結果を読む

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": item.get("videoId"), "title": item.get("title"), "channel": item.get("channel")}
    for item in result.get("results", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))

max_results のデフォルトは 20 に、1 を 700 に受け入れます。 これは、700の別々のバッチジョブではなく、より大きな検索リクエストです。 より大きなリクエストは長く受けることができます。非同期は、送信者の接続を開いたままにすることを避けます。

フィルタは、params.filtersに所属しています。 フェアーター結果が利用可能で、豊富な項目フィールドが利用可能 null または不在。 エクステンド検索は、独自の使用率を持っています。

すべての応答フィールド
フィールド説明:
sourcestring要求されたAPIの源。
statusstringリアルタイムリクエストが成功したときに行われる。
created_atstringISO 8601 形式の応答作成時間。
usage.creditsnumberリクエストに応じて請求されるクレジットは、プランに基づいて行われます。
results[0].querystring検索クエリ。
results[0].totalResultsinteger返された結果の数。
results[0].resultsarray返された注文で結果を検索します。
results[0].results[].videoIdstringYouTubeビデオID。
results[0].results[].titlestringビデオタイトル。
results[0].results[].channelstringチャンネル名。
results[0].results[].channelIdstring · nullableIDを利用できるときチャネル。
results[0].results[].channelUrlstring · nullableURLを利用できるときチャネル。
results[0].results[].durationnumber · nullable秒単位のビデオ持続時間。
results[0].results[].durationStringstring · nullable利用可能な場合、ビデオの長さをフォーマットしました。
results[0].results[].viewCountnumber · nullable利用可能な場合のカウントを表示します。
results[0].results[].uploadDatestring · nullable利用可能な日付をアップロードします。
results[0].results[].descriptionstring · nullable説明は、500文字、またはnull文字まで、利用できなくなったときに有効です。
results[0].results[].thumbnailsarrayサムネイルURLsと寸法。

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

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

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_search_extended",
  "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制限

エラー回復

大規模なリアルタイムのリクエストがなくなった場合、受諾は不確実である場合があります。 退会前の職務経歴書をご確認ください。 その後の大きな検索では、非同期を選択し、返されたIDを追跡します。

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

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

ステップバイステップガイド: より大きな候補検索を計画する

料金

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