GroupItems: list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Importante:as solicitações de API para esse método exigem acesso a:
- o escopo
https://www.googleapis.com/auth/youtube
ou
- o escopo
https://www.googleapis.com/auth/youtube.readonly
e
o escopo https://www.googleapis.com/auth/yt-analytics.readonly
A primeira opção usa um escopo, que é de leitura/gravação, enquanto a segunda opção usa dois escopos somente leitura.
Retorna uma coleção de itens de grupo que correspondem aos parâmetros de solicitação da API.
Solicitação
Solicitação HTTP
GET https://youtubeanalytics.googleapis.com/v2/groupItems
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. Este escopo fornece acesso às métricas de atividade do usuário e à receita estimada e métricas de desempenho de anúncios. |
| 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 |
| Parâmetros obrigatórios |
groupId |
string
O parâmetro id especifica o ID exclusivo do grupo para o qual você quer recuperar os itens. |
| Parâmetros opcionais |
onBehalfOfContentOwner |
string
Esse parâmetro só pode ser usado em uma solicitação autorizada. 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. |
Corpo da solicitação
Não forneça um corpo de solicitação ao chamar este método.
Resposta
Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:
{
"kind": "youtube#groupItemListResponse",
"etag": etag,
"items": [
groupItem Resource
]
}
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#groupItemListResponse.
|
etag |
etag
A Etag deste recurso. |
items[] |
list
Uma lista dos itens do grupo. Cada item da lista representa um recurso groupItem. |
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\u003eThis API method retrieves a collection of group items that match the specified request parameters.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this method requires authorization with either the \u003ccode\u003ehttps://www.googleapis.com/auth/youtube\u003c/code\u003e scope or the combination of \u003ccode\u003ehttps://www.googleapis.com/auth/youtube.readonly\u003c/code\u003e and \u003ccode\u003ehttps://www.googleapis.com/auth/yt-analytics.readonly\u003c/code\u003e scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egroupId\u003c/code\u003e parameter is required to specify the unique ID of the group for which you want to retrieve items.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e parameter is an optional parameter allowing content owners to authenticate once to access data for all their channels, and it is intended exclusively for YouTube content partners managing multiple channels.\u003c/p\u003e\n"],["\u003cp\u003eThe response body structure includes a \u003ccode\u003ekind\u003c/code\u003e property identifying the type as \u003ccode\u003eyoutube#groupItemListResponse\u003c/code\u003e, an \u003ccode\u003eetag\u003c/code\u003e, and an \u003ccode\u003eitems[]\u003c/code\u003e list containing the requested groupItem resources.\u003c/p\u003e\n"]]],["To retrieve group items, use a `GET` request to `https://youtubeanalytics.googleapis.com/v2/groupItems`. Authorization requires either the `https://www.googleapis.com/auth/youtube` or both `https://www.googleapis.com/auth/youtube.readonly` and `https://www.googleapis.com/auth/yt-analytics.readonly` scopes. The `groupId` parameter is required. The `onBehalfOfContentOwner` parameter is optional for content partners. The API returns a collection of group items; response properties include `kind`, `etag`, and a list of `items`. There is no request body.\n"],null,["# GroupItems: list\n\n**Important:** API requests to this method require access to either:\n\n- the `https://www.googleapis.com/auth/youtube` scope \n or\n- the `https://www.googleapis.com/auth/youtube.readonly` scope \n *and* \n the `https://www.googleapis.com/auth/yt-analytics.readonly` scope\n\nThe first option uses one scope, which happens to be a read-write scope, while the second option uses two read-only scopes.\nReturns a collection of group items that match the API request parameters.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://youtubeanalytics.googleapis.com/v2/groupItems\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| **Required parameters** |||\n| `groupId` | `string` The **id** parameter specifies the unique ID of the group for which you want to retrieve group items. |\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\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#groupItemListResponse\",\n \"#etag\": etag,\n \"#items[]\": [\n groupItem Resource\n ]\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#groupItemListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of items that the group contains. Each item in the list represents a [groupItem](/youtube/analytics/reference/groupItems) resource. |\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."]]
