初心者でも分かる！なGoogle Analytics APIの使い方

必要なもの

Google Analytics APIを利用するためには、Googleのユーザーアカウントが必要です。まだ所有していない人は下記ページから作成して下さい。また、このブログではプログラミング言語としてPHPを利用するので、PHPが稼働する環境も前提となります。

Google Developers Console

まず、Googleの開発者用管理ページである「Google Developers Console」にアクセスして下さい。ログインがまだの人は求められます。このページは、アプリケーションを管理するために利用するページなので、ブックマークしておきましょう。

プロジェクトを作成する

続いて、プロジェクトを作成します。

プロジェクトとは？

プロジェクトとは、Googleが提供する様々なAPIを使った様々なアプリケーションの1つのまとまりです。ウェブサイトのことをイメージすると分かりやすいかもしれません。例えば、私の場合は「Syncer」というプロジェクトを作って、そのプロジェクトの中で、Google Analytics APIやGoogle Maps APIを利用するわけです。…ピンと来ない場合も、作業だと思って進みましょう。

作成の流れ

それでは、早速、プロジェクトを作成してみましょう。左上部分にある「プロジェクトを作成」というボタンをクリックして下さい。

プロジェクトの作成はとても簡単で、ただ、半角英数字と一部記号で名前を決めるだけです。「プロジェクト名」の項目に好きな名前を入力して下さい。通常はウェブサイト名などでしょう。「プロジェクトID」の項目はプロジェクトを識別するための一意のIDです。ここは自動で決定されるので、変更する必要はありません。準備ができたら、「作成」をクリックして下さい。クリックしてしばらく待つと、プロジェクトの作成が完了します。

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

プロジェクトを作成したら、次にクライアントID(サービスアカウント)を作成します。

クライアントIDとは？

クライアントIDは、他のウェブサイトのAPIでいうアプリケーションにあたります。先ほど作成したプロジェクトがウェブサイト全体を表すなら、このクライアントIDは個々のコンテンツということになります。例えば、私の場合は、ラーメンカテゴリでGoogle Maps APIを利用しています。なので、Syncerというプロジェクト内で、ラーメンカテゴリというクライアントIDを作成しているわけです。クライアントIDの集まりが、プロジェクトです。

ここで勘違いとなってはいけないので付け加えておくと、プロジェクトとクライアントIDの関係はどう構成しようと自由です。必ずしも、先ほどの例えのように、「ウェブサイトにつき1つのプロジェクトを作成する」と決まっているわけではなく、1つのウェブサイトに複数のプロジェクトを作成してもかまいません。あくまでも、あなたの管理しやすいように、プロジェクトとクライアントIDを構成して下さい。

作成の流れ

「プロジェクト」の作成が完了すると、自動的に、そのプロジェクトのトップ画面に移動します。次回以降にまた同じページに戻るには、Google Developers Consoleにアクセス後、そのプロジェクト名をクリックして下さいね。

さて、プロジェクトの専用ページに戻ったら、左側メニューの「APIと認証」の項目内にある「認証情報」をクリックして下さい。

「認証情報」の管理画面に移動します。「OAuth」という項目内にある「新しいクライアントIDを作成」をクリックして下さい。

アプリケーションの種類を選択します。「サービスアカウント」「P12 キー」を選択し、「クライアントIDを作成」をクリックして下さい。通常、Twitter APIなどを利用する場合はウェブアプリケーションを利用しますが、今回は「サービスアカウント」を選択して下さい。これはどういうものかというと、あらかじめ、サービス側でクライアントIDに許可を出しておくことで、アクセストークンの発行作業をすることなく、データにアクセスできる性質のものです。サーバー構築経験のある人は、「鍵交換方式による認証」をイメージすると掴みやすいかもしれません。

いずれにしろ、手順に従えば予備知識は不要です。何も分からない今は手だけを動かして下さい。繰り返しになりますが、仕組みは動かしながら覚えればいいと思います。技術的な詳細を知りたい人は、下記の公式ドキュメント(英語)をご参考下さい。

秘密キーファイルの確認

