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 |
string
API リソースのタイプを識別します。値は youtube#groupListResponse です。 |
etag |
etag
このリソースの Etag。 |
items[] |
list
API リクエスト パラメータに一致するグループのリスト。リスト内の各項目は、group リソースを表します。 |
nextPageToken |
string
結果セットの次のページを取得するために、pageToken パラメータの値として使用できるトークン。 |
エラー
この API メソッドに固有のエラー メッセージは定義されていません。ただし、このメソッドは、エラー メッセージのドキュメントに記載されている一般的な API エラーを返す可能性があります。
試してみよう:
APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-08-21 UTC。
[null,null,["最終更新日 2025-08-21 UTC。"],[[["\u003cp\u003eRetrieves a list of YouTube groups based on specified criteria, such as group IDs or ownership by the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes to access group data, including read-only access to YouTube Analytics reports.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by group IDs (\u003ccode\u003eid\u003c/code\u003e parameter) or retrieving all groups owned by the authenticated user (\u003ccode\u003emine\u003c/code\u003e parameter).\u003c/p\u003e\n"],["\u003cp\u003eSupports optional parameters like \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e for content owners managing multiple channels and \u003ccode\u003epageToken\u003c/code\u003e for pagination.\u003c/p\u003e\n"],["\u003cp\u003eReturns a response containing group details, including kind, Etag, items (list of groups), and a token for retrieving the next page of results.\u003c/p\u003e\n"]]],["This API method retrieves a list of YouTube Analytics groups. Requests are made via a `GET` request to a specified URL. Authentication requires specific scopes like `yt-analytics.readonly`. Users can filter groups by specifying group `id`s or by setting `mine` to `true` to get all groups they own. The response contains an `etag`, a list of `groups`, and potentially a `nextPageToken` for pagination. The method has the possibility to use `onBehalfOfContentOwner` for content owners.\n"],null,["# Groups: list\n\nReturns a list of groups that match the API request parameters. For example, you can retrieve all groups that the authenticated user owns, or you can retrieve one or more groups by their unique IDs.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groups\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/analytics/authentication)).\n\n| Scopes ||\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| https://www.googleapis.com/auth/yt-analytics.readonly | View YouTube Analytics reports for your YouTube content. This scope provides access to user activity metrics, like view counts and rating counts. |\n| https://www.googleapis.com/auth/yt-analytics-monetary.readonly | View YouTube Analytics monetary reports for your YouTube content. This scope provides access to user activity metrics and to estimated revenue and ad performance metrics. |\n| https://www.googleapis.com/auth/youtube | Manage your YouTube account. In the YouTube Analytics API, channel owners use this scope to manage YouTube Analytics groups and group items. |\n| https://www.googleapis.com/auth/youtubepartner | View and manage YouTube assets and associated content on YouTube. In the YouTube Analytics API, content owners use this scope to manage YouTube Analytics groups and group items. |\n\n### Parameters\n\nThe table below lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of the YouTube group ID(s) for the resource(s) that are being retrieved. Each group must be owned by the authenticated user. In a `group` resource, the `id` property specifies the group's YouTube group ID. Note that if you do not specify a value for the `id` parameter, then you must set the `mine` parameter to `true`. |\n| `mine` | `boolean` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). Set this parameter's value to `true` to retrieve all groups owned by the authenticated user. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/analytics/authentication). **Note:** This parameter is intended exclusively for YouTube content partners that own and manage many different YouTube channels. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube user who is acting on behalf of the content owner specified in the parameter value. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The account that the user authenticates with must be linked to the specified YouTube content owner. |\n| `pageToken` | `string` The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page that can be retrieved. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"#kind\": \"youtube#groupListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n group Resource\n ],\n \"#nextPageToken\": string\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#groupListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of groups that match the API request parameters. Each item in the list represents a [group](/youtube/analytics/reference/groups) resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n\nErrors\n------\n\nThe API does not define any error messages that are unique to this API method. However, this method could still return general API errors listed in the [error message](/youtube/analytics/reference/errors#general) documentation.\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
