YouTube Reporting API - Data Model

Ważne: nadchodząca zmiana zasad wpłynie na czas, przez który będzie można pobierać raporty do interfejsu YouTube Reporting API. Po wprowadzeniu zmian raporty dzienne i raporty dotyczące interfejsu API będą dostępne przez 60 dni (zamiast 180 dni) od momentu ich wygenerowania. Raporty z danymi historycznymi będą dostępne przez 30 dni od momentu ich wygenerowania.

Obecnie ta zmiana wejdzie w życie w lipcu 2018 r., a nowe zasady będą obowiązywać na całym świecie dla wszystkich raportów i zadań raportowania. Szczegółowe informacje o tej zmianie znajdziesz w historii zmian interfejsu API.

Interfejs YouTube Reporting API obsługuje wstępnie zdefiniowane raporty, które zawierają obszerny zestaw danych YouTube Analytics dotyczących kanału lub właściciela treści. Te raporty umożliwiają pobieranie zbiorów danych, do których można przesyłać zapytania za pomocą interfejsu YouTube Analytics API lub w sekcji Analytics w Studiu twórców.

Omówienie

Pola raportu w tych raportach są charakterystyczne jako wymiary lub dane:

  • Wymiary to typowe kryteria używane do agregowania danych, takie jak data wystąpienia działania lub kraj zamieszkania użytkowników. W każdym wierszu danych w raporcie występuje unikalna kombinacja wartości wymiaru.
  • Dane to indywidualne pomiary dotyczące aktywności użytkowników, skuteczności reklam i szacunkowych przychodów. Dane dotyczące aktywności użytkowników obejmują liczbę wyświetleń filmów i oceny (oceny pozytywne i negatywne).

Przykładowy raport aktywności użytkowników dla kanałów zawiera następujące wymiary:

  • date: data wystąpienia działania.
  • channel_id: kanał YouTube powiązany z aktywnością.
  • video_id: film w YouTube powiązany z aktywnością.
  • live_or_on_demand: wartość wskazująca, czy widzowie oglądali transmisję wideo na żywo.
  • subscribed_status: wartość wskazująca, czy widzowie zasubskrybowali kanał.
  • country_code: kraj, w którym znajdowały się widzowie.

Raport zawiera też wiele danych, np. obejrzenia, polubienia i średni_wyświetlenie_czas_sekundy. Po pobraniu i zaimportowaniu raportu aplikacja może wykonać wiele różnych obliczeń na podstawie wspólnych wartości wymiarów.

Pobieranie raportów Statystyk YouTube

Krok 1. Pobierz dane logowania

Wszystkie żądania do interfejsu YouTube Reporting API muszą być autoryzowane. Przewodnik po autoryzacji zawiera instrukcje pobierania tokenów autoryzacji za pomocą protokołu OAuth 2.0.

Żądania do interfejsu YouTube Reporting API używają tych zakresów autoryzacji:

Zakresy
https://www.googleapis.com/auth/yt-analytics.readonly Wyświetlaj raporty Statystyk YouTube dotyczące treści w YouTube. Zakres ten zapewnia dostęp do danych o aktywności użytkowników, takich jak liczba wyświetleń i oceny.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Wyświetlanie raportów finansowych Statystyk YouTube dotyczących treści w YouTube Zakres ten umożliwia dostęp do danych o aktywności użytkowników oraz szacunkowych danych o przychodach i skuteczności reklam.

Krok 2. Określ raport, który chcesz pobrać

Wywołaj metodę reportTypes.list interfejsu API, aby pobrać listę raportów, które można generować dla kanału lub właściciela treści. Metoda zwraca listę identyfikatorów i nazw raportów. Przechwyć wartość właściwości id w raportach, które chcesz wygenerować. Na przykład identyfikator podstawowego raportu aktywności użytkownika na kanałach to channel_basic_a1.

