YouTube Reporting API - Data Model

重要: 予定されているポリシーの変更は、YouTube Reporting API のレポートを取得できる期間に影響します。変更後、日次 API レポートとバックフィル レポートは、作成後 60 日間（180 日間ではなく）利用できます。過去データのレポートは、作成後 30 日間ご利用いただけます。

現在のところ、今回の変更は 2018 年 7 月に実施される予定です。新しいポリシーはすべてのレポートとレポートジョブに全世界に適用されます。この変更について詳しくは、API の変更履歴をご覧ください。

YouTube Reporting API は、チャンネルやコンテンツ所有者の YouTube アナリティクス データの包括的なセットを含む事前定義レポートをサポートしています。これらのレポートでは、YouTube Analytics API または Creator Studio の [アナリティクス] セクションでクエリが可能な一括データセットをダウンロードできます。

概要

これらのレポートのフィールドは、ディメンションまたは指標のいずれかとして特徴付けられます。

  • ディメンションとは、データを集計するために使用される一般的な条件（アクションが発生した日付や、ユーザーが居住した国など）を指します。レポートでは、データの各行にはディメンション値の組み合わせが一意になっています。
  • 指標は、ユーザー アクティビティ、広告のパフォーマンス、推定収益に関連する個々の測定値です。ユーザー アクティビティの指標には、動画再生回数、評価（高評価と低評価）が含まれます。

たとえば、チャンネルの基本ユーザー アクティビティ レポートには、次のディメンションが含まれています。

  • date: アクティビティが発生した日付。
  • channel_id: アクティビティに関連付けられた YouTube チャンネル。
  • video_id: アクティビティに関連付けられた YouTube 動画。
  • live_or_on_demand: 視聴者がライブ動画ストリームを視聴しているかどうかを示します。
  • subscribed_status: 視聴者がチャンネルを登録しているかどうかを示します。
  • country_code: 視聴者が居住している国。

このレポートには、ビュー、高評価、average_view_duration_seconds など、多くの指標も含まれています。レポートの取得とインポート後、アプリケーションは共通のディメンション値に基づいて、さまざまな計算を行うことができるようになります。

YouTube アナリティクス レポートの取得

手順 1: 認証情報を取得する

すべての YouTube Reporting API のリクエストは承認される必要があります。認可ガイドでは、OAuth 2.0 プロトコルを使用して認証トークンを取得する方法を説明しています。

YouTube Reporting API のリクエストでは、次の認証スコープを使用します。

スコープ
https://www.googleapis.com/auth/yt-analytics.readonly YouTube コンテンツの YouTube アナリティクス レポートを表示します。このスコープは再生回数や評価数など、ユーザー アクティビティの指標へのアクセスを提供します。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly YouTube コンテンツに関する YouTube アナリティクス収益レポートを表示します。このスコープでは、ユーザー アクティビティの指標や、収益と広告パフォーマンスの推定指標を確認できます。

ステップ 2: 取得するレポートを特定する

API の reportTypes.list メソッドを呼び出して、チャンネルまたはコンテンツ所有者用に生成可能なレポートのリストを取得します。このメソッドは、レポート ID とレポート名のリストを返します。生成するレポートの id プロパティ値をキャプチャします。たとえば、チャネルの基本ユーザー アクティビティ レポートの ID は channel_basic_a1 です。

レポート名は、サポートされているチャンネル レポートとコンテンツ所有者レポートについて記載したドキュメントにも記載されています。

ステップ 3: レポートジョブを作成する

YouTube は、そのレポート用のレポートジョブを作成するまでレポートの生成を開始します。（そのため、実際にレポートを取得するチャンネルとコンテンツ所有者についてのみレポートが生成されます）。

レポートジョブを作成するには、API の jobs.create メソッドを呼び出します。リクエストの本文に次の値を設定します。

  • reportTypeId プロパティの値を手順 2 で取得したレポート ID に設定します。
  • name プロパティの値を、レポートに関連付ける名前に設定します。