「クライアントIDを作成」をクリックすると、「新しい公開キー/秘密キーのペアが生成されました」という確認メッセージが表示されます。「秘密キーのパスワードが下に表示されます。後でもう一度表示することはできません。」とありますが、パスワードはnotasecretとなっているはずです。この値は利用しませんが、心配なら一応、メモしておきましょう。…いや、不要です。

そして、この確認メッセージが表示されると同時に、秘密キーのファイルが自動的にダウンロードされるはずです。Syncer Analytics-0a6a76b4e70b.p12というような、.p12が拡張子になっているファイルです。これは、とても重要なファイルで、後ほど使うので、保存しておいて下さい。

ファイル名にはプロジェクト名が最初に付いてます。例えば「Syncer Analytics」というプロジェクトを作ったら、秘密キーのファイル名はSyncer Analytics-0a6a76b4e70b.p12となります。ファイル名にスペースが入っているとアレなので、Syncer_Analytics-0a6a76b4e70b.p12というように、ファイル名を変更して下さい。ファイル名は他人に知られてはいけません。が、変更は自由なので、極端な話、a.p12としても働きます。気軽に変更しちゃいましょ。

各種キーの確認

「認証情報」の画面に戻ります。作成したクライアントIDの情報が加わっているはずです。

クライアントID情報の下部に、「新しいP12キーを生成」というボタンがあります。ここをクリックすると、秘密キーファイルを新しくダウンロードすることができます。他人にファイル名を知られてしまった可能性がある、ファイルをなくしてしまった…、などの場合にご利用下さい。当然、古いファイルは利用できなくなるのでご注意下さい。

赤枠部分の「クライアントID」「メールアドレス」を後ほど利用するので、保存しておいて下さい。これで、クライアントIDの作成は完了です。

Analytics APIを有効にする

次にプロジェクトでGoogle Analytics APIを使えるように設定します。

左側メニューの「API」をクリックして下さい。

検索フォームに「Analytics API」と入力し、マッチした候補の中から「Analytics API」をクリックして下さい。

「Analytics API」の専用のページに移動するので、「APIを有効にする」をクリックして下さい。これで、このプロジェクトでGoogle Analytics APIを利用することができるようになります。

クライアントIDのアクセスを許可する

仕上げに、クライアントIDとして作成したサービスアカウントが、自分のGoogle Analyticsのデータにアクセスできるように設定しましょう。操作はGoogle Analyticsの管理画面で行ないます。

画面上部のメニューにある「アナリティクス設定」をクリックして下さい。

「アカウント」「プロパティ」「ビュー」を、利用するウェブサイトのものに合わせて下さい。

「ビュー」の項目内にある「ユーザー管理」をクリックして下さい。

権限の付与設定の画面に移動します。赤枠部分のフォームで、先ほど、クライアントIDを作成した時の、クライアントID情報内にある「メールアドレス」を入力し、画面右側にあるセレクトボックスを開き、「ユーザー管理」「編集」「共有設定」「表示と分析」にチェックを入れて、最後に「追加」をクリックして下さい。

フォームの上部に、入力したメールアドレスが追加されていれば、大丈夫です。

「アナリティクス設定」の画面に移動して下さい。「ビュー」の項目内にある「ビュー設定」をクリックして下さい。

ビューIDを確認して下さい。このIDを、後ほど利用します。

ライブラリを読み込む

まずは、ライブラリを読み込みます。

// ライブラリを読み込む
require_once './google-api-php-client-master/autoload.php' ;

APIキーの設定

続いて、プログラムに必要な各種キーを変数に代入します。クライアントIDの情報にある「メールアドレス」、そして、Google Analyticsで確認できる「ビューID」をセットして下さい。

// クライアントID
$client_id = '388703791528-4usfjkghn454k2ivq24f8t34o3spf48s@developer.gserviceaccount.com' ;

// ビューID
$view_id = '86695217' ;

秘密キーの読み込み

