YouTube Reporting API - Get Bulk Data Reports

Wichtig:Tägliche API-Berichte und Backfill-Berichte sind 60 Tage lang verfügbar, nachdem sie generiert wurden. Berichte mit Verlaufsdaten sind 30 Tage lang verfügbar, nachdem sie generiert wurden.

Diese Richtlinie gilt weltweit für alle Berichte und Berichtsaufträge. Ausführliche Informationen findest du im Überarbeitungsverlauf der YouTube Reporting API.

Die YouTube Reporting API unterstützt vordefinierte Berichte, die umfassende YouTube Analytics-Daten für einen Kanal oder Rechteinhaber enthalten. Über diese Berichte kannst du die Bulk-Datensätze herunterladen, die du mit der YouTube Analytics API oder im Bereich Analysen in YouTube Studio abfragen kannst.

Die API unterstützt auch eine Reihe automatisch generierter, systemverwalteter Berichte, die für Rechteinhaber verfügbar sind, die im Menü „Berichte“ Zugriff auf die entsprechenden Berichte haben. Diese Berichte enthalten Daten zu Werbeeinnahmen und zu Einnahmen aus YouTube Premium-Abos. Weitere Informationen finden Sie in der Dokumentation zu systemverwalteten Berichten.

Übersicht

Berichtsfelder in diesen Berichten werden als Dimensionen oder Messwerte klassifiziert:

  • Dimensionen sind gängige Kriterien, mit denen Daten zusammengefasst werden, z. B. das Datum, an dem eine Aktion stattgefunden hat, oder das Land, in dem sich die Nutzer befanden. In einem Bericht enthält jede Datenzeile eine eindeutige Kombination von Dimensionswerten.
  • Messwerte sind einzelne Messungen im Zusammenhang mit Nutzeraktivitäten, Anzeigenleistung oder geschätztem Umsatz. Zu den Messwerten für Nutzeraktivitäten gehören unter anderem die Anzahl der Videoaufrufe und Bewertungen (Mag ich- und Mag ich nicht-Bewertungen).

Der grundlegende Bericht zur Nutzeraktivität für Kanäle enthält beispielsweise die folgenden Dimensionen:

  • day: Das Datum, an dem die Aktivität stattfand.
  • channel: Der YouTube-Kanal, der mit der Aktivität verknüpft ist.
  • video: Das YouTube-Video, das mit der Aktivität verknüpft ist.
  • liveOrOnDemand: Gibt an, ob sich die Zuschauer einen Live-Videostream angesehen haben.
  • subscribedStatus: Gibt an, ob die Zuschauer den Kanal abonniert haben.
  • country: Das Land, in dem sich die Zuschauer befinden.

Der Bericht enthält außerdem viele Messwerte wie Aufrufe, „Mag ich“-Bewertungen und averageViewDuration. Nach dem Abrufen und Importieren des Berichts kann eine Anwendung viele verschiedene Berechnungen basierend auf gängigen Dimensionswerten ausführen.

Wenn Sie beispielsweise die Gesamtzahl der Aufrufe in Deutschland an einem bestimmten Datum berechnen möchten, summieren Sie die Messwertwerte für Aufrufe für alle Zeilen, in denen der Spaltenwert Land DE und der Spaltenwert Tag das Datum im Format YYYY-MM-DD ist.

YouTube Analytics-Berichte abrufen

In den folgenden Schritten wird beschrieben, wie du Berichte zu Kanälen und Rechteinhabern über die API abrufen kannst. Eine Anleitung zum Abrufen dieser Berichte finden Sie unter Systemverwaltete Berichte.

Schritt 1: Autorisierungsanmeldedaten abrufen

Alle YouTube Reporting API-Anfragen müssen autorisiert sein. Informationen zum Abrufen von Autorisierungstokens über das OAuth 2.0-Protokoll finden Sie im Autorisierungsleitfaden.

Für Anfragen an die YouTube Reporting API werden die folgenden Autorisierungsbereiche verwendet:

Ebenen
https://www.googleapis.com/auth/yt-analytics.readonly YouTube Analytics-Berichte für deine YouTube-Inhalte abrufen Dieser Bereich bietet Zugriff auf Messwerte zur Nutzeraktivität, z. B. die Anzahl der Aufrufe und Bewertungen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube Analytics-Finanzberichte für deine YouTube-Inhalte abrufen Diese Zugriffsebene bietet Zugriff auf Messwerte zu Nutzeraktivitäten sowie auf geschätzte Umsatz- und Anzeigenleistungsmesswerte.

