YouTube Reporting API - Get Bulk Data Reports

Önemli: Günlük API raporları ve doldurma raporları, oluşturulduktan sonraki 60 gün boyunca kullanılabilir. Geçmiş veri raporları, oluşturulduktan sonraki 30 gün boyunca kullanılabilir.

Bu politika tüm raporlar ve raporlama işleri için dünya genelinde geçerlidir. Tüm ayrıntılar için YouTube Reporting API'nin düzeltme geçmişine bakın.

YouTube Reporting API, bir kanal veya içerik sahibine ait kapsamlı bir YouTube Analytics veri grubu içeren önceden tanımlanmış raporları destekler. Bu raporlar, YouTube Analytics API ile veya YouTube Studio'nun Analytics bölümünde sorgulayabileceğiniz toplu veri kümelerini indirmenize olanak tanır.

API, Raporlar menüsündeki ilgili raporlara erişimi olan içerik sahiplerinin kullanabileceği, otomatik olarak oluşturulan ve sistem tarafından yönetilen bir rapor grubunu da destekler. Bu raporlar, reklam geliri verilerini ve YouTube Premium abonelik geliri verilerini içerir. Daha fazla bilgi için sistem tarafından yönetilen raporlar dokümanlarına bakın.

Genel Bakış

Bu raporlardaki rapor alanları boyut veya metrik olarak tanımlanır:

  • Boyutlar, bir işlemin gerçekleştiği tarih veya kullanıcıların bulunduğu ülke gibi verileri toplamak için kullanılan ortak ölçütlerdir. Bir rapordaki her veri satırında benzersiz bir boyut değeri kombinasyonu bulunur.
  • Metrikler, kullanıcı etkinliği, reklam performansı veya tahmini gelirle ilgili bağımsız ölçümlerdir. Kullanıcı etkinliği metrikleri arasında video görüntüleme sayısı ve puanlar (beğenme ve beğenmeme) gibi metrikler yer alır.

Örneğin, kanallar için temel kullanıcı etkinliği raporu aşağıdaki boyutları içerir:

  • day: Etkinliğin gerçekleştiği tarih.
  • channel: Etkinlikle ilişkili YouTube kanalı.
  • video: Etkinlikle ilişkili YouTube videosu.
  • liveOrOnDemand: İzleyicilerin canlı video yayını izleyip izlemediğini belirten bir değerdir.
  • subscribedStatus: İzleyicilerin kanala abone olup olmadığını belirten bir değerdir.
  • country: İzleyicilerin bulunduğu ülke.

Raporda görüntülemeler, beğeniler ve averageViewDuration gibi birçok metrik de yer alır. Bir uygulama, raporu aldıktan ve içe aktardıktan sonra ortak boyut değerlerine göre birçok farklı hesaplama yapabilir.

Örneğin, Almanya'da belirli bir tarihte toplam görüntüleme sayısını hesaplamak için country sütun değerinin DE ve day sütun değerinin YYYY-MM-DD biçiminde tarih olduğu tüm satırların views metrik değerlerini toplayın.

YouTube Analytics raporlarını alma

Aşağıdaki adımlarda, API üzerinden kanal ve içerik sahibi raporlarının nasıl alınacağı açıklanmaktadır. Bu raporların nasıl alınacağıyla ilgili talimatlar için sistem tarafından yönetilen raporlar başlıklı makaleyi inceleyin.

1. adım: Yetkilendirme kimlik bilgilerini alın

Tüm YouTube Reporting API istekleri yetkilendirilmelidir. OAuth 2.0 protokolü aracılığıyla yetkilendirme jetonlarını almak için Yetkilendirme kılavuzu başlıklı makaleyi inceleyin.

YouTube Reporting API istekleri aşağıdaki yetkilendirme kapsamlarını kullanır:

