YouTube Reporting API - Data Model

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

Diese Richtlinie gilt weltweit für alle Berichte und Berichterstellungsjobs. Ausführliche Informationen finden Sie im Überarbeitungsverlauf der YouTube Reporting API.

Die YouTube Reporting API unterstützt vordefinierte Berichte, die umfassende YouTube Analytics-Daten zu einem Kanal oder Rechteinhaber enthalten. Mit diesen Berichten kannst du die Bulk-Datensätze herunterladen, die du über die YouTube Analytics API oder im Abschnitt Analytics in YouTube Studio abfragen kannst.

Die API unterstützt auch eine Reihe automatisch generierter, vom System verwalteter Berichte, die für Rechteinhaber verfügbar sind, die im Menü „Berichte“ auf die entsprechenden Berichte zugreifen können. Diese Berichte enthalten Daten zu Werbeeinnahmen und zu Aboeinnahmen aus YouTube Premium. Weitere Informationen finden Sie in der Dokumentation zu vom System verwalteten Berichten.

Überblick

Die Berichtsfelder in diesen Berichten sind entweder als Dimensionen oder als Messwerte gekennzeichnet:

  • Dimensionen sind allgemeine Kriterien, nach denen Daten aggregiert werden, etwa das Datum einer Aktion oder das Land, in dem sich die Nutzer befanden. In einem Bericht enthält jede Datenzeile eine eindeutige Kombination von Dimensionswerten.
  • Messwerte sind individuelle Messungen zur Nutzeraktivität, Anzeigenleistung oder zum geschätzten Umsatz. Zu den Messwerten zur Nutzeraktivität gehören beispielsweise die Anzahl der Videoaufrufe und Bewertungen, wie „Mag ich“- und „Mag ich nicht“-Bewertungen.

Der einfache Bericht zur Nutzeraktivität für Channels enthält beispielsweise die folgenden Dimensionen:

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

Der Bericht enthält auch viele Messwerte wie Aufrufe, Likes und averageViewDuration. Nach dem Abrufen und Importieren des Berichts kann eine Anwendung viele verschiedene Berechnungen basierend auf gemeinsamen Dimensionswerten durchführen.

Wenn du beispielsweise die Gesamtzahl der Aufrufe in Deutschland an einem bestimmten Datum berechnen möchtest, addiere die Messwerte Aufrufe für alle Zeilen, in denen der Wert in der Spalte Land DE und der Wert in der Spalte Tag das Datum im Format YYYY-MM-DD ist.

YouTube Analytics-Berichte abrufen

In den folgenden Schritten erfährst du, wie du Berichte zu Kanälen und Rechteinhabern über die API abrufst. In der Dokumentation zu vom System verwalteten Berichten erfahren Sie, wie Sie diese Berichte abrufen.

Schritt 1: Anmeldedaten für die Autorisierung abrufen

Alle Anfragen an die YouTube Reporting API müssen autorisiert werden. Im Autorisierungsleitfaden wird erläutert, wie Sie mithilfe des OAuth 2.0-Protokolls Autorisierungstoken abrufen können.

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

Ebenen
https://www.googleapis.com/auth/yt-analytics.readonly YouTube Analytics-Berichte für deine YouTube-Inhalte abrufen Über diesen Bereich erhalten Sie Zugriff auf Messwerte zur Nutzeraktivität, z. B. Anzahl der Aufrufe und Bewertungen.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube Analytics-Finanzberichte für deine YouTube-Inhalte abrufen Über diesen Bereich erhalten Sie Zugriff auf Messwerte zur Nutzeraktivität sowie auf den geschätzten Umsatz und die Anzeigenleistung.

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

Rufe die reportTypes.list-Methode der API auf, um eine Liste von Berichten 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 erstellen möchten. Die ID für den grundlegenden Bericht zur Nutzeraktivität für Channels lautet beispielsweise channel_basic_a1.

Die Namen der Berichte findest du auch in der Dokumentation, in der die unterstützten Kanalberichte und Rechteinhaberberichte definiert werden.

Schritt 3: Berichterstellungsjob erstellen

YouTube beginnt erst mit der Berichterstellung, wenn Sie einen Berichterstellungsjob für diesen Bericht erstellt haben. Daher werden Berichte nur für die Kanäle und Rechteinhaber erstellt, die diese Daten auch tatsächlich abrufen möchten.

Wenn Sie einen Berichterstellungsjob erstellen möchten, rufen Sie die Methode jobs.create der API auf. Legen Sie im Anfragetext die folgenden Werte fest:

  • Lege den Wert der reportTypeId-Property auf die Berichts-ID fest, die du in Schritt 2 abgerufen hast.
  • Legen Sie als Wert der Eigenschaft name den Namen fest, den Sie mit dem Bericht verknüpfen möchten.

