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 Analytics API では、チャンネル所有者はこのスコープを使用して YouTube アナリティクスのグループとグループアイテムを管理します。
https://www.googleapis.com/auth/youtubepartner YouTube のアセットや関連するコンテンツを 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 プロパティは取得可能な次のページを示します。

リクエスト本文

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

Response

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

{
  "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 エラーを返す可能性があります。

試してみよう:

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