YouTube Reporting API

Com a API YouTube Reporting, os desenvolvedores podem programar jobs de relatórios e baixar os relatórios em massa gerados. A API oferece suporte a um conjunto predefinido de relatórios, cada um deles com um conjunto abrangente de dados do YouTube Analytics para um canal ou proprietário de conteúdo.

As etapas abaixo explicam como programar jobs de relatórios e recuperar relatórios:

  1. Chame o método reportTypes.list() para recuperar uma lista de relatórios que um canal ou proprietário de conteúdo pode acessar.
  2. Chame o método jobs.create() para identificar um relatório que precisa ser gerado para um canal ou proprietário de conteúdo. Depois, use jobs.list() e jobs.delete() da API para recuperar ou mudar a lista de relatórios que estão sendo gerados.
  3. Chame o método jobs.reports.list() para recuperar uma lista de relatórios gerados para um job específico. Cada recurso na resposta contém uma propriedade downloadUrl que especifica o URL de onde o relatório pode ser baixado.
  4. Envie uma solicitação GET autorizada para recuperar o relatório do URL de download.

Autorização

Todas as solicitações da API YouTube Reporting 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 Reporting 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. Esse escopo dá acesso a métricas de atividade do usuário e a métricas estimadas de receita e performance de anúncios.

Tipos de recurso

As seções a seguir fornecem descrições gerais dos recursos e métodos da API. Todos os URIs de método mostrados nas tabelas são relativos a https://youtubereporting.googleapis.com.

jobs

Métodos
create POST /v1/jobs
Cria um job de geração de relatórios. Ao criar um job de relatório, você está instruindo o YouTube a gerar esse relatório diariamente. O relatório fica disponível em até 24 horas após a criação do job.
delete DELETE /v1/jobs/{jobId}
Exclui um job de relatório.
get GET /v1/jobs/{jobId}
Recupera informações sobre um job de geração de relatórios específico que foi programado para um canal ou proprietário do conteúdo.
list GET /v1/jobs
Lista os jobs de relatórios programados para um canal ou proprietário de conteúdo. Cada recurso na resposta contém uma propriedade id, que especifica o ID usado pelo YouTube para identificar o trabalho de forma exclusiva. Você precisa desse ID para recuperar a lista de relatórios gerados para o job ou para excluir o job.

jobs.reports

Métodos
get GET /v1/jobs/{jobId}/reports/{reportId}
Recupera os metadados de um relatório específico.
list GET /v1/jobs/{jobId}/reports
Lista os relatórios gerados para o job de relatórios especificado.

reportTypes

Métodos
list GET /v1/reportTypes
Retorna uma lista de tipos de relatórios que o canal ou proprietário do conteúdo pode recuperar.