GASでGA4のAPIの使い方！簡単にGA4指標数値が取得するサンプルコード解説

2022年5月25日2023年2月2日

Google Apps Scriptで追加できるサービスにGA4のデータを取得できる「Google Analytics Data API」が登場しました。

これまではGCPのAPI設定など複雑でしたが、GASのサービス追加でカンタンにGA4のAPIにリクエストが可能になりました。

1. GA4用API「Google Analytics Data API」
2. 元々、GA4のAPIはGCPで有効化・権限設定が煩雑
3. GA4のAPIがGASのサービス追加が可能に！
4. GA4のAPIをGASサービス追加で利用する方法
5. フィルタで絞り込みしたい場合
6. メトリクスやディメンションの把握が重要
7. リアルタイムレポートやピボットレポートも
8. フィルタ設定で条件を絞ったデータ取得
9. まとめ・終わりに

GA4用API「Google Analytics Data API」

GA4からデータを取得して、スプレッドシートに出力する場合に、API(アプリケーション・プログラミング・インタフェース)を利用します。

従来のGoogle Analytics(ユニバーサルアナリティクス)でもAPI経由でデータが取得できましたが、実はGA4とユニバーサルアナリティクスではAPIが異なります。

GA4用のAPIは「Google Analytics Data API」といいます。

グーグルアナリティクス4(GA4)用「Google Analytics Data API 」で実行可能なメソッドは6種類

2021年春にGA4用のAPIのベータ版が登場し、GA4で収集しているデータをAPIリクエストして取り出せるようになりました。

元々、GA4のAPIはGCPで有効化・権限設定が煩雑

ただ、元々、このGA4のAnalytics Data APIを使うには、Google Cloud Platfrom(GCP)の設定が必要でした。

その上で、Google Apps Script(GAS)でAnalytics Data APIをリクエストするために、GASプロジェクト側でも設定しなければなりませんでした。

GCPのアカウント登録
Google Analytics Data API有効化
APIの実行権限・ユーザー認証設定
GASスクリプトでGCPプロジェクトの紐づけ
マニュフェストファイルappsscript.json修正

上記のようなGCPとGASでそれぞれ設定を施した上で、GA4 APIにリクエストするGASコードが記述する必要がありました。

※GA4用API(Analytics Data API)をGASから利用する方法は以下の記事で詳細に解説しています。

GA4(グーグルアナリティクス4)のAPI使い方解説！GASのサンプルコード紹介

ユニバーサルアナリティクスと呼ばれる従来のグーグルアナリティクスよりも、GASでデータを取得するのが複雑で大変でした。

GA4のAPIがGASのサービス追加が可能に！

そんな中、GA4用の「Google Analytics Data API」がGoogle Apps Scriptで追加できるサービスに追加されました。

従来版Google Analytics(ユニバーサルアナリティクス)と同様に、GASのスクリプトエディタにあるサービス一覧に表示されています。

Google Apps ScriptプロジェクトのスクリプトエディタにあるサービスからGA4用のAPI「Google Analytics Data API」が追加してGASスクリプトから実行可能に

これによって、Google Apps ScriptのサービスからGA4のAPIを追加するだけで、APIが利用できるようになりました。

GCPでのAPI有効化や実行権限の設定が必要なくなり、とてもカンタンに使えるようになりました。

GA4のAPIをGASサービス追加で利用する方法

実際にGoogle Apps Script(GAS)のプロジェクトからGoogle Analytics Data APIをサービス追加して、GA4のデータを取得してスプレッドシートに出力する方法を解説します。

１．Google Apps Scriptで新しいプロジェクトを開き、スクリプトエディタのサービスの「+」をクリックします。

Google Apps Script(GAS)のスクリプトエディタからGA4のAPI「Google Analytics Data API」をサービス追加してGA4の指標数値を取得する方法

２．「サービスを追加」画面で、「Google Analytics Data API」を選択して、追加ボタンをクリックします。

Google Apps Script(GAS)のサービス追加画面に表示される「Google Analytics Data API」を選択して追加

サービス欄の下に「AnalyticsData」という表示が追加されます。

３．グーグルのリファレンスにAnalyticsDataを使ってGA4の指標を取得するサンプルコードが掲載されているのでアクセスします。

Google Apps ScriptでのGoogle Analytics Data API(AnalyticsData)のリファレンスページ

Analytics Data Service(Apps Script)【Google Developers】

４．リファレンスページをスクロールすると、analyticsData.gsというサンプルコードが表示されるので、アイコンをクリックしてコピーします。

Google Apps ScriptでGA4のAPIを実行するサンプルスクリプトがグーグルのリファレンスに掲載

５．GASのリファレンスからコピーしてきたサンプルコードをGASのスクリプトエディタに貼り付けます。

/**
 * Runs a report of a Google Analytics 4 property ID. Creates a sheet with the
 * report.
 */
function runReport() {
  /**
   * TODO(developer): Uncomment this variable and replace with your
   *   Google Analytics 4 property ID before running the sample.
   */
  const propertyId = 'YOUR-GA4-PROPERTY-ID';

  try {
    const metric = AnalyticsData.newMetric();
    metric.name = 'activeUsers';

    const dimension = AnalyticsData.newDimension();
    dimension.name = 'city';

    const dateRange = AnalyticsData.newDateRange();
    dateRange.startDate = '2020-03-31';
    dateRange.endDate = 'today';

    const request = AnalyticsData.newRunReportRequest();
    request.dimensions = [dimension];
    request.metrics = [metric];
    request.dateRanges = dateRange;

    const report = AnalyticsData.Properties.runReport(request,
        'properties/' + propertyId);
    if (!report.rows) {
      Logger.log('No rows returned.');
      return;
    }

    const spreadsheet = SpreadsheetApp.create('Google Analytics Report');
    const sheet = spreadsheet.getActiveSheet();

    // Append the headers.
    const dimensionHeaders = report.dimensionHeaders.map(
        (dimensionHeader) => {
          return dimensionHeader.name;
        });
    const metricHeaders = report.metricHeaders.map(
        (metricHeader) => {
          return metricHeader.name;
        });
    const headers = [...dimensionHeaders, ...metricHeaders];

    sheet.appendRow(headers);

    // Append the results.
    const rows = report.rows.map((row) => {
      const dimensionValues = row.dimensionValues.map(
          (dimensionValue) => {
            return dimensionValue.value;
          });
      const metricValues = row.metricValues.map(
          (metricValues) => {
            return metricValues.value;
          });
      return [...dimensionValues, ...metricValues];
    });

    sheet.getRange(2, 1, report.rows.length, headers.length)
        .setValues(rows);

    Logger.log('Report spreadsheet created: %s',
        spreadsheet.getUrl());
  } catch (e) {
    // TODO (Developer) - Handle exception
    Logger.log('Failed with error: %s', e.error);
  }
}