このページは Cloud Translation API によって翻訳されました。

LiveBroadcasts: cuepoint

ライブ配信にキューポイントを挿入します。キューポイントによってミッドロール挿入点がトリガーされる可能性があります。

注: このメソッドは、YouTube コンテンツ所有者に関連付けられたアカウントによってリクエストが承認される必要がある liveCuepoints.insert メソッドに代わるものです。この方法には、同じ認可要件はありません。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/cuepoint

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と認可の詳細については、OAuth 2.0 認証の実装をご覧ください。

範囲
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`
`https://www.googleapis.com/auth/youtubepartner`

パラメータ

次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリパラメータです。

パラメータ
必須パラメータ
`id`	`string` `id` パラメータは、キューポイントが挿入されるブロードキャストを識別します。キューポイントを挿入するときに、ブロードキャストがアクティブにストリーミングされている必要があります。
オプションパラメータ
`onBehalfOfContentOwner`	`string` このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツパートナー専用です。これにより、コンテンツ所有者は、個々のチャンネルごとに異なる認証情報を指定することなく、一度認証を行うだけで、パラメータ値で指定されたチャンネルに代わってアクションを実行できます。ユーザーが認証に使用するアカウントは、指定された YouTube コンテンツ所有者にリンクされている必要があります。 `onBehalfOfContentOwner` パラメータは、リクエストの認可認証情報が、パラメータ値で指定された YouTube コンテンツ所有者の代理として行動する YouTube ユーザーを識別することを示します。このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツパートナーを対象としています。
`onBehalfOfContentOwnerChannel`	`string` このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツパートナー専用です。これにより、コンテンツ所有者は、個々のチャンネルごとに認証情報を提供することなく、一度認証を行うだけで、パラメータ値で指定されたチャンネルに代わってアクションを実行できます。 `onBehalfOfContentOwnerChannel` パラメータには、キューポイントが挿入されるブロードキャストに対応するチャンネルの YouTube チャンネル ID を指定します。このパラメータは、リクエストで `onBehalfOfContentOwner` パラメータの値を指定する場合に必須です。このパラメータと組み合わせてのみ使用できます。次の要件も適用されます。リクエストは、`onBehalfOfContentOwner` パラメータで指定されたコンテンツ所有者にリンクされているユーザーアカウントで承認する必要があります。 `onBehalfOfContentOwnerChannel` パラメータ値で指定したチャンネルは、`onBehalfOfContentOwner` パラメータで指定したコンテンツ所有者にリンクされている必要があります。

リクエストの本文

リクエスト本文に cuepoint リソースを指定します。次の JSON 構造は、cuepoint リソースの形式を示しています。

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }

リクエストの本文で、cueType フィールドは必須で、cueTypeAd に設定する必要があります。次のプロパティの値を設定することもできます。

durationSecs
insertionOffsetTimeMs（walltimeMs が設定されている場合は設定しないでください）
walltimeMs（insertionOffsetTimeMs が設定されている場合は設定しないでください）

プロパティ

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

プロパティ
`id`	`string` キューポイントを一意に識別するために YouTube が割り当てる値。この値は、ブロードキャストを識別する必須の `id` パラメータとは異なります。キューポイントを挿入するリクエストを送信する場合は、この値を省略できます。この値は API レスポンスに入力されます。
`insertionOffsetTimeMs`	`long` プロパティ値は、キューポイントを挿入する時間オフセット（ミリ秒単位）を指定します。この値はモニターストリームの先頭から測定されます。デフォルト値は `0` で、キューポイントをできるだけ早く挿入する必要があることを示します。ブロードキャストにはモニターストリームがない場合、このパラメータの値は指定しないでください。ミリ秒単位で測定されますが、値は実際は近似値です。YouTube は、その時間にできるだけ近い位置にキューポイントを挿入します。このフィールドのゼロ以外の値は、ブロードキャストストリームが遅延されている場合にのみサポートされます。ブロードキャストストリームに遅延がない場合は、`0` のみが有効な値です。詳しくは、スタートガイドをご覧ください。注: 放送にテストフェーズがある場合、オフセットはテストフェーズの開始時間から測定されます。リクエストで、このプロパティと `walltimeMs` プロパティの値を指定するキューポイントを挿入しようとすると、API からエラーが返されます。
`walltimeMs`	`integer` プロパティ値には、キューポイントを挿入する壁時計時間を指定します。値は、エポックタイムスタンプをミリ秒単位で表す整数です。リクエストで、このプロパティと `insertionOffsetTimeMs` プロパティの値を指定するキューポイントを挿入しようとすると、API からエラーが返されます。
`durationSecs`	`unsigned integer` キューポイントの長さ（秒単位）。値は正の整数にする必要があります。デフォルト値は `30` です。
`cueType`	`string` キューポイントのタイプ。プロパティ値は `cueTypeAd` に設定する必要があります。

レスポンス

成功すると、このメソッドはレスポンスの本文で挿入された cuepoint リソースを返します。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラーメッセージを示します。詳細については、YouTube Live Streaming API - エラーをご覧ください。

エラーのタイプ	エラーの詳細	説明
`insufficientPermissions (403)`	`insufficientLivePermissions`	リクエストには、ライブ配信にキューポイントを挿入する権限がありません。
`insufficientPermissions (403)`	`liveStreamingNotEnabled`	リクエストを承認したユーザーが、YouTube でライブ動画をストリーミングできない。詳しくは、ライブ配信の開始と機能の利用条件をご覧ください。
`rateLimitExceeded (403)`	`userRequestsExceedRateLimit`	ユーザーが一定の期間内に送信したリクエストが多すぎます。
`required (400)`	`idRequired`	必須の `id` パラメータには、キューポイントを挿入するブロードキャストを指定する必要があります。
`required (400)`	`cueTypeRequired`	必須の `cueType` フィールドを API リクエストの本文で指定する必要があります。
`notFound (404)`	`liveBroadcastNotFound`	`id` パラメータで指定されたブロードキャストが存在しません。
`invalidValue (400)`	`conflictingTimeFields`	`insertionOffsetTimeMs` と `walltimeMs` のいずれか 1 つのみを指定できます。両方の値を設定するとエラーが発生します。どちらの値も設定しない場合、YouTube はデフォルトの `insertionOffsetTimeMs` 時間（`0`）を使用します。つまり、キューポイントはできる限り早く挿入されます。
`invalidValue (400)`	`invalidInsertionOffsetTimeMs`	`cuepoint` リソースで `insertionOffsetTimeMs` プロパティに無効な値が指定されています。値は `0` または正の整数にする必要があります。
`invalidValue (400)`	`invalidWalltimeMs`	`cuepoint` リソースで `walltimeMs` プロパティに無効な値が指定されています。値は、エポックタイムスタンプ（ミリ秒単位）を表す整数にする必要があります。
`backendError (5xx)`	`serviceUnavailable`	サービスを利用できません。数分後にもう一度リクエストをお試しください。

試してみよう:

APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。