YouTube Reporting API - Data Model

Importante:i report API giornalieri e i report di backfill sono disponibili per 60 giorni a partire dal momento in cui vengono generati. I report sui dati storici sono disponibili per 30 giorni dal momento della loro generazione.

Queste norme si applicano a livello globale a tutti i report e a tutti i report e i relativi job. Per informazioni dettagliate, consulta la cronologia delle revisioni dell'API YouTube Reporting.

L'API di reporting di YouTube supporta i report predefiniti che contengono un set completo di dati di YouTube Analytics relativi a un canale o a un proprietario dei contenuti. Questi report ti consentono di scaricare i set di dati collettivi su cui puoi eseguire query con l'API YouTube Analytics o nella sezione Analytics di Creator Studio.

L'API supporta inoltre un insieme di report generati automaticamente e gestiti dal sistema disponibili per i proprietari dei contenuti che hanno accesso ai report corrispondenti nel menu Report. Questi report contengono i dati sulle entrate pubblicitarie e sui dati sulle entrate degli abbonamenti a YouTube Premium. Per ulteriori informazioni, consulta la documentazione relativa ai report gestiti dal sistema.

Panoramica

I campi di questi report sono caratterizzati come dimensioni o metriche:

  • Le dimensioni sono criteri comuni utilizzati per aggregare i dati, ad esempio la data in cui si è verificata un'azione o il paese in cui si trovavano gli utenti. In un report, ogni riga di dati ha una combinazione univoca di valori delle dimensioni.
  • Le metriche sono singole misurazioni relative all'attività utente, al rendimento degli annunci o alle entrate stimate. Le metriche relative all'attività utente includono, ad esempio, il numero di visualizzazioni e i voti (Mi piace e Non mi piace) dei video.

Ad esempio, il report sull'attività utente di base per i canali contiene le seguenti dimensioni:

  • day: la data in cui si è verificata l'attività.
  • channel: il canale YouTube associato all'attività.
  • video: il video di YouTube associato all'attività.
  • liveOrOnDemand: un valore che indica se gli spettatori stavano guardando uno stream video in diretta.
  • subscribedStatus: un valore che indica se gli spettatori sono stati iscritti al canale.
  • country: il paese in cui si trovavano gli spettatori.

Il report contiene anche molte metriche, come visualizzazioni, Mi piace e averageViewDuration. Dopo aver recuperato e importato il report, un'applicazione poteva eseguire molti calcoli diversi in base a valori delle dimensioni comuni.

Ad esempio, per calcolare il numero totale di visualizzazioni in Germania in una data specifica, somma i valori della metrica visualizzazioni per tutte le righe in cui il valore della colonna paese è DE e il valore della colonna giorno è la data in formato YYYY-MM-DD.

Recupero dei report di YouTube Analytics

I passaggi seguenti spiegano come recuperare i report sul canale e sul proprietario dei contenuti tramite l'API. Consulta la documentazione relativa ai report gestiti dal sistema per istruzioni su come recuperare questi report.

Passaggio 1: recupera le credenziali di autorizzazione

Tutte le richieste all'API di reporting di YouTube devono essere autorizzate. La guida all'autorizzazione spiega come utilizzare il protocollo OAuth 2.0 per recuperare i token di autorizzazione.

Le richieste all'API di reporting di YouTube utilizzano i seguenti ambiti di autorizzazione:

Ambiti
https://www.googleapis.com/auth/yt-analytics.readonly Visualizzare i report di YouTube Analytics per i tuoi contenuti di YouTube. Questo ambito fornisce l'accesso alle metriche relative all'attività degli utenti, come il numero di visualizzazioni e di valutazioni.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Visualizzare i report di YouTube Analytics relativi al valore monetario per i tuoi contenuti di YouTube. Questo ambito consente di accedere alle metriche dell'attività utente e alle metriche stimate relative al rendimento degli annunci e alle entrate.

Passaggio 2: identifica il report da recuperare

Chiama il metodo reportTypes.list dell'API per recuperare un elenco di report che possono essere generati per il canale o il proprietario dei contenuti. Il metodo restituisce un elenco di ID e nomi dei report. Acquisisci il valore della proprietà id per i report che vuoi generare. Ad esempio, l'ID del report sull'attività utente di base per i canali è channel_basic_a1.

