Groups: list

Retorna uma lista de grupos que correspondem aos parâmetros da solicitação de API. Por exemplo, é possível recuperar todos os grupos do usuário autenticado ou um ou mais grupos usando os 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. 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
Filtros (especifique exatamente um dos seguintes parâmetros)
id string
O parâmetro id especifica uma lista separada por vírgulas dos IDs do grupo do YouTube para os recursos que estiverem sendo recuperados. Cada grupo precisa pertencer ao 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 corretamente. Defina o valor deste 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 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.
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

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

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
Lista de grupos que correspondem aos parâmetros de solicitação da API. Cada item da 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 mensagem de erro.

Confira!

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