続いて、秘密キーファイルを読み込みます。秘密キーファイルを任意の場所にアップロードしておいて下さい。できれば、ルート外(直接URLアドレスでアクセスできない)のフォルダに設置して、絶対パスで読み込みましょう。

	// 秘密キーファイルの読み込み
	$private_key = @file_get_contents( './Syncer_Analytics-208312d9d56b.p12' ) ;

条件を指定する

データを取得するための、パラメータを、ライブラリのルールに従って、指定します。

// 取得する期間 (YYYY-MM-DD)
$from = '2014-11-10' ;		// 対象開始日
$to = '2014-12-10' ;		// 対象終了日

// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
$dimensions = 'ga:pageTitle, ga:pagePath, ga:date' ;		// ディメンション
$metrics = 'ga:pageviews' ;		// メトリクス

//オプション
$option = array(
	'dimensions' => $dimensions ,
	'max-results' => 10 ,
	'sort' => '-ga:pageviews' ,
//	'start-index' => 50,	// 取得開始位置
) ;

期間

取得する期間は、基本的にYYYY-MM-DDの形式で指定します。todayやyesterday、5daysAgoなどといった指定も可能ですが、あまり使う機会はなさそうです。

オプション

オプションを配列で指定しておきます。取得件数は最大で1,000件までです。ページが1,000件以上ある場合は、オプションとなる連想配列のstart-indexというキーに取得開始位置を指定できます。1001を指定すれば、1001件目から、すなわち2ページ目を取得できます。

取得するデータ

最も重要な「取得するデータ」。これは「ディメンション」と「メトリクス」という2つの項目を組み合わせて指定します。簡単に言うと、テーブルでいう「列」と「行」の関係だと考えて下さい。例えば、今回のサンプルでは、メトリクスに「ページビュー(ga:pageviews)」、ディメンションに「ページタイトル(ga:pageTitle)」「ページURL(ga:pagePath)」「日付(ga:date)」を指定しています。メトリクス、ディメンションには、それぞれ1回のリクエストにつき10つまで項目を指定することができます。複数指定する場合は半角カンマ(,)で区切ります。指定できる項目については、後述します。

リクエストを実行する

いよいよドキドキの瞬間です。リクエストを実行して、データを取得してみましょう。下記は、設定内容を元に認証作業、データ取得のためのリクエストを行なう処理です。言わば決まった処理なので、特に何をしているかを理解する必要はありません。

// トークンのセット
if( isset( $_SESSION['service_token'] ) )
{
	$client->setAccessToken( $_SESSION['service_token'] ) ;
}

// スコープのセット (読み込みオンリー)
$scopes = array( 'https://www.googleapis.com/auth/analytics.readonly' ) ;

// クレデンシャルの作成
$credentials = new Google_Auth_AssertionCredentials( $client_id , $scopes , $private_key ) ;

// Googleクライアントのインスタンスを作成
$client = new Google_Client() ;
$client->setAssertionCredentials( $credentials ) ;

// トークンのリフレッシュ
if( $client->getAuth()->isAccessTokenExpired() )
{
	$client->getAuth()->refreshTokenWithAssertion( $credentials ) ;
}

// セッションの設定
$_SESSION['service_token'] = $client->getAccessToken() ;

// Analyticsのインスタンスを作成
$analytics = new Google_Service_Analytics( $client ) ;

// データの取得
$obj = $analytics->data_ga->get( 'ga:' . $view_id , $from , $to , $metrics , $option ) ;

// JSONデータに変換して出力
echo json_encode( $obj ) ;

このコードは公式のサンプルを参考にしたものです。該当箇所を確認したい場合は、下記ページをご覧下さい。

サンプルプログラム

以上を踏まえたサンプルプログラムが下記です。デモを確認してみて下さいね。

