mcpField
G
google-analytics-admin-api-basics

google-analytics-admin-api-basics

github.com/googleマーケティング・グロース21.6k7.3k 回インストール今日更新
リポジトリ

google-analytics-admin-api-basics について

Google Analytics Admin APIを使う開発者向けの入門スキルです。APIの有効化、認証、クライアントライブラリに加え、アカウントやプロパティ、データストリームの設定作業を紹介します。

主な機能

  1. 01Admin APIの有効化と確認
  2. 02ADC認証とスコープの設定
  3. 03アカウントとプロパティの管理
  4. 04言語別クライアントライブラリの紹介
  5. 05Pythonクイックスタート

活用シーン

  1. 01Analyticsアカウント管理の自動化
  2. 02プロパティの作成と設定
  3. 03データストリームとカスタム指標の管理

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/google/skills --skill google-analytics-admin-api-basics

インストール後、Claude Code で/google-analytics-admin-api-basicsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
dotnet.md
go.md
java.md
nodejs.md
php.md
python.md
ruby.md

詳細

Google Analytics Admin API の利用開始

Google Analytics Admin API は、Google Analytics のアカウントとプロパティの設定にプログラムからアクセスする手段を提供します。アカウント管理の自動化、データストリームの管理、カスタムディメンションの設定、プロダクト連携の処理ができます。

Cloud CLI による API の有効化

API 呼び出しを行う前に、Google Cloud プロジェクトで Google Analytics Admin API が有効になっていることを確認してください。

gcloud が見つからない場合は、これらのコマンドを実行する前に、Google Cloud CLI をインストールするようユーザーに促してください。

  1. API を有効にする： Cloud CLI（gcloud）を使って analyticsadmin.googleapis.com を有効にします。

    gcloud services enable analyticsadmin.googleapis.com --quiet

    理由：API を有効にすると、Google Analytics の設定を管理するために必要な割り当て量と権限が Cloud プロジェクトに割り当てられます。

  2. API の有効化を確認する：

    gcloud services list --enabled --filter="analyticsadmin.googleapis.com"

認証

API リクエストを認証するには、Application Default Credentials（ADC）を生成し、アカウントに必要なスコープを付与する必要があります。ターミナルで次のコマンドを実行してください。

gcloud auth application-default login --scopes="https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/analytics.readonly"

理由：これにより、必要な Cloud Platform と Google Analytics の読み取り専用スコープを使ってローカル環境に ADC が設定され、クライアントライブラリがリクエストを自動的に認証できるようになります。

メモ

設定の変更：Google Analytics のアカウント／プロパティ設定を変更するメソッドには、 https://www.googleapis.com/auth/analytics.edit スコープが必要です。

Admin API のユースケース

Google Analytics Admin API は、次の用途に使用できます。

  • データアクセスレポートの実行（詳細については、 https://developers.google.com/analytics/devguides/config/admin/v1/access-api.md.txt を参照）
  • アカウント概要の作成
  • アカウントの管理
  • 新しいアカウントのプロビジョニング
  • アカウント変更履歴イベントの検索
  • プロパティの管理と作成
  • プロパティのデータ保持設定の管理
  • コンバージョンイベントの管理
  • カスタムディメンションと指標の管理
  • データストリームの管理と Measurement Protocol シークレットの設定
  • Firebase リンクの管理
  • Google Ads リンクの管理
  • キーイベントの管理
v1alpha のみで利用可能なユースケース

次の機能は、現在 Admin API の v1alpha バージョンでのみ利用できます。

  • アカウントとプロパティのアクセスバインディングの管理
  • ロールアッププロパティの作成と管理
  • サブプロパティの作成と管理
  • ユーザーデータの収集の確認
  • プロパティのアトリビューション、データ保持、Google signals、レポート用 ID、ユーザー提供データの設定の変更
  • AdSense リンクの管理
  • BigQuery リンクの管理
  • オーディエンスの管理
  • チャネルグループの管理
  • 計算指標の管理
  • DisplayVideo360Advertiser リンクの管理
  • 拡張データセットの管理
  • レポートデータの注釈の管理
  • SearchAds360 リンクの管理
  • データストリームのイベント作成ルールの管理
  • iOS ストリームの SKAdNetwork コンバージョン値スキーマの管理
  • Google Analytics プロパティのユーザー削除リクエストの送信

Admin API の呼び出し

Admin API を使用するには、公式の Google Analytics Admin クライアントライブラリを使います。Admin API の最も安定したバージョンは v1beta です。最新の機能を利用する場合は、v1alpha をご検討ください。

重要

エージェントへの必須指示： ユーザーが特定のプログラミング言語を選択または指定した場合は、以下に記載されている references/ 内の対応するクライアントライブラリ設定リファレンスガイドを読んでください。

対応クライアントライブラリ
Python

Python 用の Google Analytics Admin API クライアントライブラリをインストールまたは設定する必要がある場合は、セットアップガイドをお読みください。

Java

Java 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

PHP

PHP 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

Node.js

Node.js 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

Go

Go 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

.NET

.NET / C# 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

Ruby

Ruby 用の Google Analytics Admin API クライアントライブラリをインストールまたはセットアップする必要がある場合は、セットアップガイドをお読みください。

メモ

追加リソース：Java、PHP、Node.js、.NET、Python、REST を使って Admin API を呼び出す例や、サービスアカウントで認証する際のヒントについては、公式の Admin API クイックスタートを参照してください。 v1alpha と v1beta の両方の完全な API リファレンスドキュメントについては、 Admin API リファレンスを参照してください。

Python クイックスタート

  1. クライアントライブラリをインストールする：

    pip install google-analytics-admin

    pip を利用できない場合は、クライアントライブラリをインストールする前に pip をインストールするようユーザーに促してください。

  2. アカウントとプロパティを一覧表示する： 以下は、list_account_summaries() を使用して、現在のユーザーが利用できるすべてのアカウントとその子プロパティを一覧表示するために Admin API を呼び出す方法を示した完全な例です。

    from google.analytics.admin import AnalyticsAdminServiceClient

def sample_list_account_summaries():
    # クライアントを初期化します。
    # 環境で Application Default Credentials (ADC) が設定されていることを前提とします。
    client = AnalyticsAdminServiceClient()

    # list_account_summaries は、ユーザーがアクセスできるすべてのアカウントと
    # その子プロパティの概要を返します。
    account_summaries = client.list_account_summaries()

    print("利用可能な Google Analytics のアカウントとプロパティ：")
    for summary in account_summaries:
        print(f"Account: {summary.display_name} ({summary.account})")
        for property_summary in summary.property_summaries:
            print(f"  Property: {property_summary.display_name} ({property_summary.property})")

if __name__ == "__main__":
    sample_list_account_summaries()

コメント

Markdown 対応