はじめてのアナリティクス API: サービスアカウント向け Java クイックスタート

このチュートリアルでは、Google アナリティクスアカウントへのアクセス、アナリティクス API へのクエリ、API レスポンスの処理、結果の出力のために必要な手順を詳しく説明していきます。このチュートリアルでは、Core Reporting API v3.0、Management API v3.0、OAuth2.0 を使用します。

ステップ 1: アナリティクス API を有効にする

Google アナリティクス API を使用するには、最初にセットアップツールを使用して Google API コンソールでプロジェクトを作成し、API を有効にして認証情報を作成する必要があります。

クライアント ID を作成する

[サービスアカウント] ページを開きます。画面のメッセージに従って、プロジェクトを選択します。
[ サービスアカウントを作成] をクリックして、サービスアカウントの名前と説明を入力します。デフォルトのサービスアカウント ID を使用することも、別の一意の ID を選択することもできます。入力したら、[作成] をクリックします。
以降の [サービスアカウントの権限（オプション）] セクションは必須ではありません。[続行] をクリックします。
[ユーザーにこのサービスアカウントへのアクセスを許可] 画面で、[キーの作成] セクションまで下にスクロールします。[ キーを作成] をクリックします。
表示されたサイドパネルで、キーの形式を選択します。JSON をおすすめします。
[作成] をクリックします。新しい公開鍵と秘密鍵のペアが生成され、パソコンにダウンロードされます。この鍵は再発行できませんので、安全に保管する方法については、サービスアカウントキーの管理をご覧ください。
[秘密鍵がパソコンに保存されました] ダイアログで [閉じる] をクリックし、[完了] をクリックしてサービスアカウントの表に戻ります。

[キーのタイプ] の入力を求められたら、[JSON] を選択し、生成されたキーを client_secrets.json として保存します。この情報はチュートリアルの後半で必要になります。

Google アナリティクスアカウントへのサービスアカウントの追加

新しく作成されたサービスアカウントには、メールアドレス <projectId>-<uniqueId>@developer.gserviceaccount.com が設定されます。このメールアドレスを使用して、API でアクセスする Google アナリティクスアカウントにユーザーを追加します。このチュートリアルでは、表示と分析の権限が必要です。

ステップ 2: Google クライアントライブラリをインストールする

Google Analytics API Java クライアントをインストールするには、解凍して Java クラスパスにコピーする必要があるすべての jar を含む zip ファイルをダウンロードする必要があります。

Google アナリティクス Java クライアントライブラリをダウンロードします。このライブラリは、必要な依存関係をすべて含む ZIP ファイルとしてバンドルされています。
ZIP ファイルを展開します
libs ディレクトリ内のすべての JAR をクラスパスに追加します。
google-api-services-analytics-v3-[version].jar jar をクラスパスに追加します。

Java 環境の詳細

Eclipse を使用している場合は、こちらでプロジェクトのクラスパスに JAR を追加する手順をご覧ください。

NetBeans を使用している場合は、こちらでプロジェクトのクラスパスに JAR を追加する手順をご覧ください。

IntelliJ IDEA を使用している場合は、こちらでプロジェクトのクラスパスに JAR を追加する手順をご覧ください。

コマンドラインから開発する場合は、javac コマンド呼び出しと java コマンド呼び出しに -classpath /path/to/directory/with/unzipped/jars を追加します。

ステップ 3: サンプルを設定する

HelloAnalytics.java という名前のファイルを 1 つ作成する必要があります。このファイルには指定のサンプルコードを記述します。

次のソースコードを HelloAnalytics.java にコピーまたはダウンロードします。
先ほどダウンロードした client_secrets.JSON をサンプルコードと同じディレクトリに移動します。
KEY_FILE_LOCATION の値は、Developer Console に表示された適切な値に置き換えます。

import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;

import com.google.api.services.analytics.Analytics;
import com.google.api.services.analytics.AnalyticsScopes;
import com.google.api.services.analytics.model.Accounts;
import com.google.api.services.analytics.model.GaData;
import com.google.api.services.analytics.model.Profiles;
import com.google.api.services.analytics.model.Webproperties;

import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.io.IOException;


/**
 * A simple example of how to access the Google Analytics API using a service
 * account.
 */
public class HelloAnalytics {