Kapsamlar
https://www.googleapis.com/auth/yt-analytics.readonly YouTube içeriğiniz için YouTube Analytics raporlarını görüntüleyin. Bu kapsam, görüntüleme sayısı ve puan sayısı gibi kullanıcı etkinliği metriklerine erişim sağlar.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube içeriğiniz için YouTube Analytics'teki parasal raporları görüntüleyin. Bu kapsam, kullanıcı etkinliği metriklerine, tahmini gelir ve reklam performansı metriklerine erişim sağlar.

2. adım: Alınacak raporu tanımlayın

Kanal veya içerik sahibi için oluşturulabilecek raporların listesini almak üzere API'nin reportTypes.list yöntemini çağırın. Yöntem, rapor kimliklerinin ve adlarının bir listesini döndürür. Oluşturulmasını istediğiniz raporlar için id mülk değerini yakalayın. Örneğin, kanallar için temel kullanıcı etkinliği raporunun kimliği channel_basic_a1'tür.

Rapor adlarını, desteklenen kanal raporlarını ve içerik sahibi raporlarını tanımlayan dokümanda da bulabilirsiniz.

3. Adım: Raporlama işi oluşturun

YouTube, rapor için bir raporlama işi oluşturmadığınız sürece raporunuzu oluşturmaya başlamaz. (Bu nedenle, raporlar yalnızca gerçekten almak isteyen kanallar ve içerik sahipleri için oluşturulur.)

Raporlama işi oluşturmak için API'nin jobs.create yöntemini çağırın. İstek gövdesinde aşağıdaki değerleri ayarlayın:

  • reportTypeId mülkünün değerini 2. adımda aldığınız rapor kimliğine ayarlayın.
  • name mülkünün değerini, raporla ilişkilendirmek istediğiniz ada ayarlayın.

jobs.create yöntemine verilen API yanıtı, işi benzersiz şekilde tanımlayan ID değerini belirten bir Job kaynağı içerir. Raporu, işin oluşturulmasından sonraki 48 saat içinde almaya başlayabilirsiniz. İlk rapor, işi planladığınız güne ait olur.

Örneğin, 1 Eylül'de bir iş planladıysanız 1 Eylül'e ait rapor 3 Eylül'de hazır olur. 2 Eylül'e ait rapor 4 Eylül'de yayınlanacaktır.

4. Adım: İş kimliğini alın

Not: Uygulamanız 3. adımda döndürülen iş kimliğini depoladıysa bu adımı atlayabilirsiniz.

Planlanmış işlerin listesini almak için jobs.list yöntemini çağırın. Döndürülen her Job kaynağındaki reportTypeId mülkü, ilgili işin oluşturduğu rapor türünü tanımlar. Uygulamanızın, aşağıdaki adımda aynı kaynaktan id mülk değerine ihtiyacı vardır.

5. Adım: Raporun indirme URL'sini alın

İş için oluşturulan raporların listesini almak üzere jobs.reports.list yöntemini çağırın. İstekte jobId parametresini, almak istediğiniz raporun iş kimliğine ayarlayın.

İpucu: API'nin yalnızca belirli bir zamandan sonra oluşturulan raporları döndürmesi gerektiğini belirtmek için createdAfter parametresini kullanın. Bu parametre, API'nin yalnızca daha önce işlemediğiniz raporları döndürmesini sağlamak için kullanılabilir.

API yanıtı, ilgili iş için Report kaynaklarının listesini içerir. Her kaynak, benzersiz bir 24 saatlik döneme ait veriler içeren bir raporu ifade eder. YouTube'un, veri bulunmayan günler için indirilebilir raporlar oluşturmadığını unutmayın. Bu raporlar bir başlık satırı içerir ancak ek veri içermez.

  • Kaynağın startTime ve endTime özellikleri, raporun verilerinin kapsadığı dönemi tanımlar.
  • Kaynağın downloadUrl mülkü, raporun alınabileceği URL'yi tanımlar.
  • Kaynağın createTime mülkü, raporun oluşturulduğu tarihi ve saati belirtir. Uygulamanız bu değeri depolamalı ve daha önce indirilen raporların değişip değişmediğini belirlemek için kullanmalıdır.