Die API-Antwort auf die Methode jobs.create enthält eine Job-Ressource, die die ID angibt, die den Job eindeutig identifiziert. Sie können innerhalb von 48 Stunden nach Erstellung des Jobs mit dem Abrufen des Berichts beginnen. Der erste verfügbare Bericht ist dann für den Tag verfügbar, an dem Sie den Job geplant haben.

Wenn Sie beispielsweise einen Job für den 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 und so weiter.

Schritt 4: Job-ID abrufen

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

Rufen Sie die Methode jobs.list auf, um eine Liste mit geplanten Jobs abzurufen. Das Attribut reportTypeId in jeder zurückgegebenen Job-Ressource gibt die Art des Berichts an, der von diesem Job generiert wird. Ihre Anwendung benötigt im folgenden 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 Berichte abzurufen, die für den Job erstellt wurden. Legen Sie in der Anfrage für den Parameter jobId die Job-ID des Berichts fest, den Sie abrufen möchten.

Tipp:Geben Sie mit dem Parameter createdAfter an, dass die API nur Berichte zurückgeben soll, die nach einem bestimmten Zeitraum erstellt wurden. Mit diesem Parameter können Sie sicherstellen, 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 eindeutigen Zeitraum von 24 Stunden enthält. YouTube erstellt herunterladbare Berichte für Tage, an denen keine Daten verfügbar waren. Diese Berichte enthalten eine Kopfzeile, aber keine zusätzlichen Daten.

  • Die Eigenschaften startTime und endTime der Ressource geben den Zeitraum an, den die Daten des Berichts abdecken.
  • Das Attribut downloadUrl der Ressource gibt die URL an, von der der Bericht abgerufen werden kann.
  • Die Eigenschaft createTime der Ressource gibt an, wann der Bericht erstellt wurde (Datum und Uhrzeit). Ihre Anwendung sollte diesen Wert speichern und damit feststellen, ob sich zuvor heruntergeladene Berichte geändert haben.

Schritt 6: Bericht herunterladen

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

Sie können die für das Herunterladen von Berichten erforderliche Bandbreite verringern, indem Sie die gzip-Komprimierung für Downloadanfragen aktivieren. Für die Dekomprimierung von API-Antworten benötigt Ihre Anwendung zwar zusätzliche CPU-Zeit, doch in der Regel überwiegt der Vorteil der geringeren Netzwerkressourcen diese Kosten.

Um eine mit gzip codierte Antwort zu erhalten, setze den Accept-Encoding-HTTP-Anfrageheader auf gzip, wie im folgenden Beispiel gezeigt:

Accept-Encoding: gzip

Berichte werden verarbeitet

Best Practices