jobs.create メソッドに対する API レスポンスには、ジョブを一意に識別する ID を指定する Job リソースが含まれています。ジョブの作成後 48 時間以内であれば、レポートの取得を開始できます。また、使用可能な最初のレポートは、ジョブをスケジュールした日のものになります。

たとえば、2015 年 9 月 1 日に求人のスケジュールを設定した場合、2015 年 9 月 1 日のレポートは 2015 年 9 月 3 日に確認できるようになります。たとえば、2015 年 9 月 2 日のレポートは 2015 年 9 月 4 日になどのように掲載されます。

ステップ 4: ジョブ ID を取得する

注: 手順 3 で返されたジョブ ID をアプリケーションが保存している場合は、この手順をスキップできます。

スケジュール設定されたジョブのリストを取得するには、jobs.list メソッドを呼び出します。返される各 Job リソースの reportTypeId プロパティは、そのジョブで生成されるレポートのタイプを識別します。次のステップでは、同じリソースの id プロパティ値をアプリケーションで指定する必要があります。

ステップ 5: レポートのダウンロード URL を取得する

jobs.reports.list メソッドを呼び出して、ジョブ用に作成されたレポートのリストを取得します。リクエストで、jobId パラメータを、取得するレポートのジョブ ID に設定します。

ヒント: createdAfter パラメータを使用して、指定した日時以降に作成されたレポートのみを API が返すように指定できます。このパラメータを使用すると、まだ処理していないレポートのみを API から返すことができます。

API レスポンスには、そのジョブの Report リソースのリストが含まれます。各リソースは、24 時間ごとのデータを含むデータを含む。データが利用できない日については、ダウンロード可能なレポートが作成されます。これらのレポートにはヘッダー行が含まれていますが、追加のデータは含まれていません。

  • リソースの startTime プロパティと endTime プロパティは、レポートのデータがカバーする期間を識別します。
  • リソースの downloadUrl プロパティは、レポートを取得するための URL を識別します。

  • リソースの createTime プロパティは、レポートが生成された日時を指定します。アプリはこの値を保存し、その値を使用して、以前にダウンロードしたレポートが変更されたかどうかを判断する必要があります。

ステップ 6: レポートをダウンロードする

ステップ 5 で取得した downloadUrl に HTTP GET リクエストを送信してレポートを取得します。

ダウンロード リクエストに対して gzip 圧縮を有効にすると、レポートのダウンロードに必要な帯域幅を減らすことができます。API レスポンスの解凍には追加の CPU 時間が必要になりますが、ネットワーク リソースの消費量低下には、そのコストを補うだけの利点があります。

gzip でエンコードされたレスポンスを受け取るには、次の例に示すように Accept-Encoding HTTP リクエスト ヘッダーを gzip に設定します。

Accept-Encoding: gzip

レポートを処理しています

おすすめの方法

YouTube Reporting API を使用するアプリケーションは、常に次のプラクティスに従ってください。

  • レポートのヘッダー行を使用して、レポートの列の順序を決定します。たとえば、レポートの説明のリストでは 1 つ目の指標である「ビュー」が、レポートで最初に表示される指標であると仮定しないでください。代わりに、レポートのヘッダー行を使用して、どの列にそのデータが含まれているかを確認します。

  • 同じレポートが繰り返し処理されないように、ダウンロードしたレポートを記録しておきます。以下に、その方法をいくつか紹介します。

    • reports.list メソッドを呼び出すときは、createdAfter パラメータを使用して、特定の日付以降に作成されたレポートのみを取得します。（レポートを初めて取得するときは createdAfter パラメータを省略します）。

      レポートを取得して正常に処理するたびに、そのレポートが最後に作成された日時に対応するタイムスタンプを保存します。その後、reports.list メソッドが呼び出されるたびに createdAfter パラメータ値を更新して、API を呼び出すたびに新しいデータ（バックフィルされたデータを含む新しいレポートを含む）のみを取得するようにします。

      安全措置として、レポートを取得する前に、レポートの ID がデータベースにリストされていないことも確認します。

    • ダウンロードして処理した各レポートの ID を保存します。また、各レポートが生成された日時や、レポートの startTime、endTime など、レポートにデータが含まれる期間を識別する追加情報を保存することもできます。各レポートには 24 時間のデータが含まれるため、各ジョブには多数のレポートが作成される可能性があります。

      レポート ID を使用して、ダウンロードとインポートが必要なレポートを確認します。ただし、2 つの新しいレポートに同じ startTime と endTime のプロパティ値がある場合は、新しい createTime 値でレポートをインポートしてください。

  • レポートには YouTube リソースに関連付けられた ID が含まれます。YouTube Data API を使用して、それらのリソースの追加メタデータを取得できます。YouTube API サービスのデベロッパー ポリシー（セクション III.E.4.b ～ III.E.4.d）に記載されているように、API クライアントは 30 日後に保存された API メタデータを削除または更新しなければなりません。