6. Adım: Raporu indirin

Raporu almak için 5. adımda elde edilen downloadUrl adresine bir HTTP GET isteği gönderin.

İndirme isteklerinde gzip sıkıştırmayı etkinleştirerek raporları indirmek için gereken bant genişliğini azaltabilirsiniz. Uygulamanızın, API yanıtlarını sıkıştırmak için ek CPU süresine ihtiyacı olsa da daha az ağ kaynağı tüketmenin avantajı genellikle bu maliyetten ağır basar.

Gzip ile kodlanmış bir yanıt almak için Accept-Encoding HTTP istek üst bilgisini aşağıdaki örnekte gösterildiği gibi gzip olarak ayarlayın:

Accept-Encoding: gzip

Raporları işleme

En iyi uygulamalar

YouTube Reporting API'yi kullanan uygulamalar her zaman aşağıdaki uygulamaları yapmalıdır:

  • Raporun sütunlarının sıralamasını belirlemek için raporun başlık satırını kullanın. Örneğin, görüntüleme sayısı, rapor açıklamasında listelenen ilk metrik olduğu için bir raporda döndürülen ilk metrik olacağını varsaymayın. Bunun yerine, hangi sütunun bu verileri içerdiğini belirlemek için raporun başlık satırını kullanın.

  • Aynı raporun tekrar tekrar işlenmesini önlemek için indirdiğiniz raporların kaydını tutun. Aşağıdaki listede bunu yapmanın birkaç yolu verilmiştir.

    • reports.list yöntemini çağırırken yalnızca belirli bir tarihten sonra oluşturulan raporları almak için createdAfter parametresini kullanın. (Raporları ilk kez aldığınızda createdAfter parametresini çıkarın.)

      Raporları her aldığınız ve başarılı bir şekilde işlediğinizde, bu raporların en yenisinin oluşturulduğu tarih ve saate karşılık gelen zaman damgasını saklayın. Ardından, API'yi her çağırdığınızda yalnızca doldurulmuş veriler içeren yeni raporlar da dahil olmak üzere yeni raporlar alabilmeniz için reports.list yöntemine yapılan her bir sonraki çağrıda createdAfter parametre değerini güncelleyin.

      Raporu almadan önce, rapor kimliğinin veritabanınızda listelenmediğinden emin olmak için de önlem alın.

    • İndirip işlediğiniz her raporun kimliğini saklayın. Ayrıca, her raporun oluşturulduğu tarih ve saat gibi ek bilgileri veya raporun startTime ve endTime değerlerini (birlikte raporun veri içerdiği dönemi tanımlar) de saklayabilirsiniz. Her rapor 24 saatlik bir süreye ait veriler içerdiğinden her işin muhtemelen birçok raporu olacağını unutmayın.

      İndirip içe aktarmanız gereken raporları belirlemek için rapor kimliğini kullanın. Ancak iki yeni raporda aynı startTime ve endTime mülk değerleri varsa yalnızca daha yeni createTime değerine sahip raporu içe aktarın.

  • Raporlar, YouTube kaynaklarıyla ilişkili kimlikleri içerir. Bu kaynaklarla ilgili ek meta veriler almak için YouTube Data API'yi kullanın. YouTube API Hizmetleri Geliştirici Politikaları'nda (III.E.4.b ila III.E.4.d bölümleri) belirtildiği gibi, API istemcileri 30 gün sonra ilgili API'deki depolanan kaynak meta verilerini silmeli veya yenilemelidir.

Rapor özellikleri