Puoi trovare i nomi dei report anche nella documentazione che definisce i report sui canali supportati e i report sui proprietari dei contenuti.

Passaggio 3: crea un job di reporting

YouTube non inizia a generare il report finché non crei un'offerta di lavoro per il report in questione. Pertanto, i report vengono generati solo per i canali e i proprietari di contenuti che vogliono effettivamente recuperarli.

Per creare un job di reporting, chiama il metodo jobs.create dell'API. Imposta i seguenti valori nel corpo della richiesta:

  • Imposta il valore della proprietà reportTypeId sull'ID report recuperato nel passaggio 2.
  • Imposta il valore della proprietà name sul nome da associare al report.

La risposta dell'API al metodo jobs.create contiene una risorsa Job, che specifica ID che identifica in modo univoco il job. Puoi iniziare a recuperare il report entro 48 ore dalla creazione del job: il primo report disponibile sarà relativo al giorno in cui hai pianificato il job.

Ad esempio, se pianifichi un job il 1° settembre, il report per il 1° settembre sarà pronto il 3 settembre. Il report relativo al 2 settembre verrà pubblicato il 4 settembre e così via.

Passaggio 4: recupera l'ID job

Nota:se l'applicazione ha archiviato l'ID job restituito al passaggio 3, puoi saltare questo passaggio.

Chiama il metodo jobs.list per recuperare un elenco di job pianificati. La proprietà reportTypeId in ogni risorsa Job restituita identifica il tipo di report generato dal job. La tua applicazione richiede il valore della proprietà id dalla stessa risorsa nel seguente passaggio.

Passaggio 5: recupera l'URL di download del report

Chiama il metodo jobs.reports.list per recuperare un elenco dei report creati per il job. Nella richiesta, imposta il parametro jobId sull'ID job del report che vuoi recuperare.

Suggerimento:utilizza il parametro createdAfter per indicare che l'API deve restituire i report creati solo dopo un intervallo di tempo specificato. Questo parametro può essere utilizzato per garantire che l'API restituisca solo report non ancora elaborati.

La risposta dell'API contiene un elenco di risorse Report per il job. Ogni risorsa fa riferimento a un report contenente i dati relativi a un periodo unico di 24 ore. Tieni presente che YouTube genera report scaricabili per i giorni in cui non erano disponibili dati. Questi report contengono una riga di intestazione, ma non contengono dati aggiuntivi.

  • Le proprietà startTime e endTime della risorsa identificano il periodo di tempo interessato dai dati del report.
  • La proprietà downloadUrl della risorsa identifica l'URL da cui è possibile recuperare il report.
  • La proprietà createTime della risorsa specifica la data e l'ora in cui è stato generato il report. L'applicazione dovrebbe memorizzare questo valore e utilizzarlo per determinare se i report scaricati in precedenza sono cambiati.

Passaggio 6: scarica il report

Invia una richiesta HTTP GET al downloadUrl ottenuto nel passaggio 5 per recuperare il report.

Puoi ridurre la larghezza di banda necessaria per scaricare i report attivando la compressione gzip nelle richieste di download. Sebbene l'applicazione richieda più tempo di CPU per decomprimere le risposte dell'API, il vantaggio di consumare meno risorse di rete di solito supera questo costo.

Per ricevere una risposta con codifica gzip, imposta l'intestazione della richiesta HTTP Accept-Encoding su gzip, come mostrato nell'esempio seguente:

Accept-Encoding: gzip

Elaborazione dei report

Best practice