レポートの特性

API レポートは、以下の特性を持つ .csv（カンマ区切り値）形式のファイルです。

  • 各レポートには、太平洋時間の午前 0 時～午後 11 時 59 分までの 24 時間固有のデータが含まれます。そのため、どのレポートでも date ディメンション値は常に同じです。

  • レポートは毎日更新されます。

  • データが利用できない日について、ダウンロード可能なレポートが作成されます。これらのレポートにはヘッダー行が含まれますが、追加のデータは含まれません。

  • 重要: 予定されているポリシーの変更は、YouTube Reporting API のレポートを取得できる期間に影響します。この変更は現在 2018 年 7 月に適用される予定ですが、この変更はすべてのレポートとジョブに適用されます。

    • 変更前の API レポートは、生成してから最大 180 日間ご利用いただけます。
    • 変更後、API レポートは、新しいレポートジョブ用に生成される履歴データを除き、レポートが生成されてから 60 日間利用できます。ポリシーの変更が適用されると、60 日以上経過したレポートはアクセスできなくなります。
    • 変更後、過去のデータを含むレポートは生成日から 30 日間使用できます。ポリシーの変更が適用されると、過去のデータが含まれ、30 日以上経過したレポートはアクセスできなくなります。

  • レポートデータはフィルタリングされません。そのため、チャンネル レポートにはチャンネル内の動画や再生リストのすべてのデータが含まれますが、次の段落に記載されている例外は、削除したリソースに関連するものです。同様に、コンテンツ所有者レポートには、コンテンツ所有者のチャンネル（動画、再生リスト、広告のパフォーマンスなど）のすべてのデータが例外として記載されます。

    レポートデータはフィルタリングされませんが、2018 年 6 月 1 日以降のデータが含まれるレポートには、レポートが生成される 30 日前までに削除された YouTube リソースへの参照は含まれません。

  • レポートデータが並べ替えられていません。

  • 指標がない行はレポートから除外されます。つまり、指標がない行はレポートから除外されます。たとえば、アルバニアで視聴された動画がない場合、当日のレポートにはアルバニアの行は含まれません。

  • レポートには、動画の合計視聴回数など、指標の概要データを提供する行は含まれません。レポートの合計値としてそれらの値の合計を計算することもできますが、その合計値には、上で述べた削除済みの動画の指標が含まれていない場合があります。YouTube Analytics API を使用して合計数を取得することもできます。YouTube Analytics API は、削除されたリソースの指標を含む合計値を返します。ただし、それらのリソースは API レスポンスで明示的に参照されていません。

バックフィル データ

バックフィル データとは、以前配信されたデータセットに代わるデータセットのことです。バックフィル データレポートが利用可能になったら、アプリケーションは新しいレポートを取得し、改訂されたデータセットに合わせて保存データを更新します。たとえば、アプリケーションでレポートの対象期間の以前のデータを削除し、新しいデータセットをインポートできます。