API raporları, aşağıdaki özelliklere sahip sürümlü .csv (virgülle ayrılmış değerler) dosyalarıdır:

  • Her rapor, Pasifik Standart Vakti (UTC-8) 00:00 ile 23:59 arasında süren benzersiz bir 24 saatlik döneme ait veriler içerir. Bu nedenle, herhangi bir raporda gün boyutu değeri her zaman aynıdır.

  • Raporlar günlük olarak güncellenir.

  • YouTube, veri bulunmayan günler için indirilebilir raporlar oluşturur. Bu raporlar bir başlık satırı içerir ancak ek veri içermez.

  • API raporları, yeni raporlama işleri için oluşturulan geçmiş veriler hariç olmak üzere oluşturulduktan sonraki 60 gün boyunca kullanılabilir. 60 günden eski raporlara erişilemez.
  • Geçmiş verileri içeren raporlar, oluşturulduktan sonraki 30 gün boyunca kullanılabilir. Geçmiş veriler içeren raporlara 30 günden eski olduklarında erişilemez.

  • Rapor verileri filtrelenmez. Bu nedenle, kanal raporları; aşağıdaki paragrafta belirtilen, silinen kaynaklarla ilgili istisnalar dışında, kanalın videoları veya oynatma listeleriyle ilgili tüm verileri içerir. Benzer şekilde, içerik sahibi raporu da içerik sahibinin kanallarına ait tüm verileri (videolar, oynatma listeleri, reklam performansı vb.) aşağıdaki istisna dışında içerir.

    Rapor verileri filtrelenmese de raporlar, raporun oluşturulduğu tarihten en az 30 gün önce silinmiş YouTube kaynaklarına referans vermez.

  • Rapor verileri sıralı değil.

  • Raporlar, metrik içermeyen satırları atlar. Diğer bir deyişle, metrik içermeyen satırlar rapordan hariç tutulur. Örneğin, bir videonun belirli bir günde Arnavutluk'ta hiç görüntüleme sayısı yoksa o güne ait raporda Arnavutluk için satır bulunmaz.

  • Raporlar, metrikler için özet veriler sağlayan satırlar (ör. bir kanalın tüm videolarının toplam görüntüleme sayısı) içermez. Bu toplam değerleri, rapordaki değerlerin toplamı olarak hesaplayabilirsiniz ancak bu toplam, yukarıda belirtildiği gibi silinmiş videolara ait metrikleri içermeyebilir. Toplam sayıları almak için YouTube Analytics API'yi de kullanabilirsiniz. YouTube Analytics API, API yanıtlarında açıkça referans verilmese bile silinmiş kaynakların metriklerini içeren toplam değerleri döndürür.

Verileri doldurma

Doldurma verileri, daha önce yayınlanmış bir veri kümesinin yerini alan veri kümesini ifade eder. Bir doldurma verisi raporu mevcut olduğunda uygulamanız yeni raporu almalıdır ve depolanan verilerinizi düzeltilen veri kümesiyle eşleşecek şekilde güncellemelidir. Örneğin, uygulamanız raporda kapsanan döneme ait önceki verileri silebilir ve ardından yeni veri kümesini içe aktarabilir.

YouTube'da doldurma verileri varsa yeni bir rapor kimliği içeren yeni bir rapor oluşturulur. Bu durumda, raporun startTime ve endTime mülk değerleri, daha önce mevcut olan ve daha önce indirmiş olabileceğiniz bir raporun başlangıç ve bitiş zamanlarıyla eşleşir.

Doldurma raporları, raporun oluşturulduğu tarihten en az 30 gün önce silinen YouTube kaynaklarına referans içermez.

Geçmiş verileri

Yeni bir raporlama işi planladığınızda YouTube, o günden itibaren geçmiş raporlar ve işi oluşturduğunuz tarihten önceki 30 günlük dönemi kapsayan raporlar oluşturur. Bu nedenle, bu dokümanda geçmiş veriler, raporlama işinin planlanmasından önceki bir döneme ait veriler içeren bir raporu ifade eder.

