GroupItems: insert
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Solicitação
Solicitação HTTP
POST 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. 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 |
| 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
Forneça um recurso groupItem no corpo da solicitação.
Para esse recurso, é necessário especificar um valor para as seguintes propriedades.
Resposta
Se o item for inserido, esse método vai retornar um recurso groupItem no corpo da resposta.
Se o item especificado na solicitação já tiver sido incluído no grupo antes da solicitação, esse método vai retornar um código de resposta HTTP 204 (No Content).
Erros
A tabela abaixo identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para este método. Consulte a documentação mensagem de erro para mais detalhes.
| Tipo de erro |
Detalhe do erro |
Descrição |
forbidden (403) |
groupContainsMaximumNumberOfItems |
O grupo já contém o número máximo de itens permitidos. |
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 endpoint allows you to create a new group item within YouTube Analytics.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using specific scopes, including options for both content owners and channel owners.\u003c/p\u003e\n"],["\u003cp\u003eThe request must include a groupItem resource in the body, specifying the \u003ccode\u003egroupId\u003c/code\u003e and \u003ccode\u003eresource.id\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eA successful insertion of the item returns a groupItem resource, and attempting to add a pre-existing item returns a \u003ccode\u003e204\u003c/code\u003e HTTP code.\u003c/p\u003e\n"],["\u003cp\u003eThe API will return a \u003ccode\u003e403\u003c/code\u003e error if the group has reached its maximum item capacity.\u003c/p\u003e\n"]]],["This documentation details the process of creating a group item via a `POST` request to the YouTube Analytics API (`/groupItems`). Authorization requires specific scopes, including `yt-analytics.readonly`, `yt-analytics-monetary.readonly`, `youtube`, or `youtubepartner`. The request body must include a `groupItem` resource, specifying `groupId` and `resource.id`. Content owners can use `onBehalfOfContentOwner` to authenticate for multiple channels. Successful creation returns the `groupItem` resource; a duplicate returns a `204` status. A `403` error occurs when the maximum number of items is reached.\n"],null,["# GroupItems: insert\n\nCreates a group item.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST 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| **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\nProvide a [groupItem resource](/youtube/analytics/reference/groupItems#resource) in the request body.\nFor that resource, you must specify a value for the following properties.\n\n\u003cbr /\u003e\n\n- `groupId`\n- `resource.id`\n\n\u003cbr /\u003e\n\nResponse\n--------\n\nIf the item is successfully inserted, this method returns a [groupItem resource](/youtube/analytics/reference/groupItems#resource) in the response body.\n\nIf the item specified in the request had already been included in the group before the request was made, this method returns an HTTP `204` response code (`No Content`).\n\nErrors\n------\n\nThe table below identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/analytics/reference/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|-------------------|-------------------------------------|-----------------------------------------------------------------|\n| `forbidden (403)` | `groupContainsMaximumNumberOfItems` | The group already contains the maximum allowed number of items. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
