LiveCuepoints

liveCuepoint リソースと liveCuepoints.insert メソッドのサポートが終了し、liveBroadcasts.cuepoint メソッドに置き換えられました。

liveCuepoint リソースは、ブロードキャスト動画ストリームにキューポイントを挿入するため、広告ブレークが発生する可能性があります。

注: この API コマンドは、実際には YouTube Content ID API の一部であり、liveBroadcast リソースや liveStream リソースを管理するリクエストとは異なる承認要件があります。

Methods

API は、liveCuepoints リソースについて次のメソッドをサポートしています。

挿入
ライブブロードキャストにキューポイントを挿入します。現在、このメソッドへのリクエストは YouTube コンテンツ所有者に関連付けられたアカウントで承認される必要があります。 今すぐ試す

リソース表現

次の JSON 構造は、liveCuepoints リソースの形式を示しています。

{
  "id": string,
  "kind": "youtubePartner#liveCuepoint",
  "broadcastId": string,
  "settings": {
    "offsetTimeMs": long,
    "walltime": datetime,
    "cueType": string,
    "durationSecs": unsigned integer
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
id string
キューポイントを一意に識別するために YouTube が割り当てる値。
kind string
API リソースのタイプ。liveCuepoint リソースの場合、値は youtubePartner#liveCuepoint です。
broadcastId string
キューポイントを挿入するブロードキャストを一意に識別するために YouTube が割り当てる ID。
settings object
settings オブジェクトはキューポイントの設定を定義します。
settings.offsetTimeMs long
この値は、視聴者に広告またはインストリーム スレートが表示される時点を指定します。プロパティ値は、モニター ストリームの開始時点からの時間（ミリ秒単位）を示します。値はミリ秒単位ですが、実際には近似値であり、その時点にできるだけ近い場所でキューポイントが挿入されます。ブロードキャストにモニタリング ストリームがない場合は、このパラメータに値を指定しないでください。

このプロパティのデフォルト値は 0 です。これは、キューポイントをできるだけ早く挿入することを示します。ブロードキャスト ストリームが遅延しない場合、0 も唯一の有効な値です。ただし、ブロードキャスト ストリームが遅延している場合は、プロパティ値にキューポイントの挿入時間を指定できます。詳しくは、スタートガイドをご覧ください。

注: ブロードキャストにテストフェーズが設定されている場合、オフセットはテストフェーズの開始時点から測定されます。
settings.walltime datetime
この値は、キューポイントを挿入する実時間を指定します。値は ISO 8601（YYYY-MM-DDThh:mm:ss.sssZ）形式で指定します。

このプロパティと settings.offsetTimeMs プロパティの値を指定してキューポイントを挿入しようとすると、API からエラーが返されます。
settings.cueType string
キューポイントの型。さまざまな種類のキューポイントの説明については、スタートガイドをご覧ください。また、ブロードキャスト中にキューポイントを挿入する際のベスト プラクティスについては、ブロードキャストのライフサイクルのドキュメントをご覧ください。

このプロパティの有効な値は次のとおりです。
  • ad
settings.durationSecs unsigned integer
キューポイントの期間（秒）。cueType が ad の場合はこの値を指定し、それ以外の場合は無視します。