LiveBroadcasts: list

API リクエストのパラメータに一致する YouTube ブロードキャストのリストを返します。

一般的なユースケース

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/youtube/v3/liveBroadcasts

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

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

パラメータ

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

パラメータ
必須パラメータ
part string
part パラメータには、API レスポンスに含める 1 つ以上の liveBroadcast リソース プロパティをカンマ区切りのリストで指定します。このパラメータ値に指定できる part の名前は、id、snippet、contentDetails、monetizationDetails、status です。
フィルタ（次のパラメータのいずれか 1 つのみ指定）
broadcastStatus string
broadcastStatus パラメータは、指定されたステータスのブロードキャストのみが含まれるように API レスポンスをフィルタします。

有効な値は次のとおりです。
  • active – 現在のライブ配信を返します。
  • all – すべてのブロードキャストを返します。
  • completed – すでに終了しているブロードキャストを返します。
  • upcoming – まだ開始されていないブロードキャストを返します。
id string
id パラメータは、取得するブロードキャストを識別する YouTube ブロードキャスト ID のカンマ区切りのリストを指定します。liveBroadcast リソースでは、id プロパティにブロードキャストの ID を指定します。
mine boolean
mine パラメータを使用すると、認証済みユーザーが所有するブロードキャストのみを返すように API に指示できます。独自のブロードキャストのみを取得するには、パラメータ値を true に設定します。
オプション パラメータ
broadcastType string
broadcastType パラメータは、指定されたタイプのブロードキャストのみが含まれるように API レスポンスをフィルタします。このパラメータは、mine パラメータを true に設定するリクエスト、または broadcastStatus パラメータを使用するリクエストで使用する必要があります。デフォルト値は event です。

指定できる値は次のとおりです。
  • all – すべてのブロードキャストを返します。
  • event – スケジュールされたイベントのブロードキャストのみを返します。
  • persistent – 永続的なブロードキャストのみを返します。
maxResults unsigned integer
maxResults パラメータには、結果セットで返されるアイテムの最大数を指定します。有効な値は 0～50 です。デフォルト値は 5 です。
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認証情報が、パラメータ値で指定されたコンテンツ所有者の正式な代理人である YouTube CMS ユーザーを識別することを示します。このパラメータは、複数の YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象にしています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザー認証に使用する CMS アカウントは、指定された YouTube コンテンツ所有者にリンクされていなければなりません。
onBehalfOfContentOwnerChannel string
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwnerChannel パラメータは、動画を追加するチャンネルの YouTube チャンネル ID を指定します。リクエストで onBehalfOfContentOwner パラメータの値を指定する場合、このパラメータは必須で、そのパラメータとのみ併用できます。また、リクエストは、onBehalfOfContentOwner パラメータで指定されたコンテンツ所有者にリンクされている CMS アカウントを使用して承認される必要があります。最後に、onBehalfOfContentOwnerChannel パラメータの値が指定するチャンネルは、onBehalfOfContentOwner パラメータで指定したコンテンツ所有者にリンクする必要があります。

このパラメータは、さまざまな YouTube チャンネルを所有、管理している YouTube コンテンツ パートナーを対象としています。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、パラメータ値で指定されたチャンネルの代わりにアクションを実行できるようになります。チャンネルごとに認証情報を指定する必要はありません。
pageToken string
pageToken パラメータは、返される結果セットの特定のページを指定します。API レスポンスでは、nextPageToken プロパティと prevPageToken プロパティは取得可能な他のページを示します。

リクエスト本文

このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。

レスポンス

成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。

{
  "kind": "youtube#liveBroadcastListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveBroadcast Resource
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#liveBroadcastListResponse です。
etag etag
このリソースの Etag。
nextPageToken string
結果セットの次のページを取得するために、pageToken パラメータの値として使用できるトークン。
prevPageToken string
結果セット内の前のページを取得するために、pageToken パラメータの値として使用できるトークン。
pageInfo object
pageInfo オブジェクトは、結果セットのページング情報をカプセル化します。
pageInfo.totalResults integer
結果セットの結果の合計数。
pageInfo.resultsPerPage integer
API レスポンスに含まれる結果の数。
items[] list
リクエスト条件に一致するブロードキャストのリスト。

エラー

次の表に、このメソッドの呼び出しに応じて API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
insufficientPermissions insufficientLivePermissions このリクエストには、ライブ配信を取得する権限がありません。
insufficientPermissions liveStreamingNotEnabled リクエストを承認したユーザーは、YouTube でライブ動画をストリーミングできません。ユーザーは https://www.youtube.com/features で詳細を確認できます。

実習

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