GroupItems: list

重要: このメソッドに対する API リクエストでは、次のいずれかへのアクセス権が必要です。
  • https://www.googleapis.com/auth/youtube スコープ
    または
  • https://www.googleapis.com/auth/youtube.readonly スコープ
    および
    https://www.googleapis.com/auth/yt-analytics.readonly スコープ

最初のオプションでは 1 つのスコープ（読み取り / 書き込みスコープ）が使用されますが、2 番目のオプションでは 2 つの読み取り専用スコープが使用されます。

API リクエスト パラメータに一致するグループアイテムのコレクションを返します。

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 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 アナリティクスのグループとグループアイテムを管理します。

パラメータ

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

パラメータ
必須パラメータ
groupId string
id パラメータには、グループアイテムを取得するグループの一意の ID を指定します。
オプション パラメータ
onBehalfOfContentOwner string
このパラメータは、適切に承認されたリクエストでのみ使用できます。注: このパラメータは、さまざまな YouTube チャンネルを所有して管理している YouTube コンテンツ パートナー専用です。

onBehalfOfContentOwner パラメータは、リクエストの認可認証情報で、パラメータ値で指定されたコンテンツ所有者の代理で行動している YouTube ユーザーを識別することを示します。このパラメータを使用すると、コンテンツ所有者は一度認証されれば、すべての動画やチャンネル データにアクセスできるようになります。チャンネルごとに認証情報を指定する必要はありません。ユーザーが認証に使用するアカウントは、指定した YouTube コンテンツ所有者にリンクされている必要があります。

リクエスト本文

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

Response

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

{
  "kind": "youtube#groupItemListResponse",
  "etag": etag,
  "items": [
    groupItem Resource
  ]
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#groupItemListResponse です。
etag etag
このリソースの Etag。
items[] list
グループに含まれるアイテムのリスト。リスト内の各項目は groupItem リソースを表します。

エラー

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

試してみよう:

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