YouTube にバックフィル データがある場合は、新しいレポート ID を含む新しいレポートが生成されます。この場合、レポートの startTime プロパティと endTime プロパティ値は、以前に利用でき、以前にダウンロードしたことがあるレポートの開始時間および終了時間と一致します。

2018 年 6 月 1 日以降のデータが含まれるバックフィル レポートには、レポート作成日の 30 日前までに削除された YouTube リソースへの参照は含まれません。

過去のデータ

新しいレポートジョブのスケジュールを設定すると、そのジョブが作成される前の期間を対象とした履歴レポートが作成されます。したがって、このドキュメントの「過去のデータ」とは、レポートジョブがスケジュールされる前の期間のデータを含むレポートを指します。

重要: 予定されているポリシーの変更は、履歴レポートデータが生成される期間に影響します。この変更は現在 2018 年 7 月に適用される予定ですが、この変更はすべてのレポートとジョブに適用されます。

  • ポリシーの変更前に新しいレポートジョブのスケジュールを設定すると、そのジョブが作成された時点から 180 日前のレポートが生成されます。
  • ポリシーの変更後、新しいレポートジョブのスケジュールを設定すると、そのジョブの 30 日前からレポートが生成されます。

過去のレポートは利用可能になり次第、掲載されます。通常、過去のデータはすべて、数日以内にジョブに送信されます。レポートの特性のセクションで説明したように、2018 年 7 月にポリシーの変更が適用されると、過去のデータを含むレポートは、作成後 30 日間利用できます。過去のデータを含まないレポートは、ポリシーの変更後 60 日間ご利用いただけます。

データの匿名化

YouTube ユーザーの匿名性を確保するため、一部のディメンションの値は、同じ行の指標が特定のしきい値を満たしている場合にのみ返されます。

たとえば、チャンネルの動画トラフィック ソース レポートでは、各行には traffic_source_type と traffic_source_detail などのさまざまなディメンションが含まれています。各行には、ビューなどのさまざまな指標が含まれています。YouTube 検索からのトラフィックを示す行で、traffic_source_detail ディメンションが、トラフィックにつながった検索キーワードを識別します。

この例では、以下のルールが適用されます。

  • トラフィック ソース レポートでは、特定の日に特定の動画の視聴回数が特定の回数以上に達した場合にのみ、term_source_detail がクエリ語句として識別されます。この場合、views は指標で、video_id は集計ディメンション、traffic_source_detail は匿名化されたディメンションです。

  • このレポートには、視聴回数のしきい値を満たしていないすべての traffic_source_detail の指標を集計する行が含まれています。その行にビューの合計件数が表示されます（ただし、クエリ自体は識別されません）。

次の表に、これらのルールを示します。最初のテーブルには、YouTube がトラフィック ソース レポートの生成に使用する元データのセットが含まれ、2 番目のテーブルにはレポート自体が含まれています。この例では、視聴回数のしきい値は 10 ですが、レポートでは特定の日に特定の動画が 10 回以上視聴された場合のみ、検索キーワードが識別されます。（実際のしきい値は変更される可能性があります）。

動画の YouTube 検索トラフィックの元データ

以下のデータは、特定の日付の特定の動画に対する YouTube の検索トラフィックを表しているとします。

検索語句 回 推定再生時間（分）
ガンナムスタイル 100 200
サイ 15 25
サイガンガナム 9 15
Oppa Gangnam 5 8
ダンスに乗る馬 2 5

トラフィック ソース レポートのサンプル

次の表は、前のセクションの元データ用に YouTube が生成するトラフィック ソース レポートの抜粋です。（実際のレポートには、より多くのディメンションと指標が含まれます）。この例では、視聴回数が 10 回以上の検索語句のみがレポートに表示されます。実際のしきい値は変更される可能性があります。

レポートの 3 行目の trafficSourceDetail ディメンション値は NULL です。views 指標と estimatedMinutesWatched 指標には、視聴回数が 10 回未満の 3 つの検索語句の合計視聴回数と視聴時間（分）が含まれています。

