YouTube Reporting API - Data Model

Penting: Laporan Daily API dan laporan pengisian ulang tersedia selama 60 hari sejak dibuat. Laporan Data historis tersedia selama 30 hari sejak dibuat.

Kebijakan ini berlaku secara global untuk semua tugas pelaporan dan pelaporan. Untuk mengetahui detail selengkapnya, lihat histori revisi YouTube Reporting API.

YouTube Reporting API mendukung laporan standar yang berisi kumpulan data YouTube Analytics yang komprehensif untuk sebuah channel atau pemilik konten. Laporan ini memungkinkan Anda mendownload set data massal yang dapat Anda kueri dengan YouTube Analytics API atau di bagian Analytics di Creator Studio.

API ini juga mendukung serangkaian laporan yang dibuat secara otomatis dan dikelola sistem, yang tersedia bagi pemilik konten yang memiliki akses ke laporan terkait di menu Laporan. Laporan tersebut berisi data pendapatan iklan dan data pendapatan langganan YouTube Premium. Lihat dokumentasi laporan yang dikelola sistem untuk informasi selengkapnya.

Ringkasan

Kolom laporan dalam laporan ini ditandai sebagai dimensi atau metrik:

  • Dimensi adalah kriteria umum yang digunakan untuk menggabungkan data, seperti tanggal terjadinya tindakan atau negara tempat pengguna berada. Dalam laporan, setiap baris data memiliki kombinasi nilai dimensi yang unik.
  • Metrik adalah pengukuran individual yang terkait dengan aktivitas pengguna, performa iklan, atau estimasi pendapatan. Metrik aktivitas pengguna mencakup hal-hal seperti jumlah tontonan video dan rating (suka dan tidak suka).

Misalnya, laporan aktivitas pengguna dasar untuk saluran berisi dimensi berikut:

  • day: Tanggal terjadinya aktivitas.
  • channel: Channel YouTube yang terkait dengan aktivitas.
  • video: Video YouTube yang terkait dengan aktivitas.
  • liveOrOnDemand: Nilai yang menunjukkan apakah penonton menonton streaming video live atau tidak.
  • subscribedStatus: Nilai yang menunjukkan apakah penonton telah subscribe ke channel.
  • country: Negara tempat penonton berada.

Laporan ini juga berisi banyak metrik, seperti penayangan, suka, dan averageViewDuration. Setelah mengambil dan mengimpor laporan, aplikasi dapat melakukan banyak penghitungan yang berbeda berdasarkan nilai dimensi umum.

Misalnya, untuk menghitung jumlah total penayangan di Jerman pada tanggal tertentu, jumlahkan nilai metrik tampilan untuk semua baris dengan nilai kolom country DE dan nilai kolom hari adalah tanggal dalam format YYYY-MM-DD.

Mengambil laporan YouTube Analytics

Langkah-langkah berikut menjelaskan cara mengambil laporan pemilik konten dan channel melalui API. Lihat dokumentasi laporan yang dikelola sistem untuk mendapatkan petunjuk tentang cara mengambil laporan tersebut.

Langkah 1: Ambil kredensial otorisasi

Semua permintaan YouTube Reporting API harus diberi otorisasi. Panduan otorisasi menjelaskan cara menggunakan protokol OAuth 2.0 untuk mengambil token otorisasi.

Permintaan YouTube Reporting API menggunakan cakupan otorisasi berikut:

Cakupan
https://www.googleapis.com/auth/yt-analytics.readonly Melihat laporan YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna, seperti jumlah penayangan dan jumlah rating.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Lihat laporan moneter YouTube Analytics untuk konten YouTube Anda. Cakupan ini memberikan akses ke metrik aktivitas pengguna serta estimasi pendapatan dan metrik performa iklan.

Langkah 2: Identifikasi laporan yang akan diambil

Panggil metode reportTypes.list API untuk mengambil daftar laporan yang dapat dibuat untuk pemilik konten atau channel. Metode ini akan menampilkan daftar ID dan nama laporan. Catat nilai properti id untuk laporan yang ingin Anda buat. Misalnya, ID laporan aktivitas pengguna dasar untuk saluran adalah channel_basic_a1.

Anda juga dapat menemukan nama laporan dalam dokumentasi yang menentukan laporan channel dan laporan pemilik konten yang didukung.

Langkah 3: Buat tugas pelaporan