Le applicazioni che utilizzano l'API di reporting di YouTube devono seguire sempre queste pratiche:

  • Utilizza la riga di intestazione di un report per determinare l'ordine delle colonne. Ad esempio, non dare per scontato che il valore visualizzazioni sia la prima metrica restituita in un report solo perché è la prima metrica elencata in una descrizione di un report. Utilizza invece la riga di intestazione del report per determinare in quale colonna sono contenuti i dati.

  • Conserva una registrazione dei report scaricati per evitare di elaborare ripetutamente lo stesso report. Il seguente elenco suggerisce un paio di modi per farlo.

    • Quando chiami il metodo reports.list, utilizza il parametro createdAfter per recuperare solo i report creati dopo una determinata data. Ometti il parametro createdAfter la prima volta che recuperi i report.

      Ogni volta che recuperi ed elabora correttamente i report, memorizza il timestamp corrispondente a data e ora di creazione del report più recente. Successivamente, aggiorna il valore parametro createdAfter su ogni chiamata successiva al metodo reports.list per assicurarti di recuperare solo i nuovi report, inclusi i nuovi report con dati di backfill, ogni volta che chiami l'API.

      Per sicurezza, prima di recuperare un report, verifica anche che l'ID non sia già presente nel database.

    • Memorizza l'ID per ogni report che hai scaricato ed elaborato. Puoi anche memorizzare informazioni aggiuntive come la data e l'ora in cui è stato generato ogni report o i valori startTime e endTime del report, che insieme identificano il periodo per il quale il report contiene dati. Tieni presente che ogni job probabilmente avrà molti report, poiché ogni report contiene dati per un periodo di 24 ore.

      Utilizza l'ID report per identificare i report che devi ancora scaricare e importare. Tuttavia, se due nuovi report hanno gli stessi valori delle proprietà startTime e endTime, importa solo il report con il valore createTime più recente.

  • I report contengono ID associati alle risorse di YouTube e puoi utilizzare l'API di dati di YouTube per recuperare ulteriori metadati per queste risorse. Come stabilito nelle Norme per gli sviluppatori dei servizi API di YouTube (sezioni da III.E.4.b a III.E.4.d), i client API devono eliminare o aggiornare i metadati delle risorse archiviate dall'API dopo 30 giorni.

Caratteristiche del report

I report API sono file con controllo delle versioni .csv (valori separati da virgole) che hanno le seguenti caratteristiche:

  • Ciascun report contiene dati relativi a un periodo di 24 ore che dura dalle 00:00 alle 23:59 (fuso orario del Pacifico). Di conseguenza, in ogni report, il valore della dimensione giorno è sempre lo stesso.

  • I report vengono aggiornati quotidianamente.

  • YouTube genera report scaricabili per i giorni in cui non erano disponibili dati. Questi report conterranno una riga di intestazione, ma non dati aggiuntivi.

  • I report API sono disponibili per 60 giorni dal momento della loro generazione, ad eccezione dei dati storici generati per i nuovi job di generazione di report. Non è più possibile accedere ai report che risalgono a più di 60 giorni fa.
  • I report contenenti dati storici sono disponibili per 30 giorni a partire dal momento in cui vengono generati. I report contenenti dati storici non sono più accessibili dopo più di 30 giorni.
  • I dati del report non vengono filtrati. Pertanto, un report sui canali contiene tutti i dati relativi ai video o alle playlist di un canale, ad eccezione di quanto indicato nel paragrafo seguente relativo alle risorse eliminate. Analogamente, un report del proprietario dei contenuti contiene tutti i dati relativi ai canali del proprietario dei contenuti (video, playlist, rendimento degli annunci e così via) con la seguente eccezione.

    Sebbene i dati non vengano filtrati, i report non contengono riferimenti a risorse di YouTube eliminate almeno 30 giorni prima della data di generazione.

  • I dati del report non sono ordinati.

  • I report omettono le righe senza metriche. In altre parole, le righe che non contengono metriche vengono escluse dal report. Ad esempio, se un video non ha ricevuto visualizzazioni in Albania in un determinato giorno, il report per quel giorno non conterrà righe per l'Albania.

  • I report non contengono righe che forniscono dati di riepilogo per le metriche, come il numero totale di visualizzazioni per tutti i video di un canale. Puoi calcolare questi valori totali come somma dei valori nel report, ma questa somma potrebbe non includere le metriche relative ai video eliminati, come indicato sopra. Puoi anche utilizzare l'API YouTube Analytics per recuperare i conteggi totali. L'API YouTube Analytics restituisce valori totali che includono le metriche per le risorse eliminate, anche se queste non sono esplicitamente indicate nelle risposte dell'API.

Dati backfill

