はじめに

GMOアドマーケティングのあおんたです。

今回は、ほぼオンプレシステムを担当していたエンジニアが、Google Analytics APIを叩くまでの手順を紹介します。

Google Analytics APIを叩いて、自分の管理下にあるGAタグが埋め込まれたサイトのセッション数を取得したりできます。

手順

ほぼ、公式ドキュメントの手順通り実施します。

ただ、Googleの公式ドキュメントって、直訳調というか、なんか日本語が不自然でいまいち何が言いたいかわからなかったりしますよね…。

というわけで、公式ドキュメント読んでもいまいちわかりづらかったところを補足しながら書こうと思います。

サービスアカウント作成

「サービスアカウント」とは、GCPのあるサービスにアクセスするためのアカウントです。

サービスの利用権限を個人アカウントごとに設定しなくても、ある目的のためにサービスアカウントを作成しておけば、属人化することなくサービスへのアクセス権限を保証することができます。

「サービスアカウント」ページから、サービスアカウントを作成します。

赤枠の「CREATE SERVICE ACCOUNT」から作成します。

その際は、わかりやすい名前と、きちんと目的を記載した説明を書きましょう。

鍵ファイルがjson形式ダウンロードされるので、無くさずに保管してください。

運用のコツ

サービスアカウント作成の際は、プロジェクトを作成してもいいか、サービスアカウントの管理ポリシーに準拠しているか、必ずインフラチームや管理チームに確認しましょう。また、サービスアカウントが濫用されることがないように、きちんと説明に目的を記載しておきましょう。

Google Analyticsにサービスアカウントを登録

サービスアカウントを作成すると、サービスアカウントのメールアドレスが払い出されます。

一昔前の運用では、サーバログイン用にチーム共有のメールアドレスを作成したりしましたが、それに近いイメージですね。

管理対象のGoogle Analytics画面から、左下の歯車アイコンで管理画面に入ります。

そして「ユーザ管理者」をクリックし、サービスアカウントのメールアドレスをユーザとして追加します。

権限は、「表示と分析」でOKです。

ここで、公式サイトにあるサンプルコードを見てみましょう。

サンプルファイルの配置

ここで公式のサンプルファイルを適当な名前でローカルフォルダに配置します。（PHP実行環境があることが前提です）

<?php

// Load the Google API PHP Client Library.
require_once __DIR__ . '/vendor/autoload.php';

$analytics = initializeAnalytics();
$response = getReport($analytics);
printResults($response);

/**
 * Initializes an Analytics Reporting API V4 service object.
 *
 * @return An authorized Analytics Reporting API V4 service object.
 */
function initializeAnalytics()
{

  // Use the developers console and download your service account
  // credentials in JSON format. Place them in this directory or
  // change the key file location if necessary.
  $KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.json';

  // Create and configure a new client object.
  $client = new Google_Client();
  $client->setApplicationName("Hello Analytics Reporting");
  $client->setAuthConfig($KEY_FILE_LOCATION);
  $client->setScopes(['https://www.googleapis.com/auth/analytics.readonly']);
  $analytics = new Google_Service_AnalyticsReporting($client);

  return $analytics;
}

/**
 * Queries the Analytics Reporting API V4.
 *
 * @param service An authorized Analytics Reporting API V4 service object.
 * @return The Analytics Reporting API V4 response.
 */
function getReport($analytics) {

  // Replace with your view ID, for example XXXX.
  $VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

  // Create the DateRange object.
  $dateRange = new Google_Service_AnalyticsReporting_DateRange();
  $dateRange->setStartDate("7daysAgo");
  $dateRange->setEndDate("today");

  // Create the Metrics object.
  $sessions = new Google_Service_AnalyticsReporting_Metric();
  $sessions->setExpression("ga:sessions");
  $sessions->setAlias("sessions");

  // Create the ReportRequest object.
  $request = new Google_Service_AnalyticsReporting_ReportRequest();
  $request->setViewId($VIEW_ID);
  $request->setDateRanges($dateRange);
  $request->setMetrics(array($sessions));

  $body = new Google_Service_AnalyticsReporting_GetReportsRequest();
  $body->setReportRequests( array( $request) );
  return $analytics->reports->batchGet( $body );
}

/**
 * Parses and prints the Analytics Reporting API V4 response.
 *
 * @param An Analytics Reporting API V4 response.
 */
function printResults($reports) {
  for ( $reportIndex = 0; $reportIndex < count( $reports ); $reportIndex++ ) {
    $report = $reports[ $reportIndex ];
    $header = $report->getColumnHeader();
    $dimensionHeaders = $header->getDimensions();
    $metricHeaders = $header->getMetricHeader()->getMetricHeaderEntries();
    $rows = $report->getData()->getRows();

    for ( $rowIndex = 0; $rowIndex < count($rows); $rowIndex++) {
      $row = $rows[ $rowIndex ];
      $dimensions = $row->getDimensions();
      $metrics = $row->getMetrics();
      for ($i = 0; $i < count($dimensionHeaders) && $i < count($dimensions); $i++) {
        print($dimensionHeaders[$i] . ": " . $dimensions[$i] . "\n");
      }

      for ($j = 0; $j < count($metrics); $j++) {
        $values = $metrics[$j]->getValues();
        for ($k = 0; $k < count($values); $k++) {
          $entry = $metricHeaders[$k];
          print($entry->getName() . ": " . $values[$k] . "\n");
        }
      }
    }
  }
}