YouTube tidak mulai membuat laporan hingga Anda membuat tugas pelaporan untuk laporan tersebut. (Oleh karena itu, laporan hanya dibuat untuk pemilik konten dan channel yang benar-benar ingin mendapatkannya.)

Untuk membuat tugas pelaporan, panggil metode jobs.create API. Tetapkan nilai berikut dalam isi permintaan:

  • Tetapkan nilai properti reportTypeId ke ID laporan yang Anda ambil di langkah 2.
  • Tetapkan nilai properti name ke nama yang ingin Anda kaitkan dengan laporan.

Respons API terhadap metode jobs.create berisi resource Job, yang menentukan ID yang mengidentifikasi tugas secara unik. Anda dapat mulai mengambil laporan dalam waktu 48 jam sejak tugas dibuat, dan laporan pertama yang tersedia adalah untuk hari saat Anda menjadwalkan tugas tersebut.

Misalnya, jika Anda menjadwalkan tugas pada 1 September, laporan untuk 1 September akan siap pada 3 September. Laporan untuk 2 September akan diposting pada 4 September dan seterusnya.

Langkah 4: Ambil ID pekerjaan

Catatan: Jika aplikasi Anda menyimpan ID pekerjaan yang ditampilkan di langkah 3, Anda dapat melewati langkah ini.

Panggil metode jobs.list untuk mengambil daftar tugas terjadwal. Properti reportTypeId di setiap resource Job yang ditampilkan mengidentifikasi jenis laporan yang dihasilkan tugas tersebut. Aplikasi Anda memerlukan nilai properti id dari resource yang sama pada langkah berikut.

Langkah 5: Ambil URL download laporan

Panggil metode jobs.reports.list untuk mengambil daftar laporan yang dibuat untuk tugas. Dalam permintaan, tetapkan parameter jobId ke ID tugas laporan yang ingin Anda ambil.

Tips: Gunakan parameter createdAfter untuk menunjukkan bahwa API hanya boleh menampilkan laporan yang dibuat setelah waktu yang ditentukan. Parameter ini dapat digunakan untuk memastikan bahwa API hanya menampilkan laporan yang belum Anda proses.

Respons API berisi daftar resource Report untuk tugas tersebut. Setiap sumber daya mengacu pada laporan yang berisi data untuk periode 24 jam yang unik. Perhatikan bahwa YouTube memang menghasilkan laporan yang dapat didownload selama hari-hari ketika data tidak tersedia. Laporan tersebut berisi baris header tetapi tidak berisi data tambahan.

  • Properti startTime dan endTime resource mengidentifikasi jangka waktu yang dicakup data laporan.
  • Properti downloadUrl resource mengidentifikasi URL tempat laporan dapat diambil.
  • Properti createTime resource menentukan tanggal dan waktu laporan dibuat. Aplikasi Anda harus menyimpan nilai ini dan menggunakannya untuk menentukan apakah laporan yang didownload sebelumnya telah berubah.

Langkah 6: Download laporan

Kirim permintaan GET HTTP ke downloadUrl yang diperoleh pada langkah 5 untuk mengambil laporan.

Anda dapat mengurangi bandwidth yang diperlukan untuk mendownload laporan dengan mengaktifkan kompresi gzip pada permintaan download. Meskipun aplikasi Anda akan memerlukan waktu CPU tambahan untuk membatalkan kompresi respons API, manfaat dari menggunakan lebih sedikit resource jaringan biasanya lebih besar daripada biayanya.

Untuk menerima respons yang dienkode dengan gzip, setel header permintaan HTTP Accept-Encoding ke gzip seperti yang ditunjukkan dalam contoh berikut:

Accept-Encoding: gzip

Memproses laporan

Praktik terbaik