I dati di backfill si riferiscono a un set di dati che sostituisce un insieme pubblicato in precedenza. Quando è disponibile un report di dati di backfill, l'applicazione deve recuperare il nuovo report e aggiornare i dati archiviati in modo che corrispondano al set di dati rivisto. Ad esempio, l'applicazione potrebbe eliminare i dati precedenti relativi al periodo di tempo indicato nel report e poi importare il nuovo set di dati.

Se YouTube dispone di dati di backfill, genera un nuovo report con un nuovo ID report. In questo caso, i valori delle proprietà startTime e endTime del report corrisponderanno alle ore di inizio e di fine di un report precedentemente disponibile e che potresti aver scaricato in precedenza.

I report di backfill non contengono riferimenti a risorse di YouTube eliminate almeno 30 giorni prima della data di generazione del report.

Dati storici

Quando pianifichi un nuovo lavoro di generazione di report, YouTube genera report storici a partire da quel giorno e genera report relativi al periodo di 30 giorni precedente alla creazione del lavoro. Pertanto, in questa documentazione, con dati storici si fa riferimento a un report che contiene i dati relativi a un periodo di tempo precedente alla pianificazione del job di generazione dei report.

I report Storico vengono pubblicati non appena sono disponibili. In genere, tutti i dati storici vengono pubblicati per un'offerta di lavoro entro un paio di giorni. Come spiegato nella sezione Caratteristiche dei report, i report contenenti dati storici sono disponibili per 30 giorni a partire dal momento in cui vengono generati. I report che contengono dati non storici sono disponibili per 60 giorni.

Anonimizzazione dei dati

Per garantire l'anonimato degli spettatori di YouTube, i valori di alcune dimensioni vengono restituiti solo se una metrica nella stessa riga soddisfa una determinata soglia.

Ad esempio, nel report sulle sorgenti di traffico video per i canali, ogni riga contiene una serie di dimensioni, tra cui trafficSourceType e trafficSourceDetail. Ogni riga contiene inoltre varie metriche, tra cui le visualizzazioni. Nelle righe che descrivono il traffico proveniente da una ricerca di YouTube, la dimensione trafficSourceDetail identifica il termine di ricerca che ha generato traffico.

In questo esempio si applicano le seguenti regole:

  • Il report sulle sorgenti di traffico identifica il termine di query (trafficSourceDetail) solo se ha generato almeno un determinato numero di visualizzazioni di un determinato video in un determinato giorno. In questo caso, visualizzazioni è la metrica, video è la dimensione di aggregazione e trafficSourceDetail è la dimensione anonimizzata.

  • Il report include una riga aggiuntiva che aggrega le metriche per tutti i valori trafficSourceDetail che non soddisfano la soglia del numero di visualizzazioni. La riga indica il numero totale di visualizzazioni associate ai termini di query, ma non identifica i termini stessi.

Le seguenti tabelle illustrano queste regole. La prima tabella contiene un set ipotetico di dati non elaborati che YouTube userebbe per generare un report sulle sorgenti di traffico, mentre la seconda tabella contiene il report stesso. In questo esempio, la soglia del numero di visualizzazioni è pari a 10, il che significa che il report identifica un termine di ricerca solo se questo ha generato almeno 10 visualizzazioni di un determinato video in un determinato giorno. (Le soglie effettive sono soggette a modifiche).

Dati non elaborati sul traffico di ricerca di YouTube per un video

Supponiamo che i dati riportati di seguito descrivano il traffico di ricerca di YouTube verso un determinato video in un determinato giorno.

termine di ricerca di visualizzazioni stima dei minuti visualizzati
stile gangnam 100 200
psiche 15 25
psy gangnam 9 15
Oppa Gangnam 5 8
ballo di equitazione 2 5

Esempio di report sulle sorgenti di traffico

La seguente tabella mostra un estratto del report sulle sorgenti di traffico che YouTube avrebbe generato per i dati non elaborati nella sezione precedente. Il report effettivo contiene più dimensioni e metriche. In questo esempio, il report identifica i termini di ricerca solo se hanno generato almeno 10 visualizzazioni. Le soglie effettive sono soggette a modifiche.