Nazwy raportów znajdziesz też w ich dokumentacji, która określa obsługiwane raporty dotyczące kanałów i raporty właściciela treści.

Krok 3. Utwórz zadanie raportowania

YouTube zacznie generować raport dopiero wtedy, gdy utworzysz dla niego zadanie raportowania. (Dlatego raporty są generowane tylko dla kanałów i właścicieli treści, którzy chcą je pobierać).

Aby utworzyć zadanie raportowania, wywołaj metodę jobs.create interfejsu API. Ustaw w treści żądania te wartości:

  • Ustaw wartość właściwości reportTypeId na identyfikator raportu pobrany w kroku 2.
  • Ustaw wartość właściwości name na nazwę, którą chcesz powiązać z raportem.

Odpowiedź interfejsu API dotycząca metody jobs.create zawiera zasób Job, który określa jednoznacznie identyfikator zadania w polu ID. Raport możesz pobrać w ciągu 48 godzin od utworzenia zadania. Pierwszy dostępny raport dotyczy dnia, w którym zadanie zostało zaplanowane.

Jeśli np. zaplanujesz zadanie na 1 września 2015 r., raport za 1 września 2015 r. będzie gotowy na 3 września 2015 r. Raport z 2 września 2015 r. zostanie opublikowany 4 września 2015 r. itp.

Krok 4. Pobierz identyfikator zadania

Uwaga: jeśli aplikacja zapisała identyfikator zadania zwrócony w kroku 3, możesz pominąć ten krok.

Wywołaj metodę jobs.list, aby pobrać listę zaplanowanych zadań. Właściwość reportTypeId każdego zwracanego zasobu Job wskazuje typ raportu generowanego przez to zadanie. Twoja aplikacja potrzebuje wartości właściwości id z tego samego zasobu w kolejnym kroku.

Krok 5. Pobierz adres URL pobierania raportu

Wywołaj metodę jobs.reports.list, aby pobrać listę raportów utworzonych dla tego zadania. W żądaniu ustaw parametr jobId na identyfikator zadania raportu, który chcesz pobrać.

Wskazówka: użyj parametru createdAfter, aby wskazać, że interfejs API powinien zwracać tylko raporty utworzone po określonym czasie. Ten parametr pozwala zagwarantować, że interfejs API zwróci tylko te raporty, których jeszcze nie przetworzono.

Odpowiedź interfejsu API zawiera listę Report zasobów dla tego zadania. Każdy zasób odnosi się do raportu zawierającego dane z unikalnego okresu 24-godzinnego. Pamiętaj, że YouTube generuje raporty do pobrania dla dni, w których dane nie były dostępne. Te raporty zawierają wiersz nagłówka, ale nie zawierają dodatkowych danych.

  • Właściwości startTime i endTime zasobu określają okres objęty danymi w raporcie.
  • Właściwość downloadUrl zasobu określa adres URL, z którego można pobrać raport.

  • Właściwość createTime zasobu określa datę i godzinę wygenerowania raportu. Aplikacja powinna zapisać tę wartość i używać jej do określania, czy wcześniej pobrane raporty uległy zmianie.

Krok 6. Pobierz raport

Aby pobrać raport, wyślij żądanie HTTP GET do sekcji downloadUrl uzyskanej w kroku 5.

Możesz zmniejszyć przepustowość potrzebną do pobierania raportów, włączając kompresję gzip w przypadku żądań pobierania. Choć aplikacja potrzebuje więcej czasu na skompresowanie odpowiedzi interfejsu API, korzyści zużywania mniejszej liczby zasobów sieciowych zwykle przewyższają ten koszt.

Aby otrzymać odpowiedź zakodowaną w formacie gzip, ustaw nagłówek HTTP Accept-Encoding na gzip, jak w tym przykładzie:

Accept-Encoding: gzip

Raporty z przetwarzania

Sprawdzone metody

