色々とあるGoogle AnalyticsのAPIの概要を俯瞰する

2021-08-13
2021-08-13

ちょっと触ってみようと思ったらAPIの数が多かったので公式ドキュメントを見ながら整理。

以下は解説というより自分の理解の確認(あまり深追いしていない状態)

知っていると混乱を避けられるGA4とUAの違い

GA4ことGoogle Analytics 4が2020年10月にリリースされている。
それ以前の従来のものはユニバーサルアナリティクスということでUAと呼ばれる。

GA4はGoogle Analyticsの名前は継承しているがUAとは完全に別物となっていて、GA4のデータや設定をAPIで扱うにはまだプレビュー版のData APIやAdmin APIを利用する。
従来のUAのデータや設定を扱うにはそれ以外のReporting APIやManagement APIを利用する。

なお現在はまだUAを利用するのが手堅く、今Google AnalyticsのAPIを使おうと思ったら、自然UAに対応したAPIを使っていくことが多いはず。

ただ今後はGA4が主流となっていくのもほぼ間違いがない。
PVが単位のUAのレポートではSPAやアプリの計測と分析が難しく(できないわけではないが手間がかかる)その課題を解決するためにGA4が開発されたという経緯を考えるとそれは自明かと。

UAに対応したAPI

Core Reporting API

ディメンションと指標に関するクエリを発行して、カスタム レポートを作成できます。

https://developers.google.com/analytics/devguides/reporting/core/v4

Google アナリティクス Reporting API v4 は、Google アナリティクス のレポートデータにアクセスするための最も高度な プログラマティック メソッドです。 Google アナリティクス Reporting API では、次のことが可能です。

クエリのリクエストを投げて結果をレスポンスで受け取る一般的なAPI。
「Core」を外して「Reporting API」とも。

プログラマブルに何かをやりたいと思ったらこれを使うことが多いはず。

ちなみに現在のバージョンがv4だがGA4とは関係ない。たまたまv4なだけ。

Embed API

マイレポートを簡単に作成してサードパーティのウェブサイトに組み込みます。

https://developers.google.com/analytics/devguides/reporting/embed/v1

Google アナリティクスの Embed API は、たった数分でサードパーティのウェブサイトに簡単にマイレポートを作成したり埋め込んだりできるようにする JavaScript ライブラリです。この API に用意されている一連のプラグ可能なコンポーネントを連携させて、シンプルかつ効果的な多機能ツールを作成できます。

ウェブサイトにレポートを埋め込みできる。認証付き。
Google Analyticsと同じグラフを表示することもできるし、そのデータを使って独自の表示のさせ方をすることもできる。

Core Reporting APIより簡易に利用が可能なのが価値?

Multi-Channel Funnels Reporting API

ユーザーのコンバージョンにつながったトラフィックの参照元パスに関するクエリを発行します。

https://developers.google.com/analytics/devguides/reporting/mcf/v3

Multi-Channel Funnels Reporting API では、認証されたユーザーのマルチチャネル データをリクエストすることができます。データは、コンバージョン経路データから派生します。このデータでは、コンバージョン前に、複数のセッションでのさまざまなトラフィックとのユーザーの接点が示されます。これにより、複数のマーケティング チャネルが時間の経過とともにコンバージョンにどう影響するかを分析することができます。利用可能なデータの詳細については、マルチチャネルについてとマルチチャネル データについてをご覧ください。

ユーザーがコンバージョンに至るまでのきっかけを深くさかのぼって追うことができる。

参考: マルチチャネルについて
参考: コンバージョン経路の分析

Real Time Reporting API

プロパティで発生しているアクティビティについて、リアルタイムでレポートします。

https://developers.google.com/analytics/devguides/reporting/realtime/v3

Real Time Reporting API では、認証されたユーザーのリアルタイム データ (プロパティのリアルタイム アクティビティなど)をリクエストすることが できます。

リアルタイムレポートのデータへのアクセスを行うAPI。