<?php

	// ライブラリを読み込む
	require_once './autoload.php' ;

	// クライアントID
	$client_id = '...@developer.gserviceaccount.com' ;

	// ビューID
	$view_id = '86695217' ;

	// 秘密キーファイルの読み込み
	$private_key = @file_get_contents( './Syncer_Analytics-208312d9d56b.p12' ) ;

	// 取得する期間 (YYYY-MM-DD)
	$from = date( 'Y-m-d' , strtotime( '-1 day' ) ) ;		// 対象開始日
	$to = date( 'Y-m-d' ) ;		// 対象終了日

	// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
	$dimensions = 'ga:pageTitle, ga:pagePath, ga:date' ;		// ディメンション
	$metrics = 'ga:pageviews' ;		// メトリクス

	//オプション
	$option = array(
		'dimensions' => $dimensions ,
		'max-results' => 10 ,
		'sort' => '-ga:pageviews' ,
//		'start-index' => 11,	// 取得開始位置
	) ;

	// トークンのセット
	if( isset( $_SESSION['service_token'] ) )
	{
		$client->setAccessToken( $_SESSION['service_token'] ) ;
	}

	// スコープのセット (読み込みオンリー)
	$scopes = array( 'https://www.googleapis.com/auth/analytics.readonly' ) ;

	// クレデンシャルの作成
	$credentials = new Google_Auth_AssertionCredentials( $client_id , $scopes , $private_key ) ;

	// Googleクライアントのインスタンスを作成
	$client = new Google_Client() ;
	$client->setAssertionCredentials( $credentials ) ;

	// トークンのリフレッシュ
	if( $client->getAuth()->isAccessTokenExpired() )
	{
		$client->getAuth()->refreshTokenWithAssertion( $credentials ) ;
	}

	// セッションの設定
	$_SESSION['service_token'] = $client->getAccessToken() ;

	// Analyticsのインスタンスを作成
	$analytics = new Google_Service_Analytics( $client ) ;

	// データの取得
	$obj = $analytics->data_ga->get( 'ga:' . $view_id , $from , $to , $metrics , $option ) ;

	// JSONデータに変換
	$json = json_encode( $obj ) ;

	// HTML用
	$html = '' ;

	// 実行結果を出力
	$html .= '<h2>実行結果</h2>' ;
	$html .= '<p><b>' . date( 'Y/m/d' , strtotime( $from ) ) . '</b>の、ページビューのデイリーランキングを取得してみました。<mark>値はサンプル用のダミーです。</mark></p>' ;

	// エラー判定
	if( !isset($obj->rows) )
	{
		$html .= '<p><mark>データを取得できませんでした…。</mark></p>' ;
	}
	else
	{
		$html .= '<ol>' ;

		// 解析
		for( $i=0 , $l=count( $obj->rows ) ; $l > $i ; $i++ )
		{
			// エイリアス
			$item = $obj->rows[ $i ] ;

			// 出力
			$html .= '<li><a href="' . $item[1] . '" target="_blank">' . $item[0] . '</a> (' . number_format( $item[3] ) . 'PV)</li>' ;
		}

		$html .= '</ol>' ;
	}

	// 取得したデータ
	$html .= '<h2>取得したデータ(JSON)</h2>' ;
	$html .= 	'<textarea rows="8">' . $json . '</textarea>' ;

?>

<?php
	// ブラウザに[$html]を出力 (HTMLのヘッダーとフッターを付けましょう)
	echo $html ;
?>

サンプルデモを見る

サンプル

取得したデータをJSON型に変換した時の出力結果のサンプルが下記です。rowsプロパティ内に、取得した件数分が配列形式で含まれています。1つ1つのデータの内容は、「ディメンションで指定した項目」「メトリクスで指定した項目」の順番に配列になっています。例えばサンプルでは、ディメンションに設定した「ページタイトル(ga:pageTitle)」「ページURL(ga:pagePath)」「日付(ga:date)」に続き、最後にメトリクスに指定した「ページビュー(ga:pageviews)」という順番に格納されてますよね。