Geçmiş raporlar, hazır olur olmaz yayınlanır. Genellikle, bir iş için geçmiş verilerin tümü birkaç gün içinde yayınlanır. Rapor özellikleri bölümünde açıklandığı gibi, geçmiş veriler içeren raporlar oluşturulduktan sonraki 30 gün boyunca kullanılabilir. Geçmiş veriler içermeyen raporlar 60 gün boyunca kullanılabilir.

Veri anonimleştirme

YouTube izleyicilerinin anonimliğini sağlamak için bazı boyutların değerleri yalnızca aynı satırdaki bir metrik belirli bir eşiği karşılıyorsa döndürülür.

Örneğin, kanallara yönelik video trafik kaynağı raporunda her satır trafficSourceType ve trafficSourceDetail gibi çeşitli boyutlar içerir. Her satırda izleme sayısı gibi çeşitli metrikler de bulunur. YouTube aramasından gelen trafiği tanımlayan satırlarda trafficSourceDetail boyutu, trafiğe yol açan arama terimini tanımlar.

Bu örnekte aşağıdaki kurallar geçerlidir:

  • Trafik kaynağı raporu, sorgu terimini (trafficSourceDetail) yalnızca belirli bir günde belirli bir videonun en az belirli sayıda görüntülenmesine yol açtıysa tanımlar. Bu örnekte views metrik, video toplama boyutu ve trafficSourceDetail anonimleştirilmiş boyuttur.

  • Rapor, görüntüleme sayısı eşiğini karşılamayan tüm trafficSourceDetail değerlerinin metriklerini toplayan ek bir satır içerir. Bu satır, bu sorgu terimleriyle ilişkili toplam görüntüleme sayısını bildirir ancak terimlerin kendisini tanımlamaz.

Aşağıdaki tablolarda bu kurallar gösterilmektedir. İlk tabloda, YouTube'un trafik kaynağı raporu oluşturmak için kullanacağı varsayımsal bir ham veri grubu, ikinci tabloda ise raporun kendisi yer alır. Bu örnekte görüntüleme sayısı eşiği 10'dur. Yani rapor, yalnızca belirli bir gün belirli bir videonun en az 10 kez görüntülenmesine yol açan arama terimlerini tanımlar. (Gerçek eşikler değişebilir.)

Bir videonun ham YouTube arama trafiği verileri

Aşağıdaki verilerin, belirli bir günde belirli bir videoya yönelik YouTube arama trafiğini tanımladığını varsayalım.

arama terimi görüntüleme dakika cinsinden tahmini izleme süresi
gangnam style 100 200
psy 15 25
psy gangnam 9 15
oppa gangnam 5 8
at binme dansı 2 5

Örnek trafik kaynağı raporu

Aşağıdaki tabloda, YouTube'un önceki bölümdeki ham veriler için oluşturacağı trafik kaynağı raporundan bir alıntı gösterilmektedir. (Gerçek rapor daha fazla boyut ve metrik içerir.) Bu örnekte rapor, arama terimlerini yalnızca en az 10 görüntülemeye yol açmaları durumunda tanımlar. Gerçek eşikler değişebilir.

Raporun üçüncü satırındaki trafficSourceDetail boyut değeri NULL. views ve estimatedMinutesWatched metrikleri, 10'dan az görüntüleme elde eden üç arama terimi için birleştirilmiş görüntüleme sayısını ve izlenen dakika sayısını içerir.

trafficSourceDetail görüntüleme estimatedMinutesWatched
gangnam style 100 200
psy 15 25
NULL 16 28

Anonimleştirmeye tabi boyutlar

Aşağıdaki tabloda, ilişkili metrik değerleri belirli bir eşiği karşılamıyorsa anonimleştirilen boyut değerleri tanımlanmaktadır. Her durumda, metriğin değeri başka bir boyut üzerinden toplanır. Örneğin, metrik görüntüleme sayısı ve toplama boyutu video ise video belirli bir sayıda görüntülenmediği sürece boyut değeri anonimleştirilir.