Aplikasi yang menggunakan YouTube Reporting API harus selalu mengikuti praktik berikut:

  • Untuk menentukan urutan kolom laporan, gunakan baris header laporan. Misalnya, jangan berasumsi bahwa tampilan akan menjadi metrik pertama yang ditampilkan dalam laporan hanya karena metrik ini pertama kali tercantum dalam deskripsi laporan. Sebagai gantinya, gunakan baris header laporan untuk menentukan kolom yang berisi data tersebut.

  • Untuk menghindari berulang kali memproses laporan yang sama, simpan data laporan yang telah Anda download. Daftar berikut menyarankan beberapa cara untuk melakukannya.

    • Saat memanggil metode reports.list, gunakan parameter createdAfter untuk hanya mengambil laporan yang dibuat setelah tanggal tertentu. (Hapus parameter createdAfter saat pertama kali Anda mengambil laporan.)

      Setiap kali Anda mengambil dan berhasil memproses laporan, simpan stempel waktu yang sesuai dengan tanggal dan waktu saat laporan terbaru tersebut dibuat. Kemudian, perbarui nilai parameter createdAfter pada setiap panggilan berturut-turut ke metode reports.list untuk memastikan Anda hanya mengambil laporan baru, termasuk laporan baru dengan data yang diisi ulang, setiap kali Anda memanggil API.

      Sebagai pengamanan, sebelum mengambil laporan, pastikan juga bahwa ID laporan belum tercantum dalam database Anda.

    • Simpan ID untuk setiap laporan yang telah Anda download dan proses. Anda juga dapat menyimpan informasi tambahan seperti tanggal dan waktu saat setiap laporan dibuat atau startTime dan endTime laporan, yang bersama-sama mengidentifikasi periode saat laporan berisi data. Perhatikan bahwa setiap tugas mungkin akan memiliki banyak laporan karena setiap laporan berisi data selama jangka waktu 24 jam.

      Gunakan ID laporan untuk mengidentifikasi laporan yang masih harus didownload dan diimpor. Namun, jika dua laporan baru memiliki nilai properti startTime dan endTime yang sama, hanya impor laporan dengan nilai createTime yang lebih baru.

  • Laporan berisi ID yang terkait dengan resource YouTube. Untuk mengambil metadata tambahan untuk resource tersebut, gunakan YouTube Data API. Sebagaimana tercantum dalam Kebijakan Developer Layanan YouTube API (bagian III.E.4.b hingga III.E.4.d), klien API harus menghapus atau memperbarui metadata resource yang disimpan dari API tersebut setelah 30 hari.

Karakteristik laporan

Laporan API adalah file .csv berversi (nilai yang dipisahkan koma) yang memiliki karakteristik berikut:

  • Setiap laporan berisi data untuk periode 24 jam yang unik yang berlangsung dari pukul 00.00 hingga 23.59 waktu Pasifik. Dengan demikian, dalam laporan tertentu, nilai dimensi hari selalu sama.

  • Laporan diperbarui setiap hari.

  • YouTube memang menghasilkan laporan yang dapat didownload selama beberapa hari ketika tidak ada data yang tersedia. Laporan tersebut akan berisi baris header tetapi tidak akan berisi data tambahan.

  • Laporan API tersedia selama 60 hari sejak dibuat, kecuali data historis yang dibuat untuk tugas pelaporan baru. Laporan tidak dapat diakses setelah lebih dari 60 hari, yang sudah lebih dari 60 hari.
  • Laporan yang berisi data historis tersedia selama 30 hari sejak dibuat. Laporan yang berisi data historis tidak dapat diakses setelah lebih dari 30 hari.

  • Data laporan tidak difilter. Oleh karena itu, laporan channel berisi semua data untuk video atau playlist channel, kecuali yang tercantum dalam paragraf berikut terkait resource yang telah dihapus. Demikian juga, laporan pemilik konten berisi semua data untuk saluran pemilik konten (video, daftar putar, kinerja iklan, dll.) dengan pengecualian berikut.

    Meskipun data laporan tidak difilter, laporan tidak akan berisi referensi apa pun ke referensi YouTube yang telah dihapus setidaknya 30 hari sebelum tanggal laporan dibuat.

  • Data laporan tidak diurutkan.

  • Laporan menghilangkan baris yang tidak memiliki metrik. Dengan kata lain, baris yang tidak memiliki metrik akan dikecualikan dari laporan. Misalnya, jika video tidak memiliki penayangan di Albania pada hari tertentu, laporan hari tersebut tidak akan berisi baris untuk Albania.

  • Laporan tidak berisi baris yang memberikan data ringkasan untuk metrik, seperti jumlah total penayangan semua video di channel. Anda dapat menghitung total nilai tersebut sebagai jumlah nilai dalam laporan, tetapi jumlah tersebut mungkin tidak termasuk metrik untuk video yang dihapus, seperti yang disebutkan di atas. Anda juga dapat menggunakan YouTube Analytics API untuk mengambil jumlah total. YouTube Analytics API tidak menampilkan total nilai yang menyertakan metrik untuk resource yang dihapus, meskipun resource tersebut tidak dirujuk secara eksplisit dalam respons API.

Isi ulang data