Schritt 2: Bericht auswählen, der abgerufen werden soll

Rufe die reportTypes.list-Methode der API auf, um eine Liste der Berichte abzurufen, die für den Kanal oder Rechteinhaber generiert werden können. Die Methode gibt eine Liste mit Berichts-IDs und ‑namen zurück. Erfassen Sie den Property-Wert id für die Berichte, die Sie generieren möchten. Die ID des grundlegenden Berichts zur Nutzeraktivität für Kanäle lautet beispielsweise channel_basic_a1.

Die Namen der Berichte finden Sie auch in der Dokumentation zu unterstützten Kanalberichten und Berichten für Rechteinhaber.

Schritt 3: Berichtsjob erstellen

YouTube beginnt erst mit der Erstellung des Berichts, wenn du einen Berichterstellungsjob dafür erstellst. Daher werden Berichte nur für die Kanäle und Rechteinhaber generiert, die sie abrufen möchten.

Rufen Sie die Methode jobs.create der API auf, um einen Berichtsjob zu erstellen. Legen Sie im Anfragetext die folgenden Werte fest:

  • Legen Sie für die Property reportTypeId den Wert der Berichts-ID fest, die Sie in Schritt 2 abgerufen haben.
  • Legen Sie den Wert der Property name auf den Namen fest, den Sie dem Bericht zuordnen möchten.

Die API-Antwort auf die jobs.create-Methode enthält eine Job-Ressource, die die ID angibt, mit der der Job eindeutig identifiziert wird. Sie können den Bericht innerhalb von 48 Stunden nach dem Erstellen des Jobs abrufen. Der erste verfügbare Bericht bezieht sich auf den Tag, an dem Sie den Job geplant haben.

Wenn Sie beispielsweise einen Job am 1. September planen, ist der Bericht für den 1. September am 3. September verfügbar. Der Bericht für den 2. September wird am 4. September veröffentlicht.

Schritt 4: Job-ID abrufen

Hinweis:Wenn Ihre Anwendung die in Schritt 3 zurückgegebene Job-ID gespeichert hat, können Sie diesen Schritt überspringen.

Rufen Sie die Methode jobs.list auf, um eine Liste der geplanten Jobs abzurufen. Die Eigenschaft reportTypeId in jeder zurückgegebenen Job-Ressource gibt den Berichtstyp an, der von diesem Job generiert wird. Ihre Anwendung benötigt im nächsten Schritt den Attributwert id aus derselben Ressource.

Schritt 5: Download-URL des Berichts abrufen

Rufen Sie die Methode jobs.reports.list auf, um eine Liste der für den Job erstellten Berichte abzurufen. Legen Sie in der Anfrage den Parameter jobId auf die Job-ID des Berichts fest, den Sie abrufen möchten.

Tipp:Mit dem Parameter createdAfter können Sie angeben, dass die API nur Berichte zurückgeben soll, die nach einem bestimmten Zeitpunkt erstellt wurden. Mit diesem Parameter können Sie dafür sorgen, dass die API nur Berichte zurückgibt, die Sie noch nicht verarbeitet haben.

Die API-Antwort enthält eine Liste der Report-Ressourcen für diesen Job. Jede Ressource bezieht sich auf einen Bericht, der Daten für einen bestimmten 24-Stunden-Zeitraum enthält. Für Tage, an denen keine Daten verfügbar waren, werden von YouTube aber trotzdem Berichte generiert, die heruntergeladen werden können. Diese Berichte enthalten eine Kopfzeile, aber keine zusätzlichen Daten.

  • Die Eigenschaften startTime und endTime der Ressource geben den Zeitraum an, für den die Daten des Berichts gelten.
  • Die downloadUrl-Property der Ressource gibt die URL an, über die der Bericht abgerufen werden kann.
  • Mit der createTime-Eigenschaft der Ressource wird das Datum und die Uhrzeit angegeben, zu der der Bericht generiert wurde. Ihre Anwendung sollte diesen Wert speichern und anhand dieses Werts feststellen, ob sich zuvor heruntergeladene Berichte geändert haben.

