GroupItems: list

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 por sua vez é um escopo de leitura/gravação, e a segunda usa dois escopos somente leitura.

Retorna uma coleção de itens de grupo que correspondem aos parâmetros da solicitação de 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 às métricas estimadas de receita e 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 grupos do YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Veja e gerencie os recursos e o conteúdo associado no YouTube. Na API YouTube Analytics, os proprietários de conteúdo usam esse escopo para gerenciar grupos e itens de grupos 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 itens do grupo.
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 têm e gerenciam muitos 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 de autenticação do usuário 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 de itens que o grupo contém. 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 mensagem de erro.

Confira!

Use o APIs Explorer para chamar a API e ver a solicitação e a resposta da API.