Data isi ulang mengacu pada set data yang menggantikan set yang dikirim sebelumnya. Saat laporan data pengisian ulang tersedia, aplikasi Anda seharusnya mengambil laporan baru dan memperbarui data yang disimpan agar sesuai dengan set data yang direvisi. Misalnya, aplikasi Anda dapat menghapus data sebelumnya untuk jangka waktu yang dicakup dalam laporan, lalu mengimpor set data baru.

Jika YouTube memiliki data pengisian ulang, YouTube akan membuat laporan baru dengan ID laporan baru. Dalam hal ini, nilai properti startTime dan endTime laporan akan cocok dengan waktu mulai dan berakhir laporan yang sebelumnya tersedia dan yang mungkin telah Anda download sebelumnya.

Laporan pengisian ulang tidak berisi referensi apa pun ke referensi YouTube yang telah dihapus minimal 30 hari sebelum tanggal pembuatan laporan.

Data historis

Jika Anda menjadwalkan tugas pelaporan baru, YouTube akan membuat laporan historis sejak hari tersebut dan seterusnya, serta menghasilkan laporan yang mencakup periode 30 hari sebelum Anda membuat tugas tersebut. Oleh karena itu, dalam dokumentasi ini, data historis mengacu pada laporan yang berisi data selama jangka waktu tertentu sebelum tugas pelaporan dijadwalkan.

Laporan historis diposting segera setelah tersedia. Biasanya, semua data historis diposting untuk informasi lowongan dalam beberapa hari. Seperti yang dijelaskan di bagian Karakteristik laporan, laporan yang berisi data historis tersedia selama 30 hari sejak dibuat. Laporan yang berisi data non-historis tersedia selama 60 hari.

Anonimisasi data

Untuk memastikan anonimitas penonton YouTube, nilai untuk beberapa dimensi hanya ditampilkan jika metrik di baris yang sama memenuhi nilai minimum tertentu.

Misalnya, dalam laporan sumber traffic video untuk saluran, setiap baris berisi sejumlah dimensi, termasuk trafficSourceType dan trafficSourceDetail. Setiap baris juga berisi berbagai metrik, termasuk tampilan. Pada baris yang mendeskripsikan traffic yang berasal dari penelusuran YouTube, dimensi trafficSourceDetail mengidentifikasi istilah penelusuran yang menghasilkan traffic.

Dalam contoh ini, aturan berikut berlaku:

  • Laporan sumber traffic mengidentifikasi istilah kueri (trafficSourceDetail) hanya jika istilah ini menghasilkan setidaknya sejumlah penayangan tertentu dari video tertentu pada hari tertentu. Dalam hal ini, penayangan adalah metrik, video adalah dimensi gabungan, dan trafficSourceDetail adalah dimensi anonim.

  • Laporan ini menyertakan baris tambahan yang menggabungkan metrik untuk semua nilai trafficSourceDetail yang tidak memenuhi nilai minimum jumlah penayangan. Baris tersebut melaporkan jumlah total tampilan yang dikaitkan dengan istilah kueri tersebut, tetapi tidak mengidentifikasi istilah itu sendiri.

Tabel berikut menggambarkan aturan tersebut. Tabel pertama berisi kumpulan hipotetis data mentah yang akan digunakan YouTube untuk membuat laporan sumber traffic, dan tabel kedua berisi laporan itu sendiri. Dalam contoh ini, nilai minimum jumlah penayangannya adalah 10. Artinya, laporan hanya mengidentifikasi istilah penelusuran jika video tertentu menghasilkan setidaknya 10 penayangan pada hari tertentu. (Nilai minimum yang sebenarnya dapat berubah.)

Data traffic penelusuran YouTube mentah untuk video

Asumsikan bahwa data di bawah ini menjelaskan lalu lintas penelusuran YouTube ke video tertentu pada hari tertentu.

istilah penelusuran penayangan taksiran menit ditonton
gaya gangnam 100 200
psy 15 25
psy gangnam 9 15
Oppa Gangnam 5 8
tarian berkuda 2 5

Contoh laporan sumber traffic

Tabel berikut menunjukkan kutipan dari laporan sumber traffic yang akan dibuat YouTube untuk data mentah di bagian sebelumnya. (Laporan yang sebenarnya akan berisi lebih banyak dimensi dan metrik.) Dalam contoh ini, laporan mengidentifikasi istilah penelusuran hanya jika istilah tersebut menghasilkan setidaknya 10 penayangan. Nilai minimum yang sebenarnya dapat berubah.