Schritt 6: Bericht herunterladen

Senden Sie eine HTTP-GET-Anfrage an die in Schritt 5 ermittelte downloadUrl, um den Bericht abzurufen.

Sie können die für den Download von Berichten benötigte Bandbreite reduzieren, indem Sie die GZIP-Komprimierung für Downloadanfragen aktivieren. Ihre Anwendung benötigt zwar zusätzliche CPU-Zeit, um API-Antworten zu dekomprimieren, aber der Vorteil, weniger Netzwerkressourcen zu verbrauchen, überwiegt in der Regel diese Kosten.

Wenn Sie eine gzip-codierte Antwort erhalten möchten, legen Sie den Accept-Encoding-HTTP-Anfrageheader auf gzip fest, wie im folgenden Beispiel gezeigt:

Accept-Encoding: gzip

Verarbeitung von Berichten

Best Practices

Bei Anwendungen, die die YouTube Reporting API verwenden, sollten immer die folgenden Praktiken befolgt werden:

  • Die Reihenfolge der Spalten im Bericht wird über die Kopfzeile des Berichts festgelegt. Angenommen, Aufrufe ist der erste Messwert, der in einem Bericht zurückgegeben wird, weil er in der Berichtsbeschreibung als erster Messwert aufgeführt ist. Sehen Sie stattdessen in der Kopfzeile des Berichts nach, welche Spalte diese Daten enthält.

  • Notieren Sie sich die heruntergeladenen Berichte, damit derselbe Bericht nicht mehrmals verarbeitet wird. In der folgenden Liste finden Sie einige Möglichkeiten.

    • Verwenden Sie beim Aufrufen der Methode reports.list den Parameter createdAfter, um nur Berichte abzurufen, die nach einem bestimmten Datum erstellt wurden. Lassen Sie den Parameter createdAfter beim ersten Abrufen von Berichten weg.

      Speichern Sie jedes Mal, wenn Sie Berichte abrufen und erfolgreich verarbeiten, den Zeitstempel, der dem Datum und der Uhrzeit entspricht, zu dem der neueste dieser Berichte erstellt wurde. Aktualisieren Sie dann den Parameterwert createdAfter bei jedem nachfolgenden Aufruf der Methode reports.list, damit bei jedem API-Aufruf nur neue Berichte abgerufen werden, einschließlich neuer Berichte mit nachgetragenen Daten.

      Prüfen Sie vor dem Abrufen eines Berichts als Sicherheitsmaßnahme, ob die ID des Berichts bereits in Ihrer Datenbank aufgeführt ist.

    • Speichern Sie die ID für jeden Bericht, den Sie heruntergeladen und verarbeitet haben. Sie können auch zusätzliche Informationen wie das Datum und die Uhrzeit speichern, zu der der jeweilige Bericht generiert wurde, oder den startTime und endTime des Berichts, die zusammen den Zeitraum angeben, für den der Bericht Daten enthält. Jeder Job enthält wahrscheinlich viele Berichte, da jeder Bericht Daten für einen Zeitraum von 24 Stunden enthält.

      Anhand der Berichts-ID können Sie Berichte ermitteln, die Sie noch herunterladen und importieren müssen. Wenn zwei neue Berichte jedoch dieselben startTime- und endTime-Eigenschaftswerte haben, importieren Sie nur den Bericht mit dem neueren createTime-Wert.

  • Berichte enthalten IDs, die mit YouTube-Ressourcen verknüpft sind. Wenn du zusätzliche Metadaten für diese Ressourcen abrufen möchtest, verwende die YouTube Data API. Gemäß den Richtlinien für Entwickler der YouTube API-Dienste (Abschnitte III.E.4.b bis III.E.4.d) müssen API-Clients gespeicherte Ressourcenmetadaten aus dieser API nach 30 Tagen entweder löschen oder aktualisieren.

Berichtsmerkmale

