Groups: list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Retorna uma lista de grupos que correspondem aos parâmetros de solicitação da API. Por exemplo, é possível recuperar todos os grupos que pertencem ao usuário autenticado ou recuperar um ou mais grupos pelos IDs exclusivos.
Solicitação
Solicitação HTTP
GET https://youtubeanalytics.googleapis.com/v2/groups
Autorização
Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).
| Escopos |
| https://www.googleapis.com/auth/yt-analytics.readonly |
Visualizar os relatórios do YouTube Analytics para seu conteúdo do YouTube. Este escopo fornece acesso às métricas de atividade do usuário, como contagens de visualização e de classificação. |
| https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
Visualizar os relatórios monetários do YouTube Analytics para seu conteúdo do YouTube. Esse escopo dá acesso às métricas de atividade do usuário e às métricas de receita estimada e performance do anúncio. |
| https://www.googleapis.com/auth/youtube |
Gerenciar sua conta do YouTube. Na API YouTube Analytics, os proprietários de canais usam esse escopo para gerenciar grupos e itens de grupo do YouTube Analytics. |
| https://www.googleapis.com/auth/youtubepartner |
Acessar e gerenciar recursos e conteúdo associado no YouTube. Na API YouTube Analytics, os proprietários de conteúdo usam esse escopo para gerenciar grupos e itens de grupo do YouTube Analytics. |
Parâmetros
A tabela a seguir lista os parâmetros que esta consulta suporta. Todos os parâmetros listados são os parâmetros de consulta.
| Parâmetros |
| Filtros (especifique exatamente um dos parâmetros a seguir) |
id |
string
O parâmetro id especifica uma lista separada por vírgulas dos IDs de grupo do YouTube dos recursos que estão sendo recuperados. Cada grupo precisa ser de propriedade do usuário autenticado. Em um recurso group, a propriedade id especifica o ID do grupo do YouTube.
Se você não especificar um valor para o parâmetro id, defina o parâmetro mine como true. |
mine |
boolean
Esse parâmetro só pode ser usado em uma solicitação autorizada. Defina o valor desse parâmetro como true para recuperar todos os grupos de propriedade do usuário autenticado. |
| Parâmetros opcionais |
onBehalfOfContentOwner |
string
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais diferentes.
O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do parâmetro. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta que o usuário usa para fazer a autenticação precisa estar vinculada ao proprietário do conteúdo do YouTube especificado. |
pageToken |
string
O parâmetro pageToken identifica uma página específica no conjunto de resultados que precisa ser retornada. Em uma resposta da API, a propriedade nextPageToken identifica a próxima página que pode ser recuperada. |
Corpo da solicitação
Não forneça um corpo de solicitação ao chamar este método.
Resposta
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
| Propriedades |
kind |
string
Identifica o tipo do recurso da API. O valor será youtube#groupListResponse. |
etag |
etag
A Etag deste recurso. |
items[] |
list
Uma lista de grupos que correspondem aos parâmetros de solicitação da API. Cada item na lista representa um recurso group. |
nextPageToken |
string
O token que pode ser usado como o valor do parâmetro pageToken para recuperar a próxima página no conjunto de resultados. |
Erros
A API não define mensagens de erro exclusivas para esse método. No entanto, esse método ainda pode retornar erros gerais da API listados na documentação da mensagem de erro.
Confira!
Use APIs Explorer para chamar essa API e conferir a solicitação e a resposta dela.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-21 UTC.
[null,null,["Última atualização 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."]]
