Essa política se aplica globalmente a todos os relatórios e trabalhos de relatórios. Para ver todos os detalhes, consulte o histórico de revisões da API YouTube Reporting.
A API YouTube Reporting é compatível com relatórios predefinidos que contêm um conjunto abrangente de dados do YouTube Analytics sobre um canal ou proprietário do conteúdo. Com esses relatórios, você pode fazer o download dos conjuntos de dados em massa que podem ser consultados com a API YouTube Analytics ou na seção Analytics do Estúdio de Criação.
A API também oferece suporte a um conjunto de relatórios gerados automaticamente e gerenciados pelo sistema, que estão disponíveis para proprietários de conteúdo com acesso aos relatórios correspondentes no menu "Relatórios". Esses relatórios contêm dados de receita de anúncios e de assinatura do YouTube Premium. Consulte a documentação sobre relatórios gerenciados pelo sistema para mais informações.
Visão geral
Os campos dos relatórios são caracterizados como dimensões ou métricas:
- As dimensões são critérios comuns usados para agregar dados, como a data em que uma ação ocorreu ou o país onde os usuários estavam localizados. Em um relatório, cada linha de dados tem uma combinação exclusiva de valores de dimensão.
- As métricas são medições individuais relacionadas à atividade do usuário, ao desempenho do anúncio ou à receita estimada. As métricas de atividade do usuário incluem itens como contagens de visualizações de vídeo e classificações (marcações "gostei" e "não gostei").
Por exemplo, o relatório básico de atividade do usuário para canais contém as seguintes dimensões:
- day: a data em que a atividade ocorreu.
- channel: é o canal do YouTube associado à atividade.
- video: é o vídeo do YouTube associado à atividade.
- liveOrOnDemand: um valor que indica se os espectadores estavam assistindo a um stream de vídeo ao vivo.
- subscribedStatus: um valor que indica se os espectadores estavam inscritos no canal.
- country: o país onde os espectadores estavam localizados.
O relatório também contém muitas métricas, como visualizações, marcações com "Gostei" e duração média da visualização. Depois de recuperar e importar o relatório, um aplicativo poderia fazer muitos cálculos diferentes com base em valores de dimensões comuns.
Por exemplo, para calcular o número total de visualizações na Alemanha em uma data específica, some os valores da métrica visualizações em todas as linhas em que o valor da coluna país é DE e o valor da coluna dia é a data no formato YYYY-MM-DD.
Recuperar relatórios do YouTube Analytics
As etapas a seguir explicam como recuperar relatórios de canal e do proprietário do conteúdo por meio da API. Para instruções sobre como recuperar esses relatórios, consulte Relatórios gerenciados pelo sistema.
Etapa 1: extrair credenciais de autorização
Todas as solicitações da API YouTube Reporting precisam ser autorizadas. Para recuperar tokens de autorização pelo protocolo OAuth 2.0, consulte o guia 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 às métricas de atividade do usuário e às métricas de receita estimada e performance do anúncio. |
Etapa 2: identificar o relatório a ser recuperado
Chame o método reportTypes.list da API para recuperar uma lista de relatórios que podem ser gerados para o canal ou proprietário de conteúdo. O método retorna uma lista de IDs e nomes de relatórios. Capture o valor da propriedade id para os relatórios que você quer gerar. Por exemplo, o ID do relatório básico de atividade do usuário para canais é channel_basic_a1.
Você também pode encontrar os nomes dos relatórios na documentação que define os relatórios de canal e de proprietários de conteúdo compatíveis.
Etapa 3: criar um job de relatório
O YouTube não começa a gerar seu relatório até que você crie um trabalho de relatório para ele. Dessa forma, os relatórios são gerados apenas para os canais e proprietários de conteúdo que realmente querem recuperá-los.
Para criar um job de relatórios, chame o método jobs.create da API. Defina os seguintes valores no corpo da solicitação:
- Defina o valor da propriedade
reportTypeIdcomo o ID do relatório que você recuperou na etapa 2. - Defina o valor da propriedade
namecomo o nome que você quer associar ao relatório.
A resposta da API para o método jobs.create contém um recurso Job, que especifica o ID que identifica exclusivamente o job. Você pode começar a extrair o relatório até 48 horas após a criação do job, e o primeiro relatório disponível será referente ao dia em que você programou o job.
Por exemplo, se você programar um job para 1o de setembro, o relatório de 1o de setembro estará pronto no dia 3 de setembro. O relatório de 2 de setembro será postado no dia 4 de setembro.
Etapa 4: recuperar o ID do job
Observação: se o aplicativo armazenou o ID do job retornado na etapa 3, pule esta etapa.
Chame o método jobs.list para recuperar uma lista de jobs programados. A propriedade reportTypeId em cada recurso Job retornado identifica o tipo de relatório gerado pelo job. Seu aplicativo precisa do valor da propriedade id do mesmo recurso na etapa a seguir.
Etapa 5: recuperar o URL de download do relatório
Chame o método jobs.reports.list para recuperar uma lista de relatórios criados para o job. Na solicitação, defina o parâmetro jobId como o ID do job do relatório que você quer recuperar.
Dica:use o parâmetro createdAfter para indicar que a API só vai retornar relatórios criados após um período especificado. Esse parâmetro pode ser usado para garantir que a API mostre somente relatórios que você ainda não processou.
A resposta da API contém uma lista de recursos Report para esse job. Cada recurso se refere a um relatório que contém dados de um período exclusivo de 24 horas. O YouTube gera relatórios para download para os dias em que não há dados disponíveis. Esses relatórios têm uma linha de título, mas não contêm dados adicionais.
- As propriedades
startTimeeendTimedo recurso identificam o período que os dados do relatório abrangem. - A propriedade
downloadUrldo recurso identifica o URL em que o relatório pode ser buscado. - A propriedade
createTimedo recurso especifica a data e a hora em que o relatório foi gerado. Seu aplicativo deve armazenar esse valor e usá-lo para determinar se os relatórios baixados anteriormente foram alterados.
Etapa 6: faça o download do relatório
Envie uma solicitação HTTP GET para o downloadUrl encontrado na etapa 5 para recuperar o relatório.
É possível reduzir a largura de banda necessária para fazer o download de relatórios ativando a compactação gzip nas solicitações de download. Embora seu aplicativo precise de mais tempo de CPU para descompactar as respostas da API, a vantagem de consumir menos recursos da rede geralmente supera esse custo.
Para receber uma resposta codificada em gzip, defina o cabeçalho da solicitação HTTP Accept-Encoding como gzip, conforme mostrado no exemplo a seguir:
Accept-Encoding: gzip
Processando relatórios
Práticas recomendadas
Os aplicativos que usam a API YouTube Reporting precisam sempre seguir estas práticas:
-
Para determinar a ordem das colunas do relatório, use a linha de cabeçalho do relatório. Por exemplo, não presuma que as visualizações serão a primeira métrica retornada em um relatório só porque é a primeira métrica listada na descrição do relatório. Em vez disso, use a linha de cabeçalho do relatório para determinar qual coluna contém esses dados.
-
Para evitar o processamento repetido do mesmo relatório, mantenha um registro dos relatórios que você baixou. A lista a seguir sugere algumas maneiras de fazer isso.
-
Ao chamar o método
reports.list, use o parâmetro createdAfter para recuperar apenas relatórios criados após uma determinada data. Omita o parâmetrocreatedAfterna primeira vez que você recuperar relatórios.Sempre que você extrair e processar relatórios, armazene a marcação de tempo correspondente à data e hora em que o mais recente deles foi criado. Em seguida, atualize o valor do parâmetro
createdAfterem cada chamada sucessiva para o métodoreports.listpara garantir que você esteja recuperando apenas novos relatórios, incluindo novos relatórios com dados preenchidos, toda vez que chamar a API.Por segurança, antes de recuperar um relatório, verifique também se o ID dele já não está listado no seu banco de dados.
-
Armazene o ID de cada relatório que você fez o download e processou. Também é possível armazenar outras informações, como a data e a hora em que cada relatório foi gerado ou o
startTimee oendTimedo relatório, que juntos identificam o período em que o relatório contém dados. Cada job provavelmente terá vários relatórios, já que cada um deles contém dados de um período de 24 horas.Use o ID do relatório para identificar os relatórios que você ainda precisa fazer o download e importar. No entanto, se dois novos relatórios tiverem os mesmos valores de propriedade
startTimeeendTime, importe somente o relatório com o valorcreateTimemais recente.
-
-
Os relatórios contêm IDs associados a recursos do YouTube. Para recuperar outros metadados desses recursos, use a API YouTube Data. Conforme observado nas Políticas do desenvolvedor de serviços da API YouTube (seções III.E.4.b a III.E.4.d), os clientes da API precisam excluir ou atualizar os metadados de recursos armazenados dessa API após 30 dias.
Características do relatório
Os relatórios de API são arquivos .csv (valores separados por vírgulas) com versão que têm as seguintes características:
-
Cada relatório contém dados de um período de 24 horas, que vai das 12h às 23h59 (Horário Padrão do Pacífico, UTC-8). Dessa forma, em qualquer relatório, o valor da dimensão day é sempre o mesmo.
-
Os relatórios são atualizados diariamente.
-
O YouTube gera relatórios para download para os dias em que não há dados disponíveis. Esses relatórios vão conter uma linha de cabeçalho, mas não vão ter dados adicionais.
- Os relatórios da API ficam disponíveis por 60 dias a partir do momento em que são gerados, exceto os dados históricos gerados para novos jobs de relatório. Os relatórios ficam inacessíveis após 60 dias.
- Os relatórios com dados históricos ficam disponíveis por 30 dias a partir do momento em que são gerados. Os relatórios que contêm dados históricos ficam inacessíveis após 30 dias.
-
Os dados do relatório não são filtrados. Assim, um relatório de canal contém todos os dados dos vídeos ou das playlists de um canal, com a exceção descrita no parágrafo a seguir relacionado a recursos excluídos. Da mesma forma, um relatório do proprietário de conteúdo contém todos os dados dos canais dele (vídeos, playlists, performance de anúncios etc.), com a seguinte exceção.
Embora os dados do relatório não sejam filtrados, os relatórios não contêm referências aos recursos do YouTube que foram excluídos pelo menos 30 dias antes da data em que foram gerados.
-
Os dados do relatório não estão classificados.
-
Os relatórios omitem linhas que não têm métricas. Em outras palavras, as linhas que não têm métricas são excluídas do relatório. Por exemplo, se um vídeo não tiver visualizações na Albânia em determinado dia, o relatório desse dia não terá linhas para a Albânia.
-
Os relatórios não contêm linhas que fornecem dados resumidos de métricas, como o número total de visualizações de todos os vídeos de um canal. É possível calcular esses valores totais como a soma dos valores no relatório, mas essa soma pode não incluir métricas de vídeos excluídos, conforme observado acima. Também é possível usar a API YouTube Analytics para extrair o total de contagem. A API YouTube Analytics retorna valores totais que incluem métricas para recursos excluídos, mesmo que esses recursos não sejam referenciados explicitamente nas respostas da API.
Preencher dados
Os dados de preenchimento referem-se a um conjunto de dados que substitui um conjunto entregue anteriormente. Quando um relatório de dados de preenchimento estiver disponível, o aplicativo vai extrair o novo relatório e atualizar os dados armazenados para corresponder ao conjunto de dados revisado. Por exemplo, o aplicativo pode excluir os dados anteriores do período coberto pelo relatório e importar o novo conjunto de dados.
Se o YouTube tiver dados de preenchimento, ele vai gerar um novo relatório com um novo ID de relatório. Nesse caso, os valores das propriedades startTime e endTime do relatório vão corresponder aos horários de início e término de um relatório que estava disponível anteriormente e que você pode ter feito o download.
Os relatórios de preenchimento não contêm referências a recursos do YouTube excluídos pelo menos 30 dias antes da data de geração do relatório.
Dados históricos
Quando você programa um novo trabalho de geração de relatórios, o YouTube gera relatórios históricos a partir daquele dia e que abrangem o período de 30 dias antes do momento em que você criou o trabalho. Portanto, nesta documentação, os dados históricos se referem a um relatório que contém dados de um período anterior à programação do job de geração de relatórios.
Os relatórios históricos são postados assim que ficam disponíveis. Normalmente, todos os dados históricos de uma vaga são postados em alguns dias. Conforme explicado na seção Características do relatório, os relatórios que contêm dados históricos ficam disponíveis por 30 dias a partir do momento em que são gerados. Os relatórios que contêm dados não históricos ficam disponíveis por 60 dias.
Anonimização de dados
Para garantir o anonimato dos espectadores do YouTube, os valores de algumas dimensões serão retornados somente se uma métrica na mesma linha atingir um determinado limite.
Por exemplo, no relatório de origem do tráfego de vídeo para canais, cada linha contém várias dimensões, incluindo trafficSourceType e trafficSourceDetail. Cada linha também contém várias métricas, incluindo visualizações. Nas linhas que descrevem o tráfego originado de uma pesquisa do YouTube, a dimensão trafficSourceDetail identifica o termo de pesquisa que gerou o tráfego.
Neste exemplo, aplicam-se as seguintes regras:
-
O relatório de origem de tráfego identificará o termo de consulta (trafficSourceDetail) somente se ele tiver gerado pelo menos um certo número de visualizações de um vídeo específico em um dia específico. Nesse caso, views é a métrica, video é a dimensão de agregação e trafficSourceDetail é a dimensão anônima.
-
O relatório inclui uma linha adicional que agrega métricas para todos os valores de trafficSourceDetail que não atingem o limite de contagem de visualizações. Essa linha informa o número total de visualizações associadas a esses termos de consulta, mas não identifica os termos em si.
As tabelas a seguir ilustram essas regras. A primeira tabela contém um conjunto hipotético de dados brutos que o YouTube usaria para gerar um relatório de origem do tráfego, e a segunda contém o relatório em si. Neste exemplo, o limite de contagem de visualizações é 10, ou seja, o relatório só identifica um termo de pesquisa se ele gerou pelo menos 10 visualizações de um vídeo específico em um dia específico. Os limites reais estão sujeitos a alterações.
Dados brutos de tráfego de pesquisa do YouTube para um vídeo
Suponha que os dados abaixo descrevam o tráfego de pesquisa do YouTube para um determinado vídeo em um dia específico.
| termo de pesquisa | visualizações | estimativa de minutos assistidos |
|---|---|---|
| estilo gangnam | 100 | 200 |
| psy | 15 | 25 |
| psy gangnam | 9 | 15 |
| oppa gangnam | 5 | 8 |
| dança de equitação | 2 | 5 |
Exemplo de relatório de origem do tráfego
A tabela a seguir mostra um trecho do relatório de origem de tráfego que o YouTube geraria para os dados brutos da seção anterior. O relatório real vai conter mais dimensões e métricas. Neste exemplo, o relatório identifica os termos de pesquisa somente se eles geraram pelo menos 10 visualizações. Os limites reais estão sujeitos a alterações.
Na terceira linha do relatório, o valor da dimensão trafficSourceDetail é NULL. As métricas views e estimatedMinutesWatched contêm as visualizações combinadas e os minutos assistidos dos três termos de pesquisa que geraram menos de 10 visualizações.
| trafficSourceDetail | visualizações | estimatedMinutesWatched |
|---|---|---|
| Gangnam Style | 100 | 200 |
| psy | 15 | 25 |
| NULL | 16 | 28 |
Dimensões sujeitas a anonimização
A tabela a seguir identifica os valores de dimensão que são anonimizados se os valores de métrica associados não atenderem a um determinado limite. Em cada caso, o valor da métrica é agregado em outra dimensão. Por exemplo, se a métrica for visualizações e a dimensão de agregação for vídeo, o valor da dimensão vai ser anônimo, a menos que o vídeo tenha sido visualizado um determinado número de vezes.
| Métrica | Agregação de dimensões | Dimensão anônima | Valor anonimizado |
|---|---|---|---|
| subscribersGained | channel | country | ZZ |
| subscribersGained | channel | province | US-ZZ |
| subscribersLost | channel | country | ZZ |
| subscribersLost | channel | province | US-ZZ |
| comments | vídeo | country | ZZ |
| comments | vídeo | province | US-ZZ |
| curtidas | vídeo | country | ZZ |
| marcações "Gostei" | vídeo | province | US-ZZ |
| não gostei | vídeo | country | ZZ |
| não gosta | vídeo | province | US-ZZ |
| visualizações | vídeo | ageGroup | NULL |
| visualizações | vídeo | gender [gênero] | NULL |
| visualizações | video e trafficSourceDetail | trafficSourceDetail | NULL |
| Número de inscritos no canal | channel | subscribedStatus | NULL |
Amostras de código
Os exemplos de código a seguir demonstram como usar a API para criar um trabalho de relatórios e, em seguida, recuperar um relatório para esse trabalho. Há dois exemplos de código para cada linguagem:
-
O primeiro exemplo de código mostra como recuperar uma lista de tipos de relatórios disponíveis e criar um novo job de relatórios.
-
O segundo exemplo de código mostra como recuperar o relatório de um trabalho específico. É possível começar a recuperar relatórios em até 48 horas a partir do momento em que o job é criado.
Observação:os exemplos de código a seguir podem não representar todas as linguagens de programação compatíveis. Para conferir a lista de idiomas compatíveis, consulte bibliotecas de cliente.
Java
Os seguintes exemplos usam a biblioteca de cliente Java:
Exemplo 1: criar um job de geração de relatórios
O exemplo de código a seguir chama o método reportTypes.list para recuperar uma lista de tipos de relatório disponíveis. Em seguida, ele chama o método jobs.create para criar um novo job de relatórios.
/*
* Copyright (c) 2015 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.services.samples.youtube.cmdline.reporting;
import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListReportTypesResponse;
import com.google.api.services.youtubereporting.model.ReportType;
import com.google.common.collect.Lists;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;
/**
* This sample creates a reporting job by:
*
* 1. Listing the available report types using the "reportTypes.list" method.
* 2. Creating a reporting job using the "jobs.create" method.
*
* @author Ibrahim Ulukaya
*/
public class CreateReportingJob {
/**
* Define a global instance of a YouTube Reporting object, which will be used to make
* YouTube Reporting API requests.
*/
private static YouTubeReporting youtubeReporting;
/**
* Create a reporting job.
*
* @param args command line args (not used).
*/
public static void main(String[] args) {
/*
* This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
* authenticated user's account. Any request that retrieves earnings or ad performance metrics must
* use this scope.
*/
List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");
try {
// Authorize the request.
Credential credential = Auth.authorize(scopes, "createreportingjob");
// This object is used to make YouTube Reporting API requests.
youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
.setApplicationName("youtube-cmdline-createreportingjob-sample").build();
// Prompt the user to specify the name of the job to be created.
String name = getNameFromUser();
if (listReportTypes()) {
createReportingJob(getReportTypeIdFromUser(), name);
}
} catch (GoogleJsonResponseException e) {
System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
+ " : " + e.getDetails().getMessage());
e.printStackTrace();
} catch (IOException e) {
System.err.println("IOException: " + e.getMessage());
e.printStackTrace();
} catch (Throwable t) {
System.err.println("Throwable: " + t.getMessage());
t.printStackTrace();
}
}
/**
* Lists report types. (reportTypes.listReportTypes)
* @return true if at least one report type exists
* @throws IOException
*/
private static boolean listReportTypes() throws IOException {
// Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
ListReportTypesResponse reportTypesListResponse = youtubeReporting.reportTypes().list()
.execute();
List<ReportType> reportTypeList = reportTypesListResponse.getReportTypes();
if (reportTypeList == null || reportTypeList.isEmpty()) {
System.out.println("No report types found.");
return false;
} else {
// Print information from the API response.
System.out.println("\n================== Report Types ==================\n");
for (ReportType reportType : reportTypeList) {
System.out.println(" - Id: " + reportType.getId());
System.out.println(" - Name: " + reportType.getName());
System.out.println("\n-------------------------------------------------------------\n");
}
}
return true;
}
/**
* Creates a reporting job. (jobs.create)
*
* @param reportTypeId Id of the job's report type.
* @param name name of the job.
* @throws IOException
*/
private static void createReportingJob(String reportTypeId, String name)
throws IOException {
// Create a reporting job with a name and a report type id.
Job job = new Job();
job.setReportTypeId(reportTypeId);
job.setName(name);
// Call the YouTube Reporting API's jobs.create method to create a job.
Job createdJob = youtubeReporting.jobs().create(job).execute();
// Print information from the API response.
System.out.println("\n================== Created reporting job ==================\n");
System.out.println(" - ID: " + createdJob.getId());
System.out.println(" - Name: " + createdJob.getName());
System.out.println(" - Report Type Id: " + createdJob.getReportTypeId());
System.out.println(" - Create Time: " + createdJob.getCreateTime());
System.out.println("\n-------------------------------------------------------------\n");
}
/*
* Prompt the user to enter a name for the job. Then return the name.
*/
private static String getNameFromUser() throws IOException {
String name = "";
System.out.print("Please enter the name for the job [javaTestJob]: ");
BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
name = bReader.readLine();
if (name.length() < 1) {
// If nothing is entered, defaults to "javaTestJob".
name = "javaTestJob";
}
System.out.println("You chose " + name + " as the name for the job.");
return name;
}
/*
* Prompt the user to enter a report type id for the job. Then return the id.
*/
private static String getReportTypeIdFromUser() throws IOException {
String id = "";
System.out.print("Please enter the reportTypeId for the job: ");
BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
id = bReader.readLine();
System.out.println("You chose " + id + " as the report type Id for the job.");
return id;
}
}
Exemplo 2: recuperar um relatório
O exemplo de código chama o método jobs.list para recuperar uma lista de jobs de relatórios. Em seguida, ele chama o método reports.list com o parâmetro jobId definido como um ID de job específico para extrair relatórios criados por esse job. Por fim, o exemplo mostra o URL de download de cada relatório.
/*
* Copyright (c) 2015 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.services.samples.youtube.cmdline.reporting;
import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.GenericUrl;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.YouTubeReporting.Media.Download;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListJobsResponse;
import com.google.api.services.youtubereporting.model.ListReportsResponse;
import com.google.api.services.youtubereporting.model.Report;
import com.google.common.collect.Lists;
import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;
import javax.print.attribute.standard.Media;
/**
* This sample retrieves reports created by a specific job by:
*
* 1. Listing the jobs using the "jobs.list" method.
* 2. Retrieving reports using the "reports.list" method.
*
* @author Ibrahim Ulukaya
*/
public class RetrieveReports {
/**
* Define a global instance of a YouTube Reporting object, which will be used to make
* YouTube Reporting API requests.
*/
private static YouTubeReporting youtubeReporting;
/**
* Retrieve reports.
*
* @param args command line args (not used).
*/
public static void main(String[] args) {
/*
* This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
* authenticated user's account. Any request that retrieves earnings or ad performance metrics must
* use this scope.
*/
List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");
try {
// Authorize the request.
Credential credential = Auth.authorize(scopes, "retrievereports");
// This object is used to make YouTube Reporting API requests.
youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
.setApplicationName("youtube-cmdline-retrievereports-sample").build();
if (listReportingJobs()) {
if(retrieveReports(getJobIdFromUser())) {
downloadReport(getReportUrlFromUser());
}
}
} catch (GoogleJsonResponseException e) {
System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
+ " : " + e.getDetails().getMessage());
e.printStackTrace();
} catch (IOException e) {
System.err.println("IOException: " + e.getMessage());
e.printStackTrace();
} catch (Throwable t) {
System.err.println("Throwable: " + t.getMessage());
t.printStackTrace();
}
}
/**
* Lists reporting jobs. (jobs.listJobs)
* @return true if at least one reporting job exists
* @throws IOException
*/
private static boolean listReportingJobs() throws IOException {
// Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
ListJobsResponse jobsListResponse = youtubeReporting.jobs().list().execute();
List<Job> jobsList = jobsListResponse.getJobs();
if (jobsList == null || jobsList.isEmpty()) {
System.out.println("No jobs found.");
return false;
} else {
// Print information from the API response.
System.out.println("\n================== Reporting Jobs ==================\n");
for (Job job : jobsList) {
System.out.println(" - Id: " + job.getId());
System.out.println(" - Name: " + job.getName());
System.out.println(" - Report Type Id: " + job.getReportTypeId());
System.out.println("\n-------------------------------------------------------------\n");
}
}
return true;
}
/**
* Lists reports created by a specific job. (reports.listJobsReports)
*
* @param jobId The ID of the job.
* @throws IOException
*/
private static boolean retrieveReports(String jobId)
throws IOException {
// Call the YouTube Reporting API's reports.list method
// to retrieve reports created by a job.
ListReportsResponse reportsListResponse = youtubeReporting.jobs().reports().list(jobId).execute();
List<Report> reportslist = reportsListResponse.getReports();
if (reportslist == null || reportslist.isEmpty()) {
System.out.println("No reports found.");
return false;
} else {
// Print information from the API response.
System.out.println("\n============= Reports for the job " + jobId + " =============\n");
for (Report report : reportslist) {
System.out.println(" - Id: " + report.getId());
System.out.println(" - From: " + report.getStartTime());
System.out.println(" - To: " + report.getEndTime());
System.out.println(" - Download Url: " + report.getDownloadUrl());
System.out.println("\n-------------------------------------------------------------\n");
}
}
return true;
}
/**
* Download the report specified by the URL. (media.download)
*
* @param reportUrl The URL of the report to be downloaded.
* @throws IOException
*/
private static boolean downloadReport(String reportUrl)
throws IOException {
// Call the YouTube Reporting API's media.download method to download a report.
Download request = youtubeReporting.media().download("");
FileOutputStream fop = new FileOutputStream(new File("report"));
request.getMediaHttpDownloader().download(new GenericUrl(reportUrl), fop);
return true;
}
/*
* Prompt the user to enter a job id for report retrieval. Then return the id.
*/
private static String getJobIdFromUser() throws IOException {
String id = "";
System.out.print("Please enter the job id for the report retrieval: ");
BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
id = bReader.readLine();
System.out.println("You chose " + id + " as the job Id for the report retrieval.");
return id;
}
/*
* Prompt the user to enter a URL for report download. Then return the URL.
*/
private static String getReportUrlFromUser() throws IOException {
String url = "";
System.out.print("Please enter the report URL to download: ");
BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
url = bReader.readLine();
System.out.println("You chose " + url + " as the URL to download.");
return url;
}}
PHP
Os exemplos a seguir usam a biblioteca de cliente do PHP.
Exemplo 1: criar um job de geração de relatórios
O exemplo de código a seguir chama o método reportTypes.list para recuperar uma lista de tipos de relatório disponíveis. Em seguida, ele chama o método jobs.create para criar um novo job de relatórios.
<?php
/**
* This sample creates a reporting job by:
*
* 1. Listing the available report types using the "reportTypes.list" method.
* 2. Creating a reporting job using the "jobs.create" method.
*
* @author Ibrahim Ulukaya
*/
/**
* Library Requirements
*
* 1. Install composer (https://getcomposer.org)
* 2. On the command line, change to this directory (api-samples/php)
* 3. Require the google/apiclient library
* $ composer require google/apiclient:~2.0
*/
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
throw new \Exception('please run "composer require google/apiclient:~2.0" in "' . __DIR__ .'"');
}
require_once __DIR__ . '/vendor/autoload.php';
session_start();
/*
* You can acquire an OAuth 2.0 client ID and client secret from the
* {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
* For more information about using OAuth 2.0 to access Google APIs, please see:
* <https://developers.google.com/youtube/v3/guides/authentication>
* Please ensure that you have enabled the YouTube Data API for your project.
*/
$OAUTH2_CLIENT_ID = 'REPLACE_ME';
$OAUTH2_CLIENT_SECRET = 'REPLACE_ME';
$client = new Google_Client();
$client->setClientId($OAUTH2_CLIENT_ID);
$client->setClientSecret($OAUTH2_CLIENT_SECRET);
/*
* This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
* authenticated user's account. Any request that retrieves earnings or ad performance metrics must
* use this scope.
*/
$client->setScopes('https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$redirect = filter_var('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'],
FILTER_SANITIZE_URL);
$client->setRedirectUri($redirect);
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);
// Check if an auth token exists for the required scopes
$tokenSessionKey = 'token-' . $client->prepareScopes();
if (isset($_GET['code'])) {
if (strval($_SESSION['state']) !== strval($_GET['state'])) {
die('The session state did not match.');
}
$client->authenticate($_GET['code']);
$_SESSION[$tokenSessionKey] = $client->getAccessToken();
header('Location: ' . $redirect);
}
if (isset($_SESSION[$tokenSessionKey])) {
$client->setAccessToken($_SESSION[$tokenSessionKey]);
}
// Check to ensure that the access token was successfully acquired.
if ($client->getAccessToken()) {
// This code executes if the user enters a name in the form
// and submits the form. Otherwise, the page displays the form above.
try {
if (empty(listReportTypes($youtubeReporting, $htmlBody))) {
$htmlBody .= sprintf('<p>No report types found.</p>');
} else if ($_GET['reportTypeId']){
createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody);
}
} catch (Google_Service_Exception $e) {
$htmlBody = sprintf('<p>A service error occurred: <code>%s</code></p>',
htmlspecialchars($e->getMessage()));
} catch (Google_Exception $e) {
$htmlBody = sprintf('<p>An client error occurred: <code>%s</code></p>',
htmlspecialchars($e->getMessage()));
}
$_SESSION[$tokenSessionKey] = $client->getAccessToken();
} elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') {
$htmlBody = <<<END
<h3>Client Credentials Required</h3>
<p>
You need to set <code>\$OAUTH2_CLIENT_ID</code> and
<code>\$OAUTH2_CLIENT_ID</code> before proceeding.
<p>
END;
} else {
// If the user hasn't authorized the app, initiate the OAuth flow
$state = mt_rand();
$client->setState($state);
$_SESSION['state'] = $state;
$authUrl = $client->createAuthUrl();
$htmlBody = <<<END
<h3>Authorization Required</h3>
<p>You need to <a href="$authUrl">authorize access</a> before proceeding.<p>
END;
}
/**
* Creates a reporting job. (jobs.create)
*
* @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
* @param string $reportTypeId Id of the job's report type.
* @param string $name name of the job.
* @param $htmlBody - html body.
*/
function createReportingJob(Google_Service_YouTubeReporting $youtubeReporting, $reportTypeId,
$name, &$htmlBody) {
# Create a reporting job with a name and a report type id.
$reportingJob = new Google_Service_YouTubeReporting_Job();
$reportingJob->setReportTypeId($reportTypeId);
$reportingJob->setName($name);
// Call the YouTube Reporting API's jobs.create method to create a job.
$jobCreateResponse = $youtubeReporting->jobs->create($reportingJob);
$htmlBody .= "<h2>Created reporting job</h2><ul>";
$htmlBody .= sprintf('<li>"%s" for reporting type "%s" at "%s"</li>',
$jobCreateResponse['name'], $jobCreateResponse['reportTypeId'], $jobCreateResponse['createTime']);
$htmlBody .= '</ul>';
}
/**
* Returns a list of report types. (reportTypes.listReportTypes)
*
* @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
* @param $htmlBody - html body.
*/
function listReportTypes(Google_Service_YouTubeReporting $youtubeReporting, &$htmlBody) {
// Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
$reportTypes = $youtubeReporting->reportTypes->listReportTypes();
$htmlBody .= "<h3>Report Types</h3><ul>";
foreach ($reportTypes as $reportType) {
$htmlBody .= sprintf('<li>id: "%s", name: "%s"</li>', $reportType['id'], $reportType['name']);
}
$htmlBody .= '</ul>';
return $reportTypes;
}
?>
<!doctype html>
<html>
<head>
<title>Create a reporting job</title>
</head>
<body>
<form method="GET">
<div>
Job Name: <input type="text" id="jobName" name="jobName" placeholder="Enter Job Name">
</div>
<br>
<div>
Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id">
</div>
<br>
<input type="submit" value="Create!">
</form>
<?=$htmlBody?>
</body>
</html>
Exemplo 2: recuperar um relatório
O exemplo de código chama o método jobs.list para extrair uma lista de jobs de relatórios. Em seguida, ele chama o método reports.list com o parâmetro jobId definido para um ID de tarefa específico para recuperar os relatórios criados por essa tarefa. Por fim, o exemplo mostra o URL de download de cada relatório.
<?php
/**
* This sample supports the following use cases:
*
* 1. Retrieve reporting jobs by content owner:
* Ex: php retrieve_reports.php --contentOwner=="CONTENT_OWNER_ID"
* Ex: php retrieve_reports.php --contentOwner=="CONTENT_OWNER_ID" --includeSystemManaged==True
* 2. Retrieving list of downloadable reports for a particular job:
* Ex: php retrieve_reports.php --contentOwner=="CONTENT_OWNER_ID" --jobId="JOB_ID"
* 3. Download a report:
* Ex: php retrieve_reports.php --contentOwner=="CONTENT_OWNER_ID" --downloadUrl="DOWNLOAD_URL" --outputFile="report.txt"
*/
/**
* Library Requirements
*
* 1. Install composer (https://getcomposer.org)
* 2. On the command line, change to this directory (api-samples/php)
* 3. Require the google/apiclient library
* $ composer require google/apiclient:~2.0
*/
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
throw new \Exception('please run "composer require google/apiclient:~2.2.0" in "' . __DIR__ .'"');
}
require_once __DIR__ . '/vendor/autoload.php';
session_start();
define('CREDENTIALS_PATH', '~/.credentials/youtube-php.json');
$longOptions = array(
'contentOwner::',
'downloadUrl::',
'includeSystemManaged::',
'jobId::',
'outputFile::',
);
$options = getopt('', $longOptions);
$CONTENT_OWNER_ID = ($options['contentOwner'] ? $options['contentOwner'] : '');
$DOWNLOAD_URL = (array_key_exists('downloadUrl', $options) ?
$options['downloadUrl'] : '');
$INCLUDE_SYSTEM_MANAGED = (array_key_exists('includeSystemManaged', $options) ?
$options['includeSystemManaged'] : '');
$JOB_ID = (array_key_exists('jobId', $options) ? $options['jobId'] : '');
$OUTPUT_FILE = (array_key_exists('outputFile', $options) ?
$options['outputFile'] : '');
/*
* You can obtain an OAuth 2.0 client ID and client secret from the
* {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
* For more information about using OAuth 2.0 to access Google APIs, please see:
* <https://developers.google.com/youtube/v3/guides/authentication>
* Please ensure that you have enabled the YouTube Data API for your project.
*/
function getClient() {
$client = new Google_Client();
$client->setAuthConfigFile('client_secrets_php.json');
$client->addScope(
'https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$client->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
$client->setAccessType('offline');
// Load previously authorized credentials from a file.
$credentialsPath = expandHomeDirectory(CREDENTIALS_PATH);
if (file_exists($credentialsPath)) {
$accessToken = json_decode(file_get_contents($credentialsPath), true);
} else {
// Request authorization from the user.
$authUrl = $client->createAuthUrl();
printf('Open the following link in your browser:\n%s\n', $authUrl);
print 'Enter verification code: ';
$authCode = trim(fgets(STDIN));
// Exchange authorization code for an access token.
$accessToken = $client->authenticate($authCode);
$refreshToken = $client->getRefreshToken();
// Store the credentials to disk.
if(!file_exists(dirname($credentialsPath))) {
mkdir(dirname($credentialsPath), 0700, true);
}
file_put_contents($credentialsPath, json_encode($accessToken));
printf('Credentials saved to %s\n', $credentialsPath);
//fclose($fp);
}
$client->setAccessToken($accessToken);
// Refresh the token if it's expired.
if ($client->isAccessTokenExpired()) {
$client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
file_put_contents($credentialsPath, json_encode($client->getAccessToken()));
}
return $client;
}
/**
* Expands the home directory alias '~' to the full path.
* @param string $path the path to expand.
* @return string the expanded path.
*/
function expandHomeDirectory($path) {
$homeDirectory = getenv('HOME');
if (empty($homeDirectory)) {
$homeDirectory = getenv('HOMEDRIVE') . getenv('HOMEPATH');
}
return str_replace('~', realpath($homeDirectory), $path);
}
/**
* Returns a list of reporting jobs. (jobs.listJobs)
*
* @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
* @param string $onBehalfOfContentOwner A content owner ID.
*/
function listReportingJobs(Google_Service_YouTubeReporting $youtubeReporting,
$onBehalfOfContentOwner = '', $includeSystemManaged = False) {
$reportingJobs = $youtubeReporting->jobs->listJobs(
array('onBehalfOfContentOwner' => $onBehalfOfContentOwner,
'includeSystemManaged' => $includeSystemManaged));
print ('REPORTING JOBS' . PHP_EOL . '**************' . PHP_EOL);
foreach ($reportingJobs as $job) {
print($job['reportTypeId'] . ':' . $job['id'] . PHP_EOL);
}
print(PHP_EOL);
}
/**
* Lists reports created by a specific job. (reports.listJobsReports)
*
* @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
* @param string $jobId The ID of the job.
* @param string $onBehalfOfContentOwner A content owner ID.
*/
function listReportsForJob(Google_Service_YouTubeReporting $youtubeReporting,
$jobId, $onBehalfOfContentOwner = '') {
$reports = $youtubeReporting->jobs_reports->listJobsReports($jobId,
array('onBehalfOfContentOwner' => $onBehalfOfContentOwner));
print ('DOWNLOADABLE REPORTS' . PHP_EOL . '********************' . PHP_EOL);
foreach ($reports['reports'] as $report) {
print('Created: ' . date('d M Y', strtotime($report['createTime'])) .
' (' . date('d M Y', strtotime($report['startTime'])) .
' to ' . date('d M Y', strtotime($report['endTime'])) . ')' .
PHP_EOL . ' ' . $report['downloadUrl'] . PHP_EOL . PHP_EOL);
}
}
/**
* Download the report specified by the URL. (media.download)
*
* @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
* @param string $reportUrl The URL of the report to be downloaded.
* @param string $outputFile The file to write the report to locally.
* @param $htmlBody - html body.
*/
function downloadReport(Google_Service_YouTubeReporting $youtubeReporting,
$reportUrl, $outputFile) {
$client = $youtubeReporting->getClient();
// Setting the defer flag to true tells the client to return a request that
// can be called with ->execute(); instead of making the API call immediately.
$client->setDefer(true);
// Call YouTube Reporting API's media.download method to download a report.
$request = $youtubeReporting->media->download('', array('alt' => 'media'));
$request = $request->withUri(new \GuzzleHttp\Psr7\Uri($reportUrl));
$responseBody = '';
try {
$response = $client->execute($request);
$responseBody = $response->getBody();
} catch (Google_Service_Exception $e) {
$responseBody = $e->getTrace()[0]['args'][0]->getResponseBody();
}
file_put_contents($outputFile, $responseBody);
$client->setDefer(false);
}
// Define an object that will be used to make all API requests.
$client = getClient();
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);
if ($CONTENT_OWNER_ID) {
if (!$DOWNLOAD_URL && !$JOB_ID) {
listReportingJobs($youtubeReporting, $CONTENT_OWNER_ID,
$INCLUDE_SYSTEM_MANAGED);
} else if ($JOB_ID) {
listReportsForJob($youtubeReporting, $JOB_ID, $CONTENT_OWNER_ID);
} else if ($DOWNLOAD_URL && $OUTPUT_FILE) {
downloadReport($youtubeReporting, $DOWNLOAD_URL, $OUTPUT_FILE);
}
}
?>
Python
Os exemplos a seguir usam a biblioteca de cliente Python.
Exemplo 1: criar um job de relatório
O exemplo de código a seguir chama o método reportTypes.list para recuperar uma lista de tipos de relatório disponíveis. Em seguida, ele chama o método jobs.create para criar um novo job de relatórios.
#!/usr/bin/python
# Create a reporting job for the authenticated user's channel or
# for a content owner that the user's account is linked to.
# Usage example:
# python create_reporting_job.py --name='<name>'
# python create_reporting_job.py --content-owner='<CONTENT OWNER ID>'
# python create_reporting_job.py --content-owner='<CONTENT_OWNER_ID>' --report-type='<REPORT_TYPE_ID>' --name='<REPORT_NAME>'
import argparse
import os
import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from google_auth_oauthlib.flow import InstalledAppFlow
# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
# https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
# https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'
# This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
# authenticated user's account. Any request that retrieves earnings or ad performance metrics must
# use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'
# Authorize the request and store authorization credentials.
def get_authenticated_service():
flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
credentials = flow.run_console()
return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)
# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
good_kwargs = {}
if kwargs is not None:
for key, value in kwargs.iteritems():
if value:
good_kwargs[key] = value
return good_kwargs
# Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
def list_report_types(youtube_reporting, **kwargs):
# Provide keyword arguments that have values as request parameters.
kwargs = remove_empty_kwargs(**kwargs)
results = youtube_reporting.reportTypes().list(**kwargs).execute()
reportTypes = results['reportTypes']
if 'reportTypes' in results and results['reportTypes']:
reportTypes = results['reportTypes']
for reportType in reportTypes:
print 'Report type id: %s\n name: %s\n' % (reportType['id'], reportType['name'])
else:
print 'No report types found'
return False
return True
# Call the YouTube Reporting API's jobs.create method to create a job.
def create_reporting_job(youtube_reporting, report_type_id, **kwargs):
# Provide keyword arguments that have values as request parameters.
kwargs = remove_empty_kwargs(**kwargs)
reporting_job = youtube_reporting.jobs().create(
body=dict(
reportTypeId=args.report_type,
name=args.name
),
**kwargs
).execute()
print ('Reporting job "%s" created for reporting type "%s" at "%s"'
% (reporting_job['name'], reporting_job['reportTypeId'],
reporting_job['createTime']))
# Prompt the user to enter a report type id for the job. Then return the id.
def get_report_type_id_from_user():
report_type_id = raw_input('Please enter the reportTypeId for the job: ')
print ('You chose "%s" as the report type Id for the job.' % report_type_id)
return report_type_id
# Prompt the user to set a job name
def prompt_user_to_set_job_name():
job_name = raw_input('Please set a name for the job: ')
print ('Great! "%s" is a memorable name for this job.' % job_name)
return job_name
if __name__ == '__main__':
parser = argparse.ArgumentParser()
# The 'name' option specifies the name that will be used for the reporting job.
parser.add_argument('--content-owner', default='',
help='ID of content owner for which you are retrieving jobs and reports.')
parser.add_argument('--include-system-managed', default=False,
help='Whether the API response should include system-managed reports')
parser.add_argument('--name', default='',
help='Name for the reporting job. The script prompts you to set a name ' +
'for the job if you do not provide one using this argument.')
parser.add_argument('--report-type', default=None,
help='The type of report for which you are creating a job.')
args = parser.parse_args()
youtube_reporting = get_authenticated_service()
try:
# Prompt user to select report type if they didn't set one on command line.
if not args.report_type:
if list_report_types(youtube_reporting,
onBehalfOfContentOwner=args.content_owner,
includeSystemManaged=args.include_system_managed):
args.report_type = get_report_type_id_from_user()
# Prompt user to set job name if not set on command line.
if not args.name:
args.name = prompt_user_to_set_job_name()
# Create the job.
if args.report_type:
create_reporting_job(youtube_reporting,
args,
onBehalfOfContentOwner=args.content_owner)
except HttpError, e:
print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
Exemplo 2: recuperar um relatório
O exemplo de código chama o método jobs.list para extrair uma lista de jobs de relatórios. Em seguida, ele chama o método reports.list com o parâmetro jobId definido como um ID de job específico para extrair relatórios criados por esse job. Por fim, o exemplo mostra o URL de download de cada relatório.
#!/usr/bin/python
###
#
# This script retrieves YouTube Reporting API reports. Use cases:
# 1. If you specify a report URL, the script downloads that report.
# 2. Otherwise, if you specify a job ID, the script retrieves a list of
# available reports for that job and prompts you to select a report.
# Then it retrieves that report as in case 1.
# 3. Otherwise, the list retrieves a list of jobs for the user or,
# if specified, the content owner that the user is acting on behalf of.
# Then it prompts the user to select a job, and then executes case 2 and
# then case 1.
# Usage examples:
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --job_id=<JOB_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --report_url=<REPORT_URL> --local_file=<LOCAL_FILE>
#
###
import argparse
import os
import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload
from google_auth_oauthlib.flow import InstalledAppFlow
from io import FileIO
# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
# https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
# https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'
# This OAuth 2.0 access scope allows for read access to YouTube Analytics
# monetary reports for the authenticated user's account. Any request that
# retrieves earnings or ad performance metrics must use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'
# Authorize the request and store authorization credentials.
def get_authenticated_service():
flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
credentials = flow.run_console()
return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)
# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
good_kwargs = {}
if kwargs is not None:
for key, value in kwargs.iteritems():
if value:
good_kwargs[key] = value
return good_kwargs
# Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
def list_reporting_jobs(youtube_reporting, **kwargs):
# Only include the onBehalfOfContentOwner keyword argument if the user
# set a value for the --content_owner argument.
kwargs = remove_empty_kwargs(**kwargs)
# Retrieve the reporting jobs for the user (or content owner).
results = youtube_reporting.jobs().list(**kwargs).execute()
if 'jobs' in results and results['jobs']:
jobs = results['jobs']
for job in jobs:
print ('Reporting job id: %s\n name: %s\n for reporting type: %s\n'
% (job['id'], job['name'], job['reportTypeId']))
else:
print 'No jobs found'
return False
return True
# Call the YouTube Reporting API's reports.list method to retrieve reports created by a job.
def retrieve_reports(youtube_reporting, **kwargs):
# Only include the onBehalfOfContentOwner keyword argument if the user
# set a value for the --content_owner argument.
kwargs = remove_empty_kwargs(**kwargs)
# Retrieve available reports for the selected job.
results = youtube_reporting.jobs().reports().list(
**kwargs
).execute()
if 'reports' in results and results['reports']:
reports = results['reports']
for report in reports:
print ('Report dates: %s to %s\n download URL: %s\n'
% (report['startTime'], report['endTime'], report['downloadUrl']))
# Call the YouTube Reporting API's media.download method to download the report.
def download_report(youtube_reporting, report_url, local_file):
request = youtube_reporting.media().download(
resourceName=' '
)
request.uri = report_url
fh = FileIO(local_file, mode='wb')
# Stream/download the report in a single request.
downloader = MediaIoBaseDownload(fh, request, chunksize=-1)
done = False
while done is False:
status, done = downloader.next_chunk()
if status:
print 'Download %d%%.' % int(status.progress() * 100)
print 'Download Complete!'
# Prompt the user to select a job and return the specified ID.
def get_job_id_from_user():
job_id = raw_input('Please enter the job id for the report retrieval: ')
print ('You chose "%s" as the job Id for the report retrieval.' % job_id)
return job_id
# Prompt the user to select a report URL and return the specified URL.
def get_report_url_from_user():
report_url = raw_input('Please enter the report URL to download: ')
print ('You chose "%s" to download.' % report_url)
return report_url
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('--content_owner', default='',
help='ID of content owner for which you are retrieving jobs and reports')
parser.add_argument('--job_id', default=None,
help='ID of the job for which you are retrieving reports. If not ' +
'provided AND report_url is also not provided, then the script ' +
'calls jobs.list() to retrieve a list of jobs.')
parser.add_argument('--report_url', default=None,
help='URL of the report to retrieve. If not specified, the script ' +
'calls reports.list() to retrieve a list of reports for the ' +
'selected job.')
parser.add_argument('--local_file', default='yt_report.txt',
help='The name of the local file where the downloaded report will be written.')
args = parser.parse_args()
youtube_reporting = get_authenticated_service()
try:
# If the user has not specified a job ID or report URL, retrieve a list
# of available jobs and prompt the user to select one.
if not args.job_id and not args.report_url:
if list_reporting_jobs(youtube_reporting,
onBehalfOfContentOwner=args.content_owner):
args.job_id = get_job_id_from_user()
# If the user has not specified a report URL, retrieve a list of reports
# available for the specified job and prompt the user to select one.
if args.job_id and not args.report_url:
retrieve_reports(youtube_reporting,
jobId=args.job_id,
onBehalfOfContentOwner=args.content_owner)
args.report_url = get_report_url_from_user()
# Download the selected report.
if args.report_url:
download_report(youtube_reporting, args.report_url, args.local_file)
except HttpError, e:
print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)