API-Berichte sind versionierte .csv-Dateien (kommagetrennte Werte) mit den folgenden Eigenschaften:

  • Jeder Bericht enthält Daten für einen einzelnen 24-Stunden-Zeitraum von 00:00 bis 23:59 Uhr Pacific Standard Time (UTC-8). Daher ist der Dimensionswert Tag in jedem Bericht immer gleich.

  • Die Berichte werden täglich aktualisiert.

  • YouTube generiert auch Berichte für Tage, an denen keine Daten verfügbar waren. Diese Berichte enthalten eine Kopfzeile, aber keine zusätzlichen Daten.

  • API-Berichte sind ab dem Zeitpunkt ihrer Erstellung 60 Tage lang verfügbar, mit Ausnahme von Verlaufsdaten, die für neue Berichterstellungsjobs generiert wurden. Berichte, die älter als 60 Tage sind, sind nicht mehr verfügbar.
  • Berichte, die Verlaufsdaten enthalten, sind ab dem Zeitpunkt ihrer Erstellung 30 Tage lang verfügbar. Berichte mit Verlaufsdaten sind nicht mehr verfügbar, wenn sie älter als 30 Tage sind.

  • Berichtsdaten werden nicht gefiltert. Ein Kanalbericht enthält daher alle Daten für die Videos oder Playlists eines Kanals, mit der im folgenden Abschnitt erwähnten Ausnahme für gelöschte Ressourcen. Ein Bericht für Rechteinhaber enthält ebenfalls alle Daten für die Kanäle des Rechteinhabers (Videos, Playlists, Anzeigenleistung usw.), mit der folgenden Ausnahme:

    Berichtsdaten werden nicht gefiltert. Berichte enthalten jedoch keine Verweise auf YouTube-Ressourcen, die mindestens 30 Tage vor dem Datum gelöscht wurden, an dem der Bericht erstellt wurde.

  • Die Berichtsdaten sind nicht sortiert.

  • Zeilen ohne Messwerte werden in Berichten nicht berücksichtigt. Zeilen ohne Messwerte werden also aus dem Bericht ausgeschlossen. Wenn ein Video an einem bestimmten Tag beispielsweise keine Aufrufe in Albanien erzielt hat, enthält der Bericht für diesen Tag keine Zeilen für Albanien.

  • Berichte enthalten keine Zeilen mit Zusammenfassungsdaten für Messwerte wie die Gesamtzahl der Aufrufe aller Videos eines Kanals. Sie können diese Gesamtwerte als Summe der Werte im Bericht berechnen. Diese Summe enthält jedoch möglicherweise keine Messwerte für gelöschte Videos, wie oben erwähnt. Du kannst die Gesamtzahl auch über die YouTube Analytics API abrufen. Die YouTube Analytics API gibt Gesamtwerte zurück, die Messwerte für gelöschte Ressourcen enthalten, auch wenn diese Ressourcen in API-Antworten nicht explizit referenziert werden.

Daten-Backfill

Backfill-Daten beziehen sich auf einen Datensatz, der einen zuvor gesendeten Datensatz ersetzt. Wenn ein Bericht zu Backfill-Daten verfügbar ist, sollte Ihre Anwendung den neuen Bericht abrufen und Ihre gespeicherten Daten an den überarbeiteten Datensatz anpassen. Ihre Anwendung könnte beispielsweise die bisherigen Daten für den im Bericht abgedeckten Zeitraum löschen und dann den neuen Datensatz importieren.

Wenn YouTube Backfill-Daten hat, wird ein neuer Bericht mit einer neuen Berichts-ID generiert. In diesem Fall stimmen die Attributwerte startTime und endTime des Berichts mit dem Start- und Endzeitpunkt eines Berichts überein, der zuvor verfügbar war und den Sie möglicherweise bereits heruntergeladen haben.

Backfill-Berichte enthalten keine Verweise auf YouTube-Ressourcen, die mindestens 30 Tage vor dem Datum gelöscht wurden, an dem der Bericht erstellt wurde.

Bisherige Daten

Wenn Sie einen neuen Berichterstellungsjob planen, generiert YouTube Verlaufsberichte ab diesem Tag und Berichte für den Zeitraum von 30 Tagen vor dem Erstellen des Jobs. In dieser Dokumentation beziehen sich Verlaufsdaten also auf einen Bericht, der Daten für einen Zeitraum vor der Planung des Berichtsjobs enthält.

Bisherige Berichte werden veröffentlicht, sobald sie verfügbar sind. Normalerweise werden alle Verlaufsdaten für einen Job innerhalb weniger Tage veröffentlicht. Wie im Abschnitt Berichtsmerkmale erläutert, sind Berichte mit Verlaufsdaten ab dem Zeitpunkt ihrer Erstellung 30 Tage lang verfügbar. Berichte, die keine Verlaufsdaten enthalten, sind 60 Tage lang verfügbar.