#trafficSourceDetail 回 推定再生時間（分）
ガンナムスタイル 100 200
サイ 15 25
NULL 16 28

匿名化対象のディメンション

次の表は、関連する指標値が特定のしきい値を満たさない場合に匿名化されるディメンション値を示しています。いずれの場合も、指標の値は別のディメンションに集計されます。たとえば、指標が視聴回数で、集計ディメンションが video_id の場合は、動画が一定の回数再生されない限り、ディメンションの値は匿名化されます。

指標 ディメンションの集計 匿名化されたディメンション 匿名化された値
subscribers_gained channel_id 国コード ZZ
subscribers_gained channel_id province_code US-ZZ
subscribers_lost channel_id 国コード ZZ
subscribers_lost channel_id province_code US-ZZ
comments video_id 国コード ZZ
comments video_id province_code US-ZZ
いいね video_id 国コード ZZ
いいね video_id province_code US-ZZ
低評価 video_id 国コード ZZ
低評価 video_id province_code US-ZZ
視聴回数 video_id age_group [年齢層] NULL
視聴回数 video_id 性別 NULL
視聴回数 video_id と traffic_source_detail traffic_source_detail NULL
チャンネルの登録者数 channel_id subscribed_status NULL

コードサンプル

次のコードサンプルは、API を使用してレポートジョブを作成し、そのジョブのレポートを取得する方法を示しています。言語ごとに次の 2 つのコードサンプルが用意されています。

  1. 1 つ目のコードサンプルは、利用可能なレポートタイプのリストを取得して、新しいレポートジョブを作成する方法を示しています。

  2. 2 つ目のコードサンプルは、特定のジョブのレポートを取得する方法を示しています。ジョブの作成後 48 時間以内であれば、レポートの取得を開始できます。

注: 以下のコードサンプルは、サポートされているすべてのプログラミング言語を表しているわけではありません。サポートされている言語の一覧については、クライアント ライブラリのドキュメントをご覧ください。

Java

次のサンプルでは、Java クライアント ライブラリを使用しています。

例 1: レポートジョブを作成する

次のコードサンプルは、reportTypes.list メソッドを呼び出して、利用可能なレポートタイプのリストを取得します。次に、jobs.create メソッドを呼び出して新しいレポートジョブを作成します。

/*
 * 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: レポートを取得する

このコードサンプルでは、jobs.list メソッドを呼び出して、レポートジョブのリストを取得します。次に、jobId パラメータを特定のジョブ ID に設定して reports.list メソッドを呼び出し、そのジョブによって作成されたレポートを取得します。最後に、各レポートのダウンロード URL を出力します。 

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

次のサンプルでは、PHP クライアント ライブラリを使用しています。

例 1: レポートジョブを作成する

次のコードサンプルは、reportTypes.list メソッドを呼び出して、利用可能なレポートタイプのリストを取得します。次に、jobs.create メソッドを呼び出して新しいレポートジョブを作成します。

<?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: レポートを取得する

このコードサンプルでは、jobs.list メソッドを呼び出して、レポートジョブのリストを取得します。次に、jobId パラメータを特定のジョブ ID に設定して reports.list メソッドを呼び出し、そのジョブによって作成されたレポートを取得します。最後に、各レポートのダウンロード URL を出力します。 

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

次のサンプルでは、Python クライアント ライブラリを使用しています。

例 1: レポートジョブを作成する

次のコードサンプルは、reportTypes.list メソッドを呼び出して、利用可能なレポートタイプのリストを取得します。次に、jobs.create メソッドを呼び出して新しいレポートジョブを作成します。

#!/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: レポートを取得する

このコードサンプルでは、jobs.list メソッドを呼び出して、レポートジョブのリストを取得します。次に、jobId パラメータを特定のジョブ ID に設定して reports.list メソッドを呼び出し、そのジョブによって作成されたレポートを取得します。最後に、各レポートのダウンロード URL を出力します。 

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