あるページにたいしてそのページを閲覧中のユーザーが何人いるか、現在アクセスの多いページのトップ10の表示、カスタマイズしたリアルタイムレポートの作成といったことができる。

Metadata API

API のディメンションと指標、およびその属性のリストにアクセスします。

https://developers.google.com/analytics/devguides/reporting/metadata/v3

Metadata API は、Google アナリティクス Reporting API に表示された列(ディメンションや指標など)のリストや属性を返します。返された属性には、UI 名、説明、セグメント サポートなどが含まれます。

例えばディメンションとしてOSやUserAgentのリストを取得できたりする。
新しいOSやUserAgentでのアクセスデータがあった場合は自動で追加されるので、自前で管理したりしなくていいというわけ。

取得したディメンションや指標はReporting APIでクエリを組み立てるのに使ったりできる。

Management API

アカウント、プロパティ、ビュー、フィルタ、アップロード、権限などを表示および管理します。

https://developers.google.com/analytics/devguides/config/mgmt/v3

アナリティクスの Management API を使用すると、プログラムによって Google アナリティクスの設定データにアクセスすることができます。この API を使って開発したアプリーションでは、大規模な構成や複雑な構成のアナリティクス アカウントを効率的に管理できるようになります。 多くのプロパティを持つ大企業はアカウント設定を自動化することが可能で、レポート作成アプリケーションを開発する場合にも、Management API のアカウント操作ツールを使用できます。

UAのコンフィグを色々と行うことができるAPI。

User Deletion API

ユーザー ID に関連付けられている Google アナリティクスのプロパティ データをすべて削除します。

https://developers.google.com/analytics/devguides/config/userdeletion/v3

Google アナリティクスの User Deletion API を使用すると、特定のユーザー ID に関連付けられたデータの削除を処理できます。このツールは、データの安全保護対策に役立つツールの 1 つです。

ウェブサイトやアプリの利用者のデータをレポートから削除するためのAPI。

プライバシーにうるさい時勢柄必要なのかなというやつ。

削除リクエストされたデータは72時間以内にレポートから削除され、2ヵ月ごとの削除プロセスの際にGoogle Analyticsのサーバーからも完全に削除される。

GA4に対応したAPI

Data API(プレビュー)

Google アナリティクス 4(GA4)プロパティのレポートデータにアクセスします。

https://developers.google.com/analytics/devguides/reporting/data/v1

The Google Analytics Data API v1 gives you programmatic access to Google Analytics 4 (GA4) report data. Google Analytics 4 helps you understand how people use your web, iOS, or Android app. Learn more about Google Analytics 4 properties.

ベータ版。

2020年10月にリリースされたGA4のレポートデータを取得できる。
GA4は従来のUA(ユニバーサルアナリティクス)と違って集計データではなく生データ(1イベント1行)にアクセスできるので、このAPIでもそういう生データにクエリが投げられる?

UAにおけるCore Reporting APIのようなものと理解。

Admin API(プレビュー)

Google アナリティクス 4(GA4)の設定データにアクセスします。

https://developers.google.com/analytics/devguides/config/admin/v1

ベータ版。

The Google Analytics Admin API allows for programmatic access to the Google Analytics 4 (GA4) configuration data and is only compatible with GA4 properties

GA4のコンフィグを色々と行うことができるAPI。

UAのManagement API相当のもの。

備考

API リクエストの制限と割り当て

https://developers.google.com/analytics/devguides/reporting/realtime/v3/limits-quotas

リソースの割り当て制限がある。

プロジェクトごとのリクエスト数制限が50,000件/日。
IPアドレスあたりのリクエスト制限が10件/秒。

不特定多数のクライアントからリクエストが発生するような作りにすると割とすぐ制限に達するので注意といったところ。

Profile

フルスタック気味のフリーランスプログラマー。

どちらかと言うと得意はインフラ構築とサーバーサイドプログラミングですが、フロントエンドもぼちぼちやっています。

最近の興味範囲はWordPress、AWS、サーバーレス、UIデザイン。

愛車はセロー。カメラはペンタックス。旅好きです。横浜在住。