Datenanonymisierung

Um die Anonymität von YouTube-Zuschauern zu wahren, werden Werte für einige Dimensionen nur zurückgegeben, wenn ein Messwert in derselben Zeile einen bestimmten Grenzwert erreicht.

Im Bericht „Videozugriffe nach Quelle“ für Kanäle enthält beispielsweise jede Zeile eine Reihe von Dimensionen, darunter trafficSourceType und trafficSourceDetail. Außerdem enthält jede Zeile verschiedene Messwerte, darunter Aufrufe. In Zeilen, die Zugriffe aus der YouTube-Suche beschreiben, wird mit der Dimension trafficSourceDetail der Suchbegriff angegeben, der zu den Zugriffen geführt hat.

In diesem Beispiel gelten die folgenden Regeln:

  • Im Bericht zu Zugriffsquellen wird der Suchbegriff (trafficSourceDetail) nur dann aufgeführt, wenn er an einem bestimmten Tag zu mindestens einer bestimmten Anzahl von Aufrufen eines bestimmten Videos geführt hat. In diesem Fall ist Aufrufe der Messwert, Video die Aggregationsdimension und trafficSourceDetail die anonymisierte Dimension.

  • Der Bericht enthält eine zusätzliche Zeile, in der Messwerte für alle trafficSourceDetail-Werte zusammengefasst sind, die den Grenzwert für die Aufrufzahl nicht erreichen. In dieser Zeile wird die Gesamtzahl der Aufrufe angegeben, die mit diesen Suchbegriffen verknüpft sind. Die Begriffe selbst werden nicht genannt.

Die folgenden Tabellen veranschaulichen diese Regeln. Die erste Tabelle enthält hypothetische Rohdaten, die YouTube zum Erstellen eines Berichts zu Besucherquellen verwenden würde. Die zweite Tabelle enthält den Bericht selbst. In diesem Beispiel beträgt der Grenzwert für die Aufrufzahl 10. Das bedeutet, dass ein Suchbegriff nur im Bericht aufgeführt wird, wenn er an einem bestimmten Tag zu mindestens 10 Aufrufen eines bestimmten Videos geführt hat. Die tatsächlichen Schwellenwerte können sich ändern.

Rohdaten zu Zugriffen über die YouTube-Suche für ein Video

Angenommen, die folgenden Daten beschreiben die Zugriffe über die YouTube-Suche auf ein bestimmtes Video an einem bestimmten Tag.

Suchbegriff Aufrufe Geschätzte Wiedergabezeit
Gangnam Style 100 200
psy 15 25
psy gangnam 9 15
oppa gangnam 5 8
Reittanz 2 5

Beispiel für einen Bericht zu Besucherquellen

Die folgende Tabelle enthält einen Auszug aus dem Bericht zu Zugriffsquellen, der von YouTube für die Rohdaten im vorherigen Abschnitt generiert würde. Der tatsächliche Bericht enthält mehr Dimensionen und Messwerte. In diesem Beispiel werden im Bericht nur Suchbegriffe aufgeführt, die zu mindestens 10 Aufrufen geführt haben. Die tatsächlichen Schwellenwerte können sich ändern.

In der dritten Zeile des Berichts ist der Wert der Dimension trafficSourceDetail NULL. Die Messwerte views und estimatedMinutesWatched enthalten die kombinierten Aufrufe und die Gesamtwiedergabezeit für die drei Suchbegriffe, die weniger als 10 Aufrufe generiert haben.

trafficSourceDetail Aufrufe estimatedMinutesWatched
Gangnam Style 100 200
psy 15 25
NULL 16 28

Dimensionen, die anonymisiert werden

In der folgenden Tabelle sind die Dimensionswerte aufgeführt, die anonymisiert werden, wenn die zugehörigen Messwertwerte einen bestimmten Grenzwert nicht erreichen. In jedem Fall wird der Wert des Messwerts über eine andere Dimension zusammengefasst. Wenn der Messwert beispielsweise Aufrufe und die Dimensionsaggregation Video ist, wird der Dimensionswert anonymisiert, es sei denn, das Video wurde eine bestimmte Anzahl von Malen angesehen.