<?php

// Load the Google API PHP Client Library.

require_once __DIR__ . '/vendor/autoload.php';

$analytics = initializeAnalytics();

$response = getReport($analytics);

printResults($response);

/**

* Initializes an Analytics Reporting API V4 service object.

* @return An authorized Analytics Reporting API V4 service object.

function initializeAnalytics()

{

// Use the developers console and download your service account

// credentials in JSON format. Place them in this directory or

// change the key file location if necessary.

$KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.json';

// Create and configure a new client object.

$client = new Google_Client();

$client->setApplicationName("Hello Analytics Reporting");

$client->setAuthConfig($KEY_FILE_LOCATION);

$client->setScopes(['https://www.googleapis.com/auth/analytics.readonly']);

$analytics = new Google_Service_AnalyticsReporting($client);

return $analytics;

}

/**

* Queries the Analytics Reporting API V4.

* @param service An authorized Analytics Reporting API V4 service object.

* @return The Analytics Reporting API V4 response.

function getReport($analytics) {

// Replace with your view ID, for example XXXX.

$VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

// Create the DateRange object.

$dateRange = new Google_Service_AnalyticsReporting_DateRange();

$dateRange->setStartDate("7daysAgo");

$dateRange->setEndDate("today");

// Create the Metrics object.

$sessions = new Google_Service_AnalyticsReporting_Metric();

$sessions->setExpression("ga:sessions");

$sessions->setAlias("sessions");

// Create the ReportRequest object.

$request = new Google_Service_AnalyticsReporting_ReportRequest();

$request->setViewId($VIEW_ID);

$request->setDateRanges($dateRange);

$request->setMetrics(array($sessions));

$body = new Google_Service_AnalyticsReporting_GetReportsRequest();

$body->setReportRequests( array( $request) );

return $analytics->reports->batchGet( $body );

}

/**

* Parses and prints the Analytics Reporting API V4 response.

* @param An Analytics Reporting API V4 response.

function printResults($reports) {

for ( $reportIndex = 0; $reportIndex < count( $reports ); $reportIndex++ ) {

$report = $reports[ $reportIndex ];

$header = $report->getColumnHeader();

$dimensionHeaders = $header->getDimensions();

$metricHeaders = $header->getMetricHeader()->getMetricHeaderEntries();

$rows = $report->getData()->getRows();

for ( $rowIndex = 0; $rowIndex < count($rows); $rowIndex++) {

$row = $rows[ $rowIndex ];

$dimensions = $row->getDimensions();

$metrics = $row->getMetrics();

for ($i = 0; $i < count($dimensionHeaders) && $i < count($dimensions); $i++) {

print($dimensionHeaders[$i] . ": " . $dimensions[$i] . "\n");

}

for ($j = 0; $j < count($metrics); $j++) {

$values = $metrics[$j]->getValues();

for ($k = 0; $k < count($values); $k++) {

$entry = $metricHeaders[$k];

print($entry->getName() . ": " . $values[$k] . "\n");

}

APIクライアントのインストール

置いたファイルと同じパスでcomposerを使ってAPIクライアントをインストールします。

composer require google/apiclient:^2.0

1	composer require google/apiclient:^2.0

鍵ファイルパスとViewIDの設定

ソースコード中の21行目：

$KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.jso

1	$KEY_FILE_LOCATION = __DIR__ . '/service-account-credentials.jso

を前の手順でダウンロードした鍵ファイル名に変更します。

ソースコード中の42行目：

$VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

1	$VIEW_ID = "<REPLACE_WITH_VIEW_ID>";

を取得対象のGoogle Analytics　ダッシュボードのVIEW IDに書き換えます。

対象は Account Explorer にて確認できます。「Showing view selected above」欄に view id が表示されているので、その値に書き換えてください。

いよいよ実行

$ php GoogleAnalytics.php 
sessions: 535918

1 2	$ php GoogleAnalytics.php sessions: 535918

実行した結果、指定されたビューの過去 7 日間のセッション数が出力されれば成功です。

お疲れ様でした。

あおんた

マイブームは、ペーパードライバー卒業・天体観測・アマチュア無線・BCL受信・カセットテープデッキのメンテ修理・登山とか。

写真は飼っている文鳥のおつゆちゃん。

はじめに

手順

サービスアカウント作成

運用のコツ

Google Analyticsにサービスアカウントを登録

サンプルファイルの配置

APIクライアントのインストール

鍵ファイルパスとViewIDの設定

いよいよ実行

おすすめ

PITRでCloud SQLインスタンスを復元

Dataflow(batch)でZONE_RESOURCE_POOL_EXHAUSTEDが発生した話

gcloudコマンドで Container Registry から Artifact Registry に移行する