  private static final String APPLICATION_NAME = "Hello Analytics";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String KEY_FILE_LOCATION = "<REPLACE_WITH_JSON_FILE>";
  public static void main(String[] args) {
    try {
      Analytics analytics = initializeAnalytics();

      String profile = getFirstProfileId(analytics);
      System.out.println("First Profile Id: "+ profile);
      printResults(getResults(analytics, profile));
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  /**
   * Initializes an Analytics service object.
   *
   * @return An authorized Analytics service object.
   * @throws IOException
   * @throws GeneralSecurityException
   */
  private static AnalyticsReporting initializeAnalytic() throws GeneralSecurityException, IOException {

    HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
    GoogleCredential credential = GoogleCredential
        .fromStream(new FileInputStream(KEY_FILE_LOCATION))
        .createScoped(AnalyticsScopes.all());

    // Construct the Analytics service object.
    return new Analytics.Builder(httpTransport, JSON_FACTORY, credential)
        .setApplicationName(APPLICATION_NAME).build();
  }


  private static String getFirstProfileId(Analytics analytics) throws IOException {
    // Get the first view (profile) ID for the authorized user.
    String profileId = null;

    // Query for the list of all accounts associated with the service account.
    Accounts accounts = analytics.management().accounts().list().execute();

    if (accounts.getItems().isEmpty()) {
      System.err.println("No accounts found");
    } else {
      String firstAccountId = accounts.getItems().get(0).getId();

      // Query for the list of properties associated with the first account.
      Webproperties properties = analytics.management().webproperties()
          .list(firstAccountId).execute();

      if (properties.getItems().isEmpty()) {
        System.err.println("No Webproperties found");
      } else {
        String firstWebpropertyId = properties.getItems().get(0).getId();

        // Query for the list views (profiles) associated with the property.
        Profiles profiles = analytics.management().profiles()
            .list(firstAccountId, firstWebpropertyId).execute();

        if (profiles.getItems().isEmpty()) {
          System.err.println("No views (profiles) found");
        } else {
          // Return the first (view) profile associated with the property.
          profileId = profiles.getItems().get(0).getId();
        }
      }
    }
    return profileId;
  }

  private static GaData getResults(Analytics analytics, String profileId) throws IOException {
    // Query the Core Reporting API for the number of sessions
    // in the past seven days.
    return analytics.data().ga()
        .get("ga:" + profileId, "7daysAgo", "today", "ga:sessions")
        .execute();
  }

  private static void printResults(GaData results) {
    // Parse the response from the Core Reporting API for
    // the profile name and number of sessions.
    if (results != null && !results.getRows().isEmpty()) {
      System.out.println("View (Profile) Name: "
        + results.getProfileInfo().getProfileName());
      System.out.println("Total Sessions: " + results.getRows().get(0).get(0));
    } else {
      System.out.println("No results found");
    }
  }
}

ステップ 4: サンプルを実行する

Analytics API を有効にして Java 用 Google API クライアントライブラリをインストールし、サンプルソースコードを設定したら、サンプルを実行できるようになります。

IDE を使用している場合は、デフォルトの実行ターゲットが HelloAnalytics クラスに設定されていることを確認してください。それ以外の場合は、コマンドラインからアプリケーションをコンパイルして実行できます。

次のコマンドを使用してサンプルをコンパイルします。

javac -classpath /path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics.java

次のコマンドを使用してサンプルを実行します。

java -classpath ./:/path/to/google/lib/*:/path/to/google/lib/libs/* HelloAnalytics

以上の手順が完了すると、サンプルは、承認済みユーザーの最初の Google アナリティクスビュー（プロファイル）の名前と、過去 7 日間のセッション数を出力します。

承認済みの Analytics サービスオブジェクトを使用して、 Management API リファレンスドキュメントにあるコードサンプルをすべて実行できます。たとえば、 accountSummaries.list メソッドを使用するようにコードを変更してみましょう。

はじめてのアナリティクス API: サービス アカウント向け Java クイック スタート

ステップ 1: アナリティクス API を有効にする

クライアント ID を作成する

Google アナリティクス アカウントへのサービス アカウントの追加

ステップ 2: Google クライアント ライブラリをインストールする

Java 環境の詳細

ステップ 3: サンプルを設定する

ステップ 4: サンプルを実行する

はじめてのアナリティクス API: サービスアカウント向け Java クイックスタート

Google アナリティクスアカウントへのサービスアカウントの追加

ステップ 2: Google クライアントライブラリをインストールする