Groups: list

API リクエスト パラメータに一致するグループのリストを返します。たとえば、認証済みユーザーが所有しているすべてのグループを取得することも、一意の ID で 1 つ以上のグループを取得することもできます。

リクエスト

HTTP リクエスト

GET https://youtubeanalytics.googleapis.com/v2/groups

承認

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

スコープ
https://www.googleapis.com/auth/yt-analytics.readonly YouTube コンテンツの YouTube アナリティクス レポートを表示します。このスコープは再生回数や評価数など、ユーザー アクティビティの指標へのアクセスを提供します。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube コンテンツに関する YouTube アナリティクス収益レポートを表示します。このスコープでは、ユーザー アクティビティの指標や、収益と広告パフォーマンスの推定指標を確認できます。
https://www.googleapis.com/auth/youtube YouTube アカウントの管理YouTube アナリティクス API では、チャンネル所有者はこのスコープを使用して、YouTube アナリティクスのグループとグループ アイテムを管理します。
https://www.googleapis.com/auth/youtubepartner YouTube のアセットやそれに関連するコンテンツの表示と管理YouTube Analytics API では、コンテンツ所有者はこのスコープを使用して YouTube アナリティクスのグループとグループ アイテムを管理します。

パラメータ

下記の表は、このクエリでサポートされているパラメータの一覧です。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
フィルタ（次のパラメータのいずれか 1 つのみを指定）
id string
id パラメータでは、取得するリソースの YouTube グループ ID をカンマ区切りのリストで指定します。各グループは、認証済みユーザーが所有している必要があります。group リソースでは、id プロパティにグループの YouTube グループ ID を指定します。

id パラメータの値を指定しない場合は、mine パラメータを true に設定する必要があります。
mine boolean
このパラメータは、適切に承認されたリクエストでのみ使用できます。このパラメータの値は true に設定し、認証されたユーザーが所有するすべてのグループを取得します。
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、さまざまな YouTube チャンネルを所有し、管理している YouTube コンテンツ パートナーのみを対象としています。

onBehalfOfContentOwner パラメータは、パラメータ値で指定されたコンテンツ所有者の代理として行動している YouTube ユーザーを、リクエストの承認認証情報が識別することを示します。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザーが認証するアカウントは、指定された YouTube コンテンツ所有者にリンクされている必要があります。
pageToken string
pageToken パラメータは、返す必要がある結果セット内の特定のページを識別します。API レスポンスでは、nextPageToken プロパティを使用して次のページを取得できます。

リクエスト本文

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

レスポンス

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

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#groupListResponse です。
etag etag
このリソースの Etag。
items[] list
API リクエスト パラメータに一致するグループのリスト。リストの各項目は、group リソースを表します。
nextPageToken string
結果セットの次のページを取得するために pageToken パラメータの値として使用できるトークン。

エラー

API は、この API メソッドに固有のエラー メッセージを定義しません。ただし、このメソッドでは、エラー メッセージのドキュメントに記載されている一般的な API エラーが返される場合があります。

実習

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