Metrik Toplama boyutları Anonimleştirilmiş boyut Anonimleştirilmiş değer
subscribersGained channel country ZZ
subscribersGained channel province US-ZZ
subscribersLost channel country ZZ
subscribersLost channel province US-ZZ
comments video country ZZ
comments video province US-ZZ
beğenme video country ZZ
beğenme video province US-ZZ
beğenmeme video country ZZ
beğenmeme video province US-ZZ
görüntüleme video ageGroup NULL
görüntüleme video gender NULL
görüntüleme video ve trafficSourceDetail trafficSourceDetail NULL
Kanalın abone sayısı channel subscribedStatus NULL

Kod örnekleri

Aşağıdaki kod örnekleri, raporlama işi oluşturmak ve ardından bu iş için rapor almak üzere API'nin nasıl kullanılacağını göstermektedir. Her dil için iki kod örneği sağlanır:

  1. İlk kod örneğinde, kullanılabilir rapor türlerinin listesinin nasıl alınacağı ve ardından yeni bir raporlama işinin nasıl oluşturulacağı gösterilmektedir.

  2. İkinci kod örneğinde, belirli bir iş için raporun nasıl alınacağı gösterilmektedir. Raporları, işin oluşturulmasından sonraki 48 saat içinde almaya başlayabilirsiniz.

Not: Aşağıdaki kod örnekleri, desteklenen tüm programlama dillerini kapsamayabilir. Desteklenen dillerin listesi için istemci kitaplıklarına bakın.

Java

Aşağıdaki örneklerde Java istemci kitaplığı kullanılır:

1. örnek: Raporlama işi oluşturma

Aşağıdaki kod örneği, kullanılabilir rapor türlerinin listesini almak için reportTypes.list yöntemini çağırır. Ardından, yeni bir raporlama işi oluşturmak için jobs.create yöntemini çağırır.

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

2. örnek: Rapor alma

Kod örneği, raporlama işlerinin listesini almak için jobs.list yöntemini çağırır. Ardından, ilgili iş tarafından oluşturulan raporları almak için jobId parametresi belirli bir iş kimliğine ayarlanmış şekilde reports.list yöntemini çağırır. Son olarak örnek, her raporun indirme URL'sini yazdırır. 

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

Aşağıdaki örneklerde PHP istemci kitaplığı kullanılmaktadır.

1. örnek: Raporlama işi oluşturma

Aşağıdaki kod örneği, kullanılabilir rapor türlerinin listesini almak için reportTypes.list yöntemini çağırır. Ardından, yeni bir raporlama işi oluşturmak için jobs.create yöntemini çağırır.

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

2. örnek: Rapor alma

Kod örneği, raporlama işlerinin listesini almak için jobs.list yöntemini çağırır. Ardından, ilgili iş tarafından oluşturulan raporları almak için jobId parametresi belirli bir iş kimliğine ayarlanmış şekilde reports.list yöntemini çağırır. Son olarak örnek, her raporun indirme URL'sini yazdırır.

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

Aşağıdaki örneklerde Python istemci kitaplığı kullanılmaktadır.

1. örnek: Raporlama işi oluşturma

Aşağıdaki kod örneği, kullanılabilir rapor türlerinin listesini almak için reportTypes.list yöntemini çağırır. Ardından, yeni bir raporlama işi oluşturmak için jobs.create yöntemini çağırır.

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

2. örnek: Rapor alma

Kod örneği, raporlama işlerinin listesini almak için jobs.list yöntemini çağırır. Ardından, ilgili iş tarafından oluşturulan raporları almak için jobId parametresi belirli bir iş kimliğine ayarlanmış şekilde reports.list yöntemini çağırır. Son olarak örnek, her raporun indirme URL'sini yazdırır.

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