{
	"containsSampledData": false,
	"id": "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:86695217&dimensions=ga:pageTitle,+ga:pagePath,+ga:date&metrics=ga:pageviews&sort=-ga:pageviews&start-date=2014-11-10&end-date=2014-12-10&start-index=100&max-results=5",
	"itemsPerPage": 5,
	"kind": "analytics#gaData",
	"nextLink": "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:86695217&dimensions=ga:pageTitle,+ga:pagePath,+ga:date&metrics=ga:pageviews&sort=-ga:pageviews&start-date=2014-11-10&end-date=2014-12-10&start-index=105&max-results=5",
	"previousLink": "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:86695217&dimensions=ga:pageTitle,+ga:pagePath,+ga:date&metrics=ga:pageviews&sort=-ga:pageviews&start-date=2014-11-10&end-date=2014-12-10&start-index=95&max-results=5",
	"rows": [
		[
			"Instagramでユーザーをブロック(フォロワー外し)する方法",
			"/instagram-how-to-block-user",
			"20141205",
			"663"
		],
		[
			"Instagramを始めよう！アカウントを作成する方法",
			"/instagram-how-to-create-account",
			"20141129",
			"660"
		],
		[
			"Instagramで投稿写真を非公開に設定する方法",
			"/instagram-how-to-setting-private-mode",
			"20141129",
			"659"
		],
		[
			"Instagramでユーザーをブロック(フォロワー外し)する方法",
			"/instagram-how-to-block-user",
			"20141119",
			"658"
		],
		[
			"Instagramのダイレクトメッセージの使い方",
			"/instagram-how-to-use-direct-message",
			"20141111",
			"658"
		]
	],
	"sampleSize": null,
	"sampleSpace": null,
	"selfLink": "https://www.googleapis.com/analytics/v3/data/ga?ids=ga:86695217&dimensions=ga:pageTitle,+ga:pagePath,+ga:date&metrics=ga:pageviews&sort=-ga:pageviews&start-date=2014-11-10&end-date=2014-12-10&start-index=100&max-results=5",
	"totalResults": 7224,
	"totalsForAllResults": {
		"ga:pageviews": "324049"
	}
}

各パラメータの説明

主なパラメータを説明します。

itemsPerPage

総ページ数。指定した取得件数で、全件数を取得するのに必要なページ数。

rows

メインとなるデータ。ディメンションとメトリクスで指定した順に、データが配列形式で含まれている。

totalResults

指定した条件でヒットした件数。

totalsForAllResults

メトリクスで指定した項目の合計値。

パラメータの一覧

指定できる主なパラメータの一覧です。

max-results

取得件数。

start-index

取得開始位置。

sort

データの並び順。ディメンション、メトリクスの項目を指定すると、その項目の数値で並び替える。ga:pageviewsならページビューが少ない順、先頭にマイナス(-)を付けて-ga:pageviewsなら大きい順となる。

filters

フィルターをかける。{項目}{演算子}{値}で指定する。

prettyPrint

取得できるデータに、見やすいようにインデントや改行を付けるか否か。デフォルトではfalse。

フィルターの演算子

フィルターを指定する場合に利用できる演算子の説明です。

ユーザーサマリー

ブログなどで、よくアクセス数公開の記事で紹介される項目です。Google Analyticsの基本的な項目ですねー。これらは各項目の合計値が目的となるので、totalsForAllResultsプロパティを参照しましょう。

$dimensions = 'ga:pageTitle, ga:pagePath' ;		// ディメンション
$metrics = 'ga:sessions , ga:users , ga:pageviews , ga:pageviewsPerSession , ga:avgSessionDuration , ga:bounceRate , ga:percentNewSessions' ;		// メトリクス

このコードの動作を確認する

検索クエリ

ユーザーがどんなキーワードで自分のウェブサイトに辿り着いているのか、検索クエリを取得してみましょう。(not set)、(not provided)を除外するために、フィルターを指定しておきましょう。

// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
$dimensions = 'ga:pageTitle, ga:pagePath , ga:keyword' ;		// ディメンション
$metrics = 'ga:pageviews' ;		// メトリクス

//オプション
$option = array(
	'dimensions' => $dimensions ,
	'sort' => '-ga:pageviews' ,
	'filters' => 'ga:keyword!=(not set);ga:keyword!=(not provided)' ,
) ;

このコードの動作を確認する

参照元(リファラー)