Anwendungen, die die YouTube Reporting API verwenden, sollten immer folgendermaßen vorgehen:

  • Die Reihenfolge der Berichtsspalten bestimmen Sie anhand der Kopfzeile des Berichts. Sie sollten beispielsweise nicht davon ausgehen, dass Aufrufe der erste in einem Bericht zurückgegebene Messwert ist, nur weil er der erste Messwert ist, der in einer Berichtsbeschreibung aufgeführt ist. Verwenden Sie stattdessen die Kopfzeile des Berichts, um zu bestimmen, welche Spalte die Daten enthält.

  • Bewahren Sie die heruntergeladenen Berichte auf, um eine wiederholte Verarbeitung desselben Berichts zu vermeiden. Die folgende Liste zeigt Ihnen einige Möglichkeiten, dies zu tun.

    • 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.

      Jedes Mal, wenn Sie Berichte abrufen und erfolgreich verarbeiten, sollten Sie den Zeitstempel für Datum und Uhrzeit speichern, zu dem der neueste Bericht erstellt wurde. Aktualisieren Sie dann den Parameterwert createdAfter bei jedem nachfolgenden Aufruf der reports.list-Methode, damit bei jedem API-Aufruf nur neue Berichte abgerufen werden. Dies gilt auch für neue Berichte mit Daten, die auf einem Backfill beruhen.

      Prüfen Sie vor dem Abrufen eines Berichts als Sicherheitsmaßnahme, dass die ID des Berichts nicht 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 Datum und Uhrzeit speichern, zu dem bzw. zu der ein Bericht erstellt wurde, oder die startTime und endTime des Berichts. Diese geben zusammen den Zeitraum an, für den der Bericht Daten enthält. Beachten Sie, dass jeder Job wahrscheinlich über viele Berichte verfügt, da jeder Bericht Daten für einen Zeitraum von 24 Stunden enthält.

      Verwenden Sie die Berichts-ID, um Berichte zu identifizieren, die Sie noch herunterladen und importieren müssen. Wenn zwei neue Berichte jedoch dieselben Attributwerte für startTime und endTime haben, importieren Sie den Bericht nur mit dem neueren Wert für createTime.

  • Berichte enthalten IDs, die YouTube-Ressourcen zugeordnet sind. Verwende die YouTube Data API, um zusätzliche Metadaten für diese Ressourcen abzurufen. 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 Merkmalen:

  • Jeder Bericht enthält Daten für einen eindeutigen 24-Stunden-Zeitraum von 00:00 Uhr bis 23:59 Uhr Pacific Time. Daher ist der Dimensionswert Tag in jedem Bericht immer derselbe.

  • Die Berichte werden täglich aktualisiert.

  • YouTube erstellt herunterladbare 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 verfügbar, mit Ausnahme von Verlaufsdaten, die für neue Berichterstellungsjobs generiert wurden. Berichte, die älter als 60 Tage sind, können nicht mehr aufgerufen werden.
  • Berichte mit Verlaufsdaten sind 30 Tage lang verfügbar, nachdem sie generiert wurden. Berichte mit Verlaufsdaten sind nicht mehr verfügbar, wenn sie mehr als 30 Tage alt sind.

  • Berichtsdaten werden nicht gefiltert. Daher enthält ein Kanalbericht alle Daten zu den Videos oder Playlists eines Kanals mit der im folgenden Absatz genannten Ausnahme, die sich auf gelöschte Ressourcen bezieht. Ebenso enthält ein Rechteinhaber-Bericht alle Daten für die Kanäle des Rechteinhabers (Videos, Playlists, Anzeigenleistung usw.), mit der folgenden Ausnahme.

    Obwohl Berichtsdaten nicht gefiltert werden, enthalten Berichte keine Verweise auf YouTube-Ressourcen, die mindestens 30 Tage vor dem Erstellungsdatum des Berichts gelöscht wurden.

  • Berichtsdaten werden nicht sortiert.

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

  • Berichte enthalten keine Zeilen mit zusammenfassenden Messwerten wie die Gesamtzahl der Aufrufe aller Videos eines Kanals. Du kannst diese Gesamtwerte als Summe der Werte im Bericht berechnen, aber diese Summe enthält möglicherweise keine Messwerte für gelöschte Videos, wie oben erwähnt. Du kannst auch die YouTube Analytics API verwenden, um die Gesamtzahlen abzurufen. Die YouTube Analytics API gibt Gesamtwerte zurück, die Messwerte für gelöschte Ressourcen enthalten, auch wenn in API-Antworten nicht explizit auf diese Ressourcen verwiesen wird.

Backfill-Daten

Backfill-Daten beziehen sich auf einen Datensatz, der einen zuvor übermittelten Datensatz ersetzt. Wenn ein Bericht mit Backfill-Daten verfügbar ist, sollte Ihre Anwendung den neuen Bericht abrufen und Ihre gespeicherten Daten aktualisieren, damit sie dem überarbeiteten Datensatz entsprechen. Ihre Anwendung könnte beispielsweise die vorherigen 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 erstellt. In diesem Fall stimmen die Property-Werte startTime und endTime des Berichts mit den Start- und Endzeiten 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 Erstellungsdatum des Berichts gelöscht wurden.

Verlaufsdaten

Wenn Sie einen neuen Berichterstellungsjob planen, generiert YouTube ab diesem Tag Berichte zu bisherigen Daten sowie Berichte für die 30 Tage vor der Erstellung des Jobs. In dieser Dokumentation beziehen sich Verlaufsdaten daher auf einen Bericht, der Daten für einen Zeitraum vor der Planung des Berichtsjobs enthält.

Berichte zu bisherigen Daten werden veröffentlicht, sobald sie verfügbar sind. In der Regel werden alle Verlaufsdaten für einen Job innerhalb weniger Tage veröffentlicht. Wie im Abschnitt Berichtsmerkmale erläutert, sind Berichte mit Verlaufsdaten 30 Tage lang verfügbar, nachdem sie generiert wurden. Berichte, die keine Verlaufsdaten enthalten, sind 60 Tage lang verfügbar.

Datenanonymisierung

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

Im Bericht zu Besucherquellen für Videos für Channels enthält jede Zeile beispielsweise eine Reihe von Dimensionen, darunter trafficSourceType und trafficSourceDetail. Jede Zeile enthält auch verschiedene Messwerte, darunter Aufrufe. In Zeilen, die Zugriffe über eine YouTube-Suche beschreiben, wird mit der Dimension trafficSourceDetail der Suchbegriff ermittelt, der zu den Zugriffen geführt hat.