Nella terza riga del report, il valore della dimensione trafficSourceDetail è NULL. Le metriche views e estimatedMinutesWatched contengono la combinazione delle visualizzazioni e dei minuti guardati per i tre termini di ricerca che hanno generato meno di 10 visualizzazioni.

trafficSourceDetail di visualizzazioni estimatedMinutesWatched
stile gangnam 100 200
psiche 15 25
NULL 16 28

Dimensioni soggette ad anonimizzazione

La seguente tabella identifica i valori delle dimensioni anonimizzati se i valori delle metriche associati non soddisfano una determinata soglia. In ogni caso, il valore della metrica viene aggregato rispetto a un'altra dimensione. Ad esempio, se la metrica è visualizzazioni e la dimensione di aggregazione è video, il valore della dimensione viene anonimizzato a meno che il video non sia stato visualizzato un determinato numero di volte.

Metrica Aggregazione delle dimensioni Dimensione anonimizzata Valore anonimizzato
subscribersGained channel country ZZ
subscribersGained channel province US-ZZ
subscribersLost channel country ZZ
subscribersLost channel province US-ZZ
commenti (video) country ZZ
commenti (video) province US-ZZ
Mi piace (video) country ZZ
Mi piace (video) province US-ZZ
Non mi piace (video) country ZZ
Non mi piace (video) province US-ZZ
visualizzazioni (video) ageGroup NULL
visualizzazioni (video) gender NULL
visualizzazioni video e trafficSourceDetail trafficSourceDetail NULL
Numero di iscritti al canale channel subscribedStatus NULL

Esempi di codice

I seguenti esempi di codice mostrano come utilizzare l'API per creare un job di reporting e quindi recuperare un report per quel job. Vengono forniti due esempi di codice per ogni lingua:

  1. Il primo esempio di codice mostra come recuperare un elenco dei tipi di report disponibili e quindi creare un nuovo job di reporting.

  2. Il secondo esempio di codice mostra come recuperare un report per un determinato job. Puoi iniziare a recuperare i report entro 48 ore dalla creazione del job.

Nota:i seguenti esempi di codice potrebbero non rappresentare tutti i linguaggi di programmazione supportati. Consulta la documentazione relativa alle librerie client per l'elenco dei linguaggi supportati.

Java

I seguenti esempi utilizzano la libreria client Java:

Esempio 1: creare un job di reporting

Il seguente esempio di codice chiama il metodo reportTypes.list per recuperare un elenco dei tipi di report disponibili. Quindi chiama il metodo jobs.create per creare un nuovo job di reporting.

/*
 * 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;
    }
}

Esempio 2: recupero di un report

L'esempio di codice chiama il metodo jobs.list per recuperare un elenco di job di reporting. Quindi chiama il metodo reports.list con il parametro jobId impostato su uno specifico ID job per recuperare i report creati dal job. Infine, nell'esempio viene stampato l'URL di download di ogni report.

/*
 * 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

Gli esempi riportati di seguito utilizzano la libreria client PHP.

Esempio 1: creare un job di reporting

Il seguente esempio di codice chiama il metodo reportTypes.list per recuperare un elenco dei tipi di report disponibili. Quindi chiama il metodo jobs.create per creare un nuovo job di reporting.

<?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>

Esempio 2: recupero di un report

L'esempio di codice chiama il metodo jobs.list per recuperare un elenco di job di reporting. Quindi chiama il metodo reports.list con il parametro jobId impostato su uno specifico ID job per recuperare i report creati dal job. Infine, nell'esempio viene stampato l'URL di download di ogni report.

<?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

Gli esempi riportati di seguito utilizzano la libreria client Python.

Esempio 1: creare un job di reporting

Il seguente esempio di codice chiama il metodo reportTypes.list per recuperare un elenco dei tipi di report disponibili. Quindi chiama il metodo jobs.create per creare un nuovo job di reporting.

#!/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)

Esempio 2: recupero di un report

L'esempio di codice chiama il metodo jobs.list per recuperare un elenco di job di reporting. Quindi chiama il metodo reports.list con il parametro jobId impostato su uno specifico ID job per recuperare i report creati dal job. Infine, nell'esempio viene stampato l'URL di download di ogni report.

#!/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)