API Reference

A API YouTube Analytics permite recuperar dados do YouTube Analytics de um canal ou proprietário do conteúdo do YouTube. A API é compatível com consultas em tempo real e gera um relatório com base nos parâmetros de solicitação da API.

A API oferece suporte a dois tipos de funções:

  • Recuperação de relatórios: o método reports.query da API recupera relatórios do YouTube Analytics.

  • Gerenciamento de grupos do YouTube Analytics: um grupo personalizado do YouTube Analytics é uma coleção personalizada de até 500 canais, vídeos, playlists ou recursos. A API é compatível com vários métodos para criar, recuperar e atualizar grupos do YouTube Analytics. Os proprietários de canal e conteúdo podem usar o método reports.query para recuperar dados agregados de todos os itens em um grupo, o que ajuda na análise de desempenho.

Esta página fornece uma breve visão geral dos recursos e métodos da API que permitem essas funções.

Autorização

Todas as solicitações da API YouTube Analytics precisam ser autorizadas. O Guia de autorização explica como usar o protocolo OAuth 2.0 para recuperar tokens de autorização.

As solicitações da API YouTube Analytics usam os seguintes escopos de 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.

Recuperação de relatórios

O método reports.query da API permite recuperar vários relatórios diferentes do YouTube Analytics. Cada solicitação usa parâmetros de consulta para especificar um ID do canal ou proprietário do conteúdo, uma data de início, uma data de término e pelo menos uma métrica. Também é possível fornecer parâmetros de consulta adicionais, como dimensões, filtros e instruções de classificação.

Método Solicitação HTTP Descrição
URIs relacionados a https://youtubeanalytics.googleapis.com/v2
query GET /reports Recupera um relatório do YouTube Analytics. Cada solicitação de API usa parâmetros de consulta para especificar um ID do canal ou proprietário do conteúdo, uma data de início, uma data de término e pelo menos uma métrica. Também é possível fornecer parâmetros de consulta adicionais, como dimensões, filtros ou instruções de classificação.
  • Métricas são medidas individuais de atividade do usuário, como exibições ou classificações de vídeo (gostei e não gostei).
  • Dimensões são critérios comuns usados ​​para dados agregados, como a data em que ocorreu a atividade do usuário ou o país em que os usuários estavam localizad. Em um relatório, cada linha de dados tem uma combinação única de valores de dimensão.
  • Filtros são valores de dimensões que especificam os dados que serão recuperados. Por exemplo, você pode recuperar dados de um país, um vídeo ou um grupo de vídeos específicos.
As listas de relatórios de canal e relatórios do proprietário do conteúdo compatíveis definem as combinações válidas de métricas, dimensões e filtros.

Gerenciamento de grupos

A API oferece dois recursos para criar e gerenciar grupos do YouTube Analytics:

Grupos

Um recurso group representa um grupo do YouTube Analytics, que é uma coleção personalizada de até 500 canais, vídeos, playlists ou recursos.

Todos os itens em um grupo precisam representar o mesmo tipo de recurso. Por exemplo, não é possível criar um grupo com 100 vídeos e 100 playlists.

Um grupo do Google Analytics só pode conter recursos que você enviou ou reivindicou ou que estão vinculados a um canal que você administra. Como resultado, os proprietários de canais podem criar grupos de vídeos e playlists. Os proprietários do conteúdo podem criar grupos de vídeos, playlists, canais ou recursos.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://youtubeanalytics.googleapis.com/v2
list GET /groups 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.
insert POST /groups Cria um grupo do YouTube Analytics. Depois de criar um grupo, use o método groupItems.insert para adicionar itens ao grupo.
update PUT /groups Modifica os metadados de um grupo. Atualmente, a única propriedade que pode ser atualizada é o título do grupo. Use groupItems.insert e groupItems.delete para adicionar e remover itens do grupo.
delete DELETE /groups Exclui um grupo.

Itens do grupo

Um recurso groupItem representa um item em um grupo do YouTube Analytics.

Para mais informações sobre este recurso, consulte sua representação de recurso e lista de propriedades.

Método Solicitação HTTP Descrição
URIs relacionados a https://youtubeanalytics.googleapis.com/v2
list GET /groupItems Retorna uma coleção de itens de grupo que correspondem aos parâmetros da solicitação de API.
insert POST /groupItems Cria um item do grupo.
delete DELETE /groupItems Remove um item de um grupo.