In diesem Beispiel gelten die folgenden Regeln:

  • Im Zugriffsquellenbericht wird der Suchbegriff (trafficSourceDetail) nur dann identifiziert, 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 werden, die den Grenzwert für die Anzahl der Aufrufe nicht erreichen. In dieser Zeile wird zwar die Gesamtzahl der Aufrufe angegeben, die mit diesen Suchbegriffen verknüpft sind, die Begriffe selbst werden jedoch nicht angegeben.

In den folgenden Tabellen werden diese Regeln veranschaulicht. Die erste Tabelle enthält einen hypothetischen Satz an Rohdaten, die YouTube zur Erstellung eines Zugriffsquellenberichts verwenden würde. Die zweite Tabelle enthält den Bericht selbst. In diesem Beispiel liegt der Grenzwert für die Anzahl der Aufrufe bei 10. Ein Suchbegriff wird im Bericht also nur dann identifiziert, wenn er an einem bestimmten Tag zu mindestens 10 Aufrufen eines bestimmten Videos geführt hat. (Die tatsächlichen Grenzwerte können sich ändern.)

Unformatierte YouTube-Suchzugriffsdaten für ein Video

Gehe davon aus, dass die folgenden Daten die Zugriffe über die YouTube-Suche für ein bestimmtes Video an einem bestimmten Tag beschreiben.

Suchbegriff Aufrufe Geschätzte Wiedergabezeit
Gangnam-Stil 100 200
Psy 15 25
Psy Gangnam 9 15
Oppa Gangnam 5 8
Tanzen beim Reiten 2 5

Beispiel für einen Bericht zu Besucherquellen

Die folgende Tabelle enthält einen Auszug aus dem Zugriffsquellenbericht, den YouTube für die Rohdaten im vorherigen Abschnitt generieren würde. Der eigentliche Bericht enthält dann mehr Dimensionen und Messwerte. In diesem Beispiel werden im Bericht nur Suchbegriffe berücksichtigt, die zu mindestens zehn Aufrufen geführt haben. Die tatsächlichen Grenzwerte können sich ändern.

In der dritten Zeile des Berichts hat der Dimensionswert „trafficSourceDetail“ den Wert „NULL“. Die Messwerte views und estimatedMinutesWatched enthalten die zusammengefassten Aufrufe und angesehenen Minuten für die drei Suchbegriffe, die weniger als zehn Aufrufe generiert haben.

trafficSourceDetail Aufrufe estimatedMinutesWatched
Gangnam-Stil 100 200
Psy 15 25
NULL 16 28

Dimensionen unterliegen Anonymisierung

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

Messwert Dimension(en) aggregieren 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“-Bewertungen Video Land ZZ
„Mag ich“-Bewertungen Video bundesland US-ZZ
Mag ich nicht Video Land ZZ
Mag ich nicht Video bundesland US-ZZ
Aufrufe Video ageGroup NULL
Aufrufe Video gender [Geschlecht] NULL
Aufrufe video und trafficSourceDetail trafficSourceDetail NULL
Anzahl der Kanalabonnenten channel subscribedStatus NULL

Codebeispiele

Die folgenden Codebeispiele zeigen, wie Sie mit der API einen Berichterstellungsjob erstellen und dann einen Bericht für diesen Job abrufen. Für jede Sprache werden zwei Codebeispiele bereitgestellt:

  1. Das erste Codebeispiel zeigt, wie Sie eine Liste der verfügbaren Berichtstypen abrufen und anschließend einen neuen Berichterstellungsjob erstellen.

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

Hinweis:Die folgenden Codebeispiele beziehen sich möglicherweise nicht auf alle unterstützten Programmiersprachen. Eine Liste der unterstützten Sprachen finden Sie in der Dokumentation zu Clientbibliotheken.

Java

In den folgenden Beispielen wird die Java-Clientbibliothek verwendet:

Beispiel 1: Berichterstellungsjob 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 Berichterstellungsjob 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 von 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 durch diesen Job erstellt wurden. Schließlich druckt das Beispiel die Download-URL für jeden Bericht aus. 

/*
 * 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: Berichterstellungsjob 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 Berichterstellungsjob 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 von 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 durch diesen Job erstellt wurden. Schließlich druckt das Beispiel die Download-URL für jeden Bericht aus.

<?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: Berichterstellungsjob 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 Berichterstellungsjob 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 von 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 durch diesen Job erstellt wurden. Schließlich druckt das Beispiel die Download-URL für jeden Bericht aus.

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