Aplikacje, które używają interfejsu API do raportowania YouTube, zawsze powinni stosować te metody:

  • Aby określić kolejność kolumn raportu, użyj wiersza nagłówka raportu. Na przykład nie zakładaj, że wyświetlenia będą pierwszymi danymi zwróconymi w raporcie, ponieważ są to pierwsze dane wymienione w jego opisie. Aby określić, która kolumna zawiera te dane, skorzystaj z wiersza nagłówka raportu.

  • Zapisuj pobrane raporty, by uniknąć powtórnego przetwarzania tego samego raportu. Oto kilka sposobów wykonania tej czynności.

    • Wywołując metodę reports.list, używaj parametru createAfter, aby pobierać tylko raporty utworzone po określonej dacie. (Podczas pierwszego pobierania raportów pomiń parametr createdAfter).

      Za każdym razem, gdy pobierasz i przetwarzasz raporty, zapisuj sygnaturę czasową odpowiadającą data i godzina utworzenia najnowszych raportów. Następnie zaktualizuj wartość parametru createdAfter przy każdym kolejnym wywołaniu metody reports.list, aby mieć pewność, że przy każdym wywołaniu interfejsu API pobierasz tylko nowe raporty, w tym nowe raporty z uzupełnionymi danymi.

      Ze względów bezpieczeństwa przed pobraniem raportu upewnij się, że w bazie danych nie ma już identyfikatora raportu.

    • Zapisz identyfikator każdego raportu, który został pobrany i przetworzony. Możesz też przechowywać dodatkowe informacje, takie jak data i godzina wygenerowania każdego raportu lub startTime i endTime, które wskazują razem okres, z którego pochodzą dane. Pamiętaj, że każde zadanie zawiera prawdopodobnie wiele raportów, bo każdy z nich zawiera dane z 24 godzin.

      Identyfikator raportu pozwala zidentyfikować raporty, które nadal musisz pobrać i zaimportować. Jeśli jednak 2 nowe raporty mają te same wartości właściwości startTime i endTime, importuj raport tylko z nowszą wartością createTime.

  • Raporty zawierają identyfikatory powiązane z zasobami YouTube. Do pobierania dodatkowych metadanych tych zasobów możesz używać interfejsu YouTube Data API. Zgodnie z zasadami dla deweloperów dotyczącymi usług interfejsu API YouTube (sekcje III.E.4.b do III.E.4.d) klienty interfejsu API muszą usuwać lub odświeżać zapisane metadane zasobów z tego interfejsu API po 30 dniach.

Cechy raportu

