LiveBroadcasts: list

API リクエスト パラメータに一致する YouTube ライブ配信のリストを返します。

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストには、次のいずれかのスコープによる承認が必要です。認証と承認について詳しくは、OAuth 2.0 認証を実装するをご覧ください。

スコープ
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 プロパティは、取得できる他のページを識別します。

リクエストの本文

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

Response

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

{
  "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 でライブ動画を配信できません。詳しくは、機能の利用資格をご覧ください。

試してみよう:

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