Groups: list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zwraca listę grup, które pasują do parametrów żądania interfejsu API. Możesz na przykład pobrać wszystkie grupy należące do uwierzytelnionego użytkownika lub pobrać co najmniej 1 grupę według jej unikalnego identyfikatora.
Żądanie
Żądanie HTTP
GET https://youtubeanalytics.googleapis.com/v2/groups
Autoryzacja
To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów (więcej informacji o uwierzytelnianiu i autoryzacji).
| Zakresy |
| https://www.googleapis.com/auth/yt-analytics.readonly |
Wyświetlanie raportów Statystyk YouTube dotyczących treści w YouTube. Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i liczba ocen. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Ten zakres uprawnień zapewnia dostęp do danych o aktywności użytkowników oraz szacowanych przychodów i danych o skuteczności reklam. |
| https://www.googleapis.com/auth/youtube |
Zarządzanie kontem YouTube. W interfejsie API Statystyk YouTube właściciele kanałów używają tego zakresu do zarządzania grupami i elementami grup w Statystykach YouTube. |
| https://www.googleapis.com/auth/youtubepartner |
Wyświetlanie zasobów YouTube i powiązanych z nimi treści w YouTube oraz zarządzanie nimi. W interfejsie YouTube Analytics API właściciele treści używają tego zakresu do zarządzania grupami i elementami grup w Statystykach YouTube. |
Parametry
Tabela poniżej zawiera listę parametrów obsługiwanych przez to zapytanie. Wszystkie wymienione parametry są parametrami zapytania.
| Parametry |
| Filtry (wybierz dokładnie 1 z tych parametrów) |
id |
string
Parametry id określają listę oddzielonych przecinkami identyfikatorów grup YouTube, do których należą pobierane zasoby. Każda grupa musi należeć do uwierzytelnionego użytkownika. W zasobach group właściwość id określa identyfikator grupy YouTube.
Pamiętaj, że jeśli nie określisz wartości parametru id, musisz ustawić parametr mine na true. |
mine |
boolean
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Aby pobrać wszystkie grupy należące do uwierzytelnionego użytkownika, ustaw wartość tego parametru na true. |
| Parametry opcjonalne |
onBehalfOfContentOwner |
string
Tego parametru można używać tylko w prawidłowo autoryzowanym żądaniu. Uwaga: ten parametr jest przeznaczony wyłącznie dla partnerów treści w YouTube, którzy są właścicielami wielu kanałów w YouTube i nimi zarządzają.
Parametr onBehalfOfContentOwner wskazuje, że dane uwierzytelniające autoryzacji prośby identyfikują użytkownika YouTube, który działa w imieniu właściciela treści określonego w wartości parametru. Umożliwia ona właścicielom treści jednorazową weryfikację i uzyskanie dostępu do wszystkich danych o filmach i kanałach bez konieczności podawania danych uwierzytelniających dla każdego kanału. Konto, na którym użytkownik się uwierzytelnia, musi być powiązane z określonym właścicielem treści w YouTube. |
pageToken |
string
Parametr pageToken określa w zestawie wyników konkretną stronę, która powinna zostać zwrócona. W odpowiedzi interfejsu API właściwość nextPageToken wskazuje następną stronę, którą można pobrać. |
Treść żądania
Podczas wywoływania tej metody nie podawaj treści żądania.
Odpowiedź
Właściwości
Właściwości występujące w tym zasobie są opisane w tabeli poniżej:
| Właściwości |
kind |
string
Określa typ zasobu interfejsu API. Wartość będzie wynosić youtube#groupListResponse. |
etag |
etag
Etag tego zasobu. |
items[] |
list
Lista grup pasujących do parametrów żądania interfejsu API. Każdy element na liście reprezentuje zasób group. |
nextPageToken |
string
Token, którego można użyć jako wartości parametru pageToken do pobrania następnej strony w zestawie wyników. |
Błędy
Interfejs API nie definiuje żadnych komunikatów o błędach, które są unikalne dla tej metody. Ta metoda może jednak zwracać ogólne błędy interfejsu API wymienione w dokumentacji komunikatów o błędach.
Wypróbuj
Użyj adresu APIs Explorer, aby wywołać ten interfejs API i zobaczyć żądanie oraz odpowiedź interfejsu API.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-08-21 UTC.
[null,null,["Ostatnia aktualizacja: 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."]]
