YouTube Reporting API

A API YouTube Reporting permite que os desenvolvedores programem jobs de relatórios e façam o download de relatórios em massa gerados. A API é compatível com um conjunto predefinido de relatórios, cada um contendo um conjunto abrangente de dados do YouTube Analytics para um canal ou proprietário do 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 do conteúdo pode recuperar.
  2. Chame o método jobs.create() para identificar um relatório que deve ser gerado para um canal ou proprietário do conteúdo. Em seguida, use os 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 que o relatório pode ser transferido por download.
  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. Este escopo fornece acesso às métricas de atividade do usuário e às métricas estimadas de receita e desempenho 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.

empregos

Métodos
create POST /v1/jobs
Cria um job de relatório. Ao criar um job de relatório, você instrui o YouTube a gerar o relatório diariamente. O relatório é disponibilizado em até 24 horas a partir do momento em que o job foi criado.
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 que foram programados para um canal ou proprietário do conteúdo. Cada recurso na resposta contém uma propriedade id, que especifica o ID que o YouTube usa para identificar o job de forma exclusiva. Esse ID é necessário para recuperar a lista de relatórios gerados para o job ou excluí-lo.

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 que foram gerados para o job de relatório especificado.

reportTypes

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