Raporty interfejsu API mają wersje .csv (wartości rozdzielone przecinkami), które mają następujące cechy:

  • Każdy raport zawiera dane z okresu 24-godzinnego trwającego od 00:00 do 23:59 czasu pacyficznego. W każdym raporcie wartość wymiaru data jest zawsze taka sama.

  • Raporty są aktualizowane codziennie.

  • YouTube generuje raporty do pobrania dla dni, w których dane nie były dostępne. Te raporty będą zawierać wiersz nagłówka, ale nie będą zawierać dodatkowych danych.

  • Ważne: nadchodząca zmiana zasad wpłynie na czas, przez który będzie można pobierać raporty do interfejsu YouTube Reporting API. Planujemy wprowadzić tę zmianę w lipcu 2018 roku i będzie ona obowiązywać we wszystkich raportach i zadaniach raportowania.

    • Przed zmianą raporty API będą dostępne przez 180 dni od momentu ich wygenerowania.
    • Po zmianie raporty API będą dostępne przez 60 dni od momentu ich wygenerowania z wyjątkiem danych historycznych wygenerowanych dla nowych zadań raportowania. Raporty, które mają ponad 60 dni, nie będą dostępne po wprowadzeniu zmiany zasad.
    • Po zmianie raporty zawierające dane historyczne będą dostępne przez 30 dni od momentu ich wygenerowania. Raporty zawierające dane historyczne, które mają ponad 30 dni, nie będą już dostępne po wprowadzeniu zmian zasad.

  • Dane raportu nie są filtrowane. Dlatego raport dotyczący kanału zawiera wszystkie dane dotyczące filmów lub playlist na danym kanale, z wyjątkiem w poniższym artykule dotyczącym usuniętych zasobów. Podobnie raport właściciela treści zawiera wszystkie dane dotyczące kanałów właściciela treści (filmów, playlist, skuteczności reklam itp.) z tym wyjątkiem.

    Dane w raportach nie są filtrowane, ale raporty obejmujące dane z 1 czerwca 2018 roku lub później nie będą zawierać odniesień do zasobów YouTube usuniętych co najmniej 30 dni przed wygenerowaniem raportu.

  • Dane w raporcie nie są sortowane.

  • W raportach pominięto wiersze bez danych. Krótko mówiąc, wiersze, które nie zawierają żadnych danych, są wykluczone z raportu. Jeśli np. film nie uzyskał w Albanii wyświetleń konkretnego dnia, raport z tego dnia nie będzie zawierał wierszy dotyczących Albanii.

  • Raporty nie zawierają wierszy z podsumowaniem danych, takich jak łączna liczba wyświetleń wszystkich filmów na kanale. Łączne wartości możesz obliczyć jako sumę wartości w raporcie, ale mogą one nie uwzględniać danych usuniętych filmów, jak wspomniano powyżej. Całkowitą liczbę wyświetleń możesz też sprawdzić, korzystając z interfejsu YouTube Analytics API. Interfejs YouTube Analytics API zwraca łączne wartości, które zawierają wskaźniki dotyczące usuniętych zasobów, mimo że te zasoby nie są wyraźnie podane w odpowiedziach interfejsu API.

Dane reklam zapasowych

Dane uzupełniania to zbiór, który zastępuje wcześniej przesłany zbiór. Gdy raport o danych zapasowych będzie dostępny, aplikacja powinna pobrać nowy raport i zaktualizować zapisane dane tak, aby pasowały do poprawionego zbioru danych. Aplikacja może np. usunąć poprzednie dane z okresu objętego raportem, a potem zaimportować nowy.

Jeśli YouTube ma dane zapasowe, wygeneruje nowy raport z nowym identyfikatorem. W takim przypadku wartości właściwości startTime i endTime raportu będą odpowiadać godzinom rozpoczęcia i zakończenia raportu, które były wcześniej dostępne i które mogły zostać wcześniej pobrane.

Raporty o zapasach zawierające dane z okresu od 1 czerwca 2018 r. lub później nie zawierają żadnych odwołań do zasobów YouTube, które zostały usunięte co najmniej 30 dni przed wygenerowaniem raportu.

Dane historyczne

Gdy planujesz nowe zadanie raportowania, YouTube generuje raporty historyczne obejmujące okres sprzed utworzenia zadania. Dlatego w tej dokumentacji dane historyczne odnoszą się do raportu zawierającego dane z okresu przed zaplanowaniem zadania raportowania.

Ważne: nadchodząca zmiana zasad wpłynie na czas, przez jaki dane historyczne w raporcie będą generowane. Planujemy wprowadzić tę zmianę w lipcu 2018 roku i będzie ona obowiązywać we wszystkich raportach i zadaniach raportowania.

  • Przed zmianą zasad YouTube opracowuje raporty obejmujące 180 dni poprzedzających utworzenie zadania.
  • Gdy zmienisz zasadę, podczas tworzenia nowego zadania raportowania YouTube wygeneruje raporty od tego dnia obejmujące 30 dni przed utworzeniem zadania.

Raporty historyczne są publikowane, gdy tylko będą dostępne. Zazwyczaj wszystkie dane historyczne są publikowane w ciągu kilku dni od publikacji oferty pracy. Zgodnie z opisem w sekcji Dane raportowania po wprowadzeniu zmiany zasad w lipcu 2018 r. raporty zawierające dane historyczne będą dostępne przez 30 dni od momentu ich wygenerowania. Raporty zawierające dane niehistoryczne będą dostępne przez 60 dni po zmianie zasad.