参照元(リファラー)を取得することで、どのページからウェブサイトにアクセスがあるのか、すなわち、被リンクを知ることができます。ページごとのデータを取得すると、なかなか大変なことになります。なので、今回はサイト全体を対象にして取得します。指定するディメンションの項目はアドレス全体を知りたい場合はga:fullReferrer、大雑把で把握したい場合はga:sourceがお勧めです。

// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
$dimensions = 'ga:fullReferrer' ;		// ディメンション
$metrics = 'ga:pageviews' ;		// メトリクス

このコードの動作を確認する

月間ページビュー

ページビューが月ごとにどのように推移してきたのかを取得してみましょう。それには、ディメンションにga:yearMonthを指定するのが便利です。これが、例えばga:monthを指定した場合は、2014年1月、2015年1月と同じ1月で数値が合計されてしまう点に注意しましょう。最新順に並べるために、sortの指定も必要です。

// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
$dimensions = 'ga:yearMonth' ;		// ディメンション
$metrics = 'ga:pageviews' ;		// メトリクス

//オプション
$option = array(
	'dimensions' => $dimensions ,
	'sort' => '-ga:yearMonth' ,
) ;

このコードの動作を確認する

デバイス

パソコン、タブレット、スマホの3つの種類のデバイスの、割合を調べてみましょう。モバイルフレンドリーと言われる今、スマホの比率の大きさに驚くばかりです…。フィルターで、取得するカテゴリをdesktop、mobile、tabletの3つに絞っています。

// 取得するデータの組み合わせ (複数の場合は[,]で区切る)
$dimensions = 'ga:deviceCategory' ;		// ディメンション
$metrics = 'ga:pageviews' ;		// メトリクス

//オプション
$option = array(
	'dimensions' => $dimensions ,
	'filters' => 'ga:deviceCategory==desktop,ga:deviceCategory==mobile,ga:deviceCategory==tablet' ,
) ;

このコードの動作を確認する

User

ディメンション

ga:userType

ユーザータイプ。新規訪問ユーザーと、リピーターユーザー。

ga:sessionCount

セッション回数。

ga:daysSinceLastSession

再訪問日。リピーターが、前回から何日立ってから訪れたか。

ga:userDefinedValue

サイト運用者が「ユーザー定義」によって作成した各ユーザー。デフォルトではnot setのみ。

メトリクス

ga:users

ユニークユーザーの人数。

ga:newUsers

新規ユーザーの人数。

ga:percentNewSessions

新規セッション率。セッション数における新規ユーザー人数の割合、パーセンテージ。ga:newUsers / ga:sessionsで求める。

ga:sessionsPerUser

ユーザー1人あたりのセッション数。

Session

ディメンション

ga:sessionDurationBucket

秒単位のセッションの長さ。

メトリクス

ga:sessions

セッション数。

ga:bounces

1ページの閲覧のみだったセッション数。

ga:bounceRate

直帰率。全セッションにおけるバウンス数の割合。ga:bounces / ga:sessionsで求める。

ga:sessionDuration

全てのセッションの、セッション時間の合計秒数。

ga:avgSessionDuration

全てのセッションの、セッション時間の平均秒数。

ga:hits

ヒット数。これは、pageviewやevent、timingなどの合計数。

Traffic Sources

ディメンション

メトリクス

ga:organicSearches

オーガニック検索のセッション数。

Platform or Device

ディメンション

Geo Network

ディメンション

System

ディメンション

Social Activities

ディメンション

メトリクス

ga:socialActivities

ソーシャル上で、コンテンツのURLがシェアされた活動の回数。

Page Tracking

ディメンション

メトリクス

Site Speed

メトリクス

Time

ディメンション

Audience

ディメンション

ga:userAgeBracket

ユーザーの年代。

ga:userGender

ユーザーの性別。

ga:interestOtherCategory

インタレストカテゴリ。指定カテゴリに関心を持ち、購入意欲があると判定されたユーザー分類。

ga:interestAffinityCategory

アフィニティカテゴリ。指定カテゴリに関心を持つと判定されたユーザー分類。

ga:interestInMarketCategory

インタレストマーケットカテゴリ。指定カテゴリの製品、サービスの購入意欲があると判定されたユーザー分類。