Google Analytics API でタイトルと Path を取得

メモ:

ドキュメントがうまく見つけられず苦戦したのですが、PV数上位10件のタイトルと Path が取得できるようになったのでまとめておきます。

PV 数上位10件のタイトルと Path を取得する

ここでは、サンプルで公開されている HelloAnalytics.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");
        }
      }
    }
  }
}

データをリクエストするには、「 viewId 」,「 dateRanges 」(期間),「 metrics 」が最低限必要となります。「 viewId 」と「 dateRanges 」は、なんとなくわかるのですが、「 metrics 」に指定できるものがわかりません。これは、次の Google アナリティクスレポート Reporting API v4 ドキュメントにある「ディメンションと指標のリファレンス」で知ることができます。

ディメンションと指標のリファレンス

例えば、 HelloAnalytics.php で Google_Service_AnalyticsReporting_Metric オブジェクトにセットしている metrics は、セッションを指定しており「ディメンションと指標のリファレンス」では次のように確認することができます。

セッションを指定する

今回実装する PageView を指標としたい場合、「 Page Tracking 」が対象となり「 ga:pageviews 」と指定することが分かります。

ページビューの指定方法

これで、指定する値がわかったのでサンプルの HelloAnalytics.php を次のように修正します。

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

次に URL に関する情報が欲しいので、ディメンションを設定します。ディメンションは、計測の「対象」「区分」になるようで Page Tracking にある Dimensions の「ga:pagePath」を指定します。サンプルプログラムの HelloAnalytics.php には無かったのですが、ディメンションを指定するには Google_Service_AnalyticsReporting_Dimension クラスを使用します。 ※後でわかったのですが、Reporting API v4 ドキュメントにある「サンプル」ページにいくつかの機能が紹介されています。

// Create the Dimension object.
$dim_path = new Google_Service_AnalyticsReporting_Dimension();
$dim_path->setName('ga:pagePath');

ディメンションやメトリクスは複数設定できるようなので、もう一つページタイトルも追加しておきます。

// Create the Dimension object.
$dim_path = new Google_Service_AnalyticsReporting_Dimension();
$dim_path->setName('ga:pagePath');

$dim_title = new Google_Service_AnalyticsReporting_Dimension();
$dim_title->setName('ga:pageTitle');

メトリクスとディメンションの設定ができたので ReportRequest の生成部分にディメンションをセットするよう修正していきます。

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

ここまでで、ほしい情報が取得できるようになったので、さらに「上位10件」の部分を実装してみます。指定方法は、「メソッド: reports.batchGet」から読み取っていきます。(※他にドキュメントがないか探していますが。。。見つかっていません)

まず、「上位」としたので並べ替えを行うようリクエストします。並べ替えには、 Google_Service_AnalyticsReporting_OrderBy を生成する必要があるので次のように追記します。

// Create the OrderBy object.
$orderBy = new Google_Service_AnalyticsReporting_OrderBy();
$orderBy->setFieldName('ga:pageviews');
$orderBy->setSortOrder('DESCENDING');

setFieldName で項目を指定し、工順で取得するよう設定しています。 setSortOrder は、次のような指定ができるようです。

列挙値 説明
SORT_ORDER_UNSPECIFIED 並べ替え順を指定しない場合、デフォルトは昇順です。
ASCENDING 昇順で並べ替え。フィールドが昇順で並べ替えられます。
DESCENDING 降順で並べ替え。フィールドが降順で並べ替えられます。

次に「10件」という部分を実装します。これは、 Google_Service_AnalyticsReporting_ReportRequest オブジェクトの setPageSize メソッドに取得する行数を指定します。

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

ドキュメントには、次のような記載があり setPageSize に指定した最大行数を取得するようになります。

フィールド名 タイプ 説明
pageSize number ページサイズは、ページングを設定するためのもので、返される最大行数を指定します。ページサイズは 0 以上にしてください。デフォルトでは、1 回のクエリで 1,000 行が返されます。指定した値に関係なく、アナリティクス Core Reporting API から返される行数は、リクエストにつき最大 100,000 行です。ディメンション セグメントの数が予想より少ない場合、リクエストしたよりも少ない行数が返されます。たとえば、ga:country の有効な値は 300 個に満たないため、国のみでセグメント化すると、pageSize に 300 より大きな値を設定しても、取得できる行数は 300 行以下です。

ここまでの内容を組み合わせると、「 PV 数上位10件のタイトルと Path 」が取得できるようになります。

<?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 Dimension object.
  $dim_path = new Google_Service_AnalyticsReporting_Dimension();
  $dim_path->setName('ga:pagePath');

  $dim_title = new Google_Service_AnalyticsReporting_Dimension();
  $dim_title->setName('ga:pageTitle');

  // Create the OrderBy object.
  $orderBy = new Google_Service_AnalyticsReporting_OrderBy();
  $orderBy->setFieldName('ga:pageviews');
  $orderBy->setSortOrder('DESCENDING');

  // Create the ReportRequest object.
  $request = new Google_Service_AnalyticsReporting_ReportRequest();
  $request->setViewId($VIEW_ID);
  $request->setDateRanges($dateRange);
  $request->setMetrics(array($sessions));
  $request->setDimensions(array($dim_path,$dim_title));
  $request->setOrderBys($orderBy);
  $request->setPageSize(10);

  $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");
        }
      }
    }
  }
}

Related Link(Ads)