Anonimizacja danych

Aby zapewnić anonimowość widzów YouTube, wartości niektórych wymiarów są zwracane tylko wtedy, gdy dane w tym samym wierszu spełniają określony próg.

Na przykład w raporcie o źródłach wizyt wideo dla kanałów każdy wiersz zawiera kilka wymiarów, m.in. traffic_source_type oraz traffic_source_detail. Każdy wiersz zawiera też różne dane, w tym widoki. W wierszach opisujących ruch pochodzący z wyszukiwania w YouTube wymiar traffic_source_detail wskazuje wyszukiwane hasło, które doprowadziło do ruchu.

W tym przykładzie obowiązują te reguły:

  • Raport o źródle wizyt wskazuje wyszukiwane hasło (traffic_source_detail) tylko wtedy, gdy w danym dniu uzyskał co najmniej określoną liczbę wyświetleń konkretnego filmu. W tym przypadku views to dane, video_id to wymiar agregujący, a traffic_source_detail to wymiar zanonimizowany.

  • Raport zawiera dodatkowy wiersz zawierający dane dla wszystkich wartości parametru traffic_source_detail, które nie osiągnęły progu liczby wyświetleń. Taki wiersz zawiera łączną liczbę wyświetleń powiązanych z tymi hasłami, ale nie identyfikuje tych haseł.

W tabeli poniżej przedstawiono te reguły. Pierwsza tabela zawiera hipotetyczny zestaw nieprzetworzonych danych, którego YouTube użyje do wygenerowania raportu o źródłach wizyt, a druga tabela do samego raportu. W tym przykładzie próg liczby wyświetleń wynosi 10, co oznacza, że raport identyfikuje wyszukiwane hasło, jeśli do danego dnia film uzyskał co najmniej 10 wyświetleń. Rzeczywiste progi mogą się zmieniać.

Nieprzetworzone dane o ruchu w wyszukiwarce w przypadku danego filmu w YouTube

Załóżmy, że dane poniżej opisują ruch w YouTube związany z konkretnym filmem w danym dniu.

wyszukiwane słowa wyświetleń szacunkowy czas oglądania
styl gangma 100 200
psy 15 25
psy gangan 9 15
Oppa gangnam 5 8
jazda konna 2 5

Przykładowy raport o źródłach wizyt

Poniższa tabela przedstawia fragment raportu o źródłach wizyt, który YouTube może wygenerować na podstawie nieprzetworzonych danych w poprzedniej sekcji. (Rzeczywisty raport zawiera więcej wymiarów i danych). W tym przykładzie widać, że wyszukiwane hasła wyszukiwane są tylko wtedy, gdy uzyskały co najmniej 10 wyświetleń. Faktyczne progi mogą się zmieniać.

W trzecim wierszu raportu wartość wymiaru trafficSourceDetail to NULL. Dane views i estimatedMinutesWatched obejmują łącznie wyświetlenia i minuty czasu oglądania dla 3 wyszukiwanych haseł, które wygenerowały mniej niż 10 wyświetleń.

TrafficSourceDetails wyświetleń szacowane minuty
styl gangma 100 200
psy 15 25
NULL 16 28

Wymiary podlegające anonimizacji

Tabela poniżej zawiera wartości wymiarów, które są anonimizowane, jeśli powiązane wartości danych nie przekraczają określonej wartości progowej. W każdym przypadku wartość danych jest agregowana w ramach innego wymiaru. Jeśli np. dane to obejrzenia, a agregacja ma wymiar video_id, to jego wartość jest anonimizowana, chyba że film został wyświetlony określoną liczbę razy.