Messwert Dimensionen zusammenfassen Anonymisierte Dimension Anonymisierter Wert
subscribersGained channel Land ZZ
subscribersGained channel bundesland US-ZZ
subscribersLost channel Land ZZ
subscribersLost channel bundesland US-ZZ
comments Video Land ZZ
comments Video bundesland US-ZZ
Mag ich Video Land ZZ
Mag ich Video bundesland US-ZZ
Dislikes Video Land ZZ
Dislikes Video bundesland US-ZZ
Aufrufe Video ageGroup NULL
Aufrufe Video gender NULL
Aufrufe video und trafficSourceDetail trafficSourceDetail NULL
Anzahl der Kanalabonnenten channel subscribedStatus NULL

Codebeispiele

In den folgenden Codebeispielen wird gezeigt, wie Sie mit der API einen Berichtsjob erstellen und dann einen Bericht für diesen Job abrufen. Für jede Sprache sind zwei Codebeispiele verfügbar:

  1. Im ersten Codebeispiel wird gezeigt, wie eine Liste der verfügbaren Berichtstypen abgerufen und dann ein neuer Berichtsjob erstellt wird.

  2. Das zweite Codebeispiel zeigt, wie ein Bericht für einen bestimmten Job abgerufen wird. Sie können Berichte innerhalb von 48 Stunden nach dem Erstellen des Jobs abrufen.

Hinweis:Die folgenden Codebeispiele decken möglicherweise nicht alle unterstützten Programmiersprachen ab. Eine Liste der unterstützten Sprachen finden Sie unter Clientbibliotheken.

Java

In den folgenden Beispielen wird die Java-Clientbibliothek verwendet:

Beispiel 1: Berichtsjob erstellen

Im folgenden Codebeispiel wird die Methode reportTypes.list aufgerufen, um eine Liste der verfügbaren Berichtstypen abzurufen. Anschließend wird die Methode jobs.create aufgerufen, um einen neuen Berichtsjob zu erstellen.

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

CreateReportingJob.java

Beispiel 2: Bericht abrufen

Im Codebeispiel wird die Methode jobs.list aufgerufen, um eine Liste der Berichtsjobs abzurufen. Anschließend wird die Methode reports.list aufgerufen, wobei der Parameter jobId auf eine bestimmte Job-ID festgelegt ist, um Berichte abzurufen, die mit diesem Job erstellt wurden. Schließlich wird die Download-URL für jeden Bericht ausgegeben. 

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


RetrieveReports.java

PHP

In den folgenden Beispielen wird die PHP-Clientbibliothek verwendet.

Beispiel 1: Berichtsjob erstellen

Im folgenden Codebeispiel wird die Methode reportTypes.list aufgerufen, um eine Liste der verfügbaren Berichtstypen abzurufen. Anschließend wird die Methode jobs.create aufgerufen, um einen neuen Berichtsjob zu erstellen.

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

create_reporting_job.php

Beispiel 2: Bericht abrufen

Im Codebeispiel wird die Methode jobs.list aufgerufen, um eine Liste der Berichtsjobs abzurufen. Anschließend wird die Methode reports.list aufgerufen, wobei der Parameter jobId auf eine bestimmte Job-ID festgelegt ist, um Berichte abzurufen, die mit diesem Job erstellt wurden. Schließlich wird die Download-URL für jeden Bericht ausgegeben.

<?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);
  }
}

?>

retrieve_reports.php

Python

In den folgenden Beispielen wird die Python-Clientbibliothek verwendet.

Beispiel 1: Berichtsjob erstellen

Im folgenden Codebeispiel wird die Methode reportTypes.list aufgerufen, um eine Liste der verfügbaren Berichtstypen abzurufen. Anschließend wird die Methode jobs.create aufgerufen, um einen neuen Berichtsjob zu erstellen.

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

create_reporting_job.py

Beispiel 2: Bericht abrufen

Im Codebeispiel wird die Methode jobs.list aufgerufen, um eine Liste der Berichtsjobs abzurufen. Anschließend wird die Methode reports.list mit dem Parameter jobId aufgerufen, der auf eine bestimmte Job-ID festgelegt ist, um Berichte abzurufen, die mit diesem Job erstellt wurden. Schließlich wird die Download-URL für jeden Bericht ausgegeben.

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

retrieve_reports.py