Di baris ketiga laporan, nilai dimensi trafficSourceDetail adalah NULL. Metrik views dan estimatedMinutesWatched berisi gabungan penayangan dan menit ditonton untuk tiga istilah penelusuran yang menghasilkan kurang dari 10 penayangan.

trafficSourceDetail penayangan estimatedMinutesWatched
gaya gangnam 100 200
psy 15 25
NULL 16 28

Dimensi yang tunduk kepada anonimisasi

Tabel berikut mengidentifikasi nilai dimensi yang dianonimkan jika nilai metrik yang terkait tidak memenuhi nilai minimum tertentu. Dalam setiap kasus, nilai metrik digabungkan berdasarkan dimensi lain. Misalnya, jika metrik adalah penayangan dan dimensi gabungannya adalah video, nilai dimensi akan dianonimkan kecuali video tersebut ditonton beberapa kali.

Metrik Menggabungkan dimensi Dimensi yang dianonimisasi Nilai yang dianonimisasi
subscribersGained channel country ZZ
subscribersGained channel province US-ZZ
subscribersLost channel country ZZ
subscribersLost channel province US-ZZ
komentar video country ZZ
komentar video province US-ZZ
suka video country ZZ
suka video province US-ZZ
tidak suka video country ZZ
tidak suka video province US-ZZ
penayangan video ageGroup NULL
penayangan video gender NULL
penayangan video dan trafficSourceDetail trafficSourceDetail NULL
Jumlah subscriber channel channel subscribedStatus NULL

Contoh kode

Contoh kode berikut menunjukkan cara menggunakan API untuk membuat tugas pelaporan, lalu mengambil laporan untuk tugas tersebut. Dua contoh kode diberikan untuk setiap bahasa:

  1. Contoh kode pertama menunjukkan cara mengambil daftar jenis laporan yang tersedia, lalu membuat tugas pelaporan baru.

  2. Contoh kode kedua menunjukkan cara mengambil laporan untuk tugas tertentu. Anda dapat mulai mengambil laporan dalam waktu 48 jam sejak tugas dibuat.

Catatan: Contoh kode berikut mungkin tidak mewakili semua bahasa pemrograman yang didukung. Lihat dokumentasi library klien untuk mengetahui daftar bahasa yang didukung.

Java

Contoh berikut menggunakan library klien Java:

Contoh 1: Membuat tugas pelaporan

Contoh kode berikut memanggil metode reportTypes.list untuk mengambil daftar jenis laporan yang tersedia. Kemudian, sistem akan memanggil metode jobs.create untuk membuat tugas pelaporan baru.

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

Contoh 2: Mengambil laporan

Contoh kode memanggil metode jobs.list untuk mengambil daftar tugas pelaporan. Selanjutnya, metode ini akan memanggil metode reports.list dengan parameter jobId yang ditetapkan ke ID tugas tertentu untuk mengambil laporan yang dibuat oleh tugas tersebut. Terakhir, contoh akan mencetak URL download untuk setiap laporan. 

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

Contoh berikut menggunakan library klien PHP.

Contoh 1: Membuat tugas pelaporan

Contoh kode berikut memanggil metode reportTypes.list untuk mengambil daftar jenis laporan yang tersedia. Kemudian, sistem akan memanggil metode jobs.create untuk membuat tugas pelaporan baru.

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

Contoh 2: Mengambil laporan

Contoh kode memanggil metode jobs.list untuk mengambil daftar tugas pelaporan. Selanjutnya, metode ini akan memanggil metode reports.list dengan parameter jobId yang ditetapkan ke ID tugas tertentu untuk mengambil laporan yang dibuat oleh tugas tersebut. Terakhir, contoh akan mencetak URL download untuk setiap laporan.

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

Contoh berikut menggunakan library klien Python.

Contoh 1: Membuat tugas pelaporan

Contoh kode berikut memanggil metode reportTypes.list untuk mengambil daftar jenis laporan yang tersedia. Kemudian, sistem akan memanggil metode jobs.create untuk membuat tugas pelaporan baru.

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

Contoh 2: Mengambil laporan

Contoh kode memanggil metode jobs.list untuk mengambil daftar tugas pelaporan. Selanjutnya, metode ini akan memanggil metode reports.list dengan parameter jobId yang ditetapkan ke ID tugas tertentu untuk mengambil laporan yang dibuat oleh tugas tersebut. Terakhir, contoh akan mencetak URL download untuk setiap laporan.

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