Dane Agregacja wymiarów Zanonimizowany wymiar Wartość zanonimizowana
subskrybenci_odbiorców identyfikator_kanału kod_kraju ZZ
subskrybenci_odbiorców identyfikator_kanału kod_regionu US-ZZ
subskrybenci_zagubieni identyfikator_kanału kod_kraju ZZ
subskrybenci_zagubieni identyfikator_kanału kod_regionu US-ZZ
komentarze identyfikator_filmu kod_kraju ZZ
komentarze identyfikator_filmu kod_regionu US-ZZ
polubienia identyfikator_filmu kod_kraju ZZ
polubienia identyfikator_filmu kod_regionu US-ZZ
nie podoba mi się identyfikator_filmu kod_kraju ZZ
nie podoba mi się identyfikator_filmu kod_regionu US-ZZ
obejrzenia identyfikator_filmu [age_group] NULL
obejrzenia identyfikator_filmu gender [płeć] NULL
obejrzenia video_id i traffic_source_detail, [traffic_source_detail] NULL
Liczba subskrybentów kanału identyfikator_kanału subscribed_status (stan subskrybenta) NULL

Przykładowe fragmenty kodu

Poniższe przykłady kodu pokazują, jak za pomocą interfejsu API utworzyć zadanie raportowania, a następnie pobrać raport dla tego zadania. Dla każdego języka są dostępne 2 przykładowe fragmenty kodu:

  1. Pierwszy przykład kodu pokazuje, jak pobrać listę dostępnych typów raportów, a następnie utworzyć nowe zadanie raportowania.

  2. Drugi przykład kodu pokazuje, jak pobrać raport dotyczący konkretnego zadania. Raporty można pobierać w ciągu 48 godzin od utworzenia zadania.

Uwaga: poniższe przykłady kodu mogą nie prezentować wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz w dokumentacji bibliotek klienta.

Java

Poniższe przykłady korzystają z biblioteki klienta w języku Java:

Przykład 1. Tworzenie zadania raportowania

Ten przykładowy kod wywołuje metodę reportTypes.list, aby pobrać listę dostępnych typów raportów. Wywołuje metodę jobs.create, by utworzyć nowe zadanie raportowania.

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

Przykład 2. Pobieranie raportu

Przykładowy kod wywołuje metodę jobs.list w celu pobrania listy zadań raportowania. Następnie wywołuje metodę reports.list z parametrem jobId ustawionym na określony identyfikator zadania, aby pobrać raporty utworzone w tym zadaniu. Na koniec zdefiniowano URL pobierania każdego raportu. 

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

Poniższe przykłady korzystają z biblioteki klienta PHP.

Przykład 1. Tworzenie zadania raportowania

Ten przykładowy kod wywołuje metodę reportTypes.list, aby pobrać listę dostępnych typów raportów. Wywołuje metodę jobs.create, by utworzyć nowe zadanie raportowania.

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

Przykład 2. Pobieranie raportu

Przykładowy kod wywołuje metodę jobs.list w celu pobrania listy zadań raportowania. Następnie wywołuje metodę reports.list z parametrem jobId ustawionym na określony identyfikator zadania, aby pobrać raporty utworzone w tym zadaniu. Na koniec zdefiniowano URL pobierania każdego raportu. 

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

Poniższe przykłady korzystają z biblioteki klienta w języku Python.

Przykład 1. Tworzenie zadania raportowania

Ten przykładowy kod wywołuje metodę reportTypes.list, aby pobrać listę dostępnych typów raportów. Wywołuje metodę jobs.create, by utworzyć nowe zadanie raportowania.

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

Przykład 2. Pobieranie raportu

Przykładowy kod wywołuje metodę jobs.list w celu pobrania listy zadań raportowania. Następnie wywołuje metodę reports.list z parametrem jobId ustawionym na określony identyfikator zadania, aby pobrać raporty utworzone w tym zadaniu. Na koniec zdefiniowano URL pobierania każdego raportu. 

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