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

API リファレンス

YouTube Channel API

API キーを取得する

YouTubeチャンネルプロファイルとハンドルによる最近のビデオを取得します。, 加入者数を含みます, チャンネル画像とビデオの詳細.

リクエストを作成

URL ではなく、@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_channel",
    "handle": "@jawed",
    "params": {
        "video_limit": 10,
    },
}

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

リクエストボディ

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

ビデオ選択

params.video_limitinteger / 任意
含める最大の動画. フェーアーはお買い求めいただけます。
1 へ へ へ へ 100, 数字全体デフォルト: 20

レスポンス

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

チャンネルプロファイルは result[0] にあります。そのビデオ配列には、最近のビデオが含まれています。 videoCount は、チャンネルを記述し、返された配列の長さではありません。

結果を読む

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

@プレフィックスの有無にかかわらず、トップレベルでのハンドルを送信します。 video_limitは、paramsに所属し、1を100に受け入れます。 20にデフォルトです。 例では、10 をリクエストします。

要求された限界は保証しない最高です。 カウント、画像 URLs と per-video の詳細は、null が利用できなくなったときに使用できます。

すべての応答フィールド
フィールド説明:
sourcestring要求されたAPIの源。
statusstringリアルタイムリクエストが成功したときに行われる。
created_atstringISO 8601 形式の応答作成時間。
usage.creditsnumberリクエストに応じて請求されるクレジットは、プランに基づいて行われます。
results[0].channelIdstringチャネルID。
results[0].channelHandlestringチャネルのハンドル。
results[0].namestringチャンネル名。
results[0].descriptionstringチャネルの記述。
results[0].subscriberCountnumber · nullable加入者数。
results[0].videoCountnumber · nullableチャンネルの動画総数。
results[0].viewCountnumber · nullable利用可能なチャネルビュー数。
results[0].avatarUrlstring · nullableチャネル アバター URL.
results[0].bannerUrlstring · nullableチャネルの旗URL。
results[0].channelUrlstringチャンネルページ URL.
results[0].videosarray最近の動画、video_limitエントリーまで。
results[0].videos[].videoIdstringビデオID。
results[0].videos[].titlestringビデオタイトル。
results[0].videos[].durationnumber · nullable秒単位の期間。
results[0].videos[].viewCountnumber · nullableカウントを表示
results[0].videos[].uploadDatestring · nullableアップロード日。
results[0].videos[].thumbnailstring · nullableビデオサムネイルURL。

上記のフィールドは、デフォルトの 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_channel",
  "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またはフルチャンネルURLではなく。 ハンドルが入力バリデーションを通過しても、削除またはアクセス不能なチャネルが失敗する可能性があります。 画像やカウントを見逃すことは、失敗を意味しません。

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

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

ステップバイステップガイド: チャネルと最近のビデオで作業

料金

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

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