概要: このドキュメントでは、Google アナリティクス Admin API バージョン 1.0 の概要を説明します。
API のアルファ版とベータ版の両方のチャンネルは引き続きサポートされます。Beta チャンネルには、安定版とみなされ、今後大幅な変更が発生することはないと思われるアルファ版の機能のサブセットが含まれています。新たな機能は、一般公開時期になるとベータ版に追加されます。
はじめに
Google アナリティクス Admin API を使用すると、Google アナリティクス 4(GA4)の設定データにプログラムでアクセスできます。また、GA4 プロパティにのみ対応しています。GA4 のプロパティの詳細もご覧ください。
Google アナリティクス Admin API を使用すると、次のことができます。
- 新規アカウントをプロビジョニングする。
- アカウントの管理。
- データ共有設定を管理する
- アカウントの概要を一覧表示する。
- 変更履歴イベントを検索します。
- プロパティを管理します。
- ユーザーデータの収集を認める。
- プロパティのデータ保持設定を管理する。
- プロパティの Google シグナル設定を管理する(アルファ版)
- ストリームを管理する。
- Measurement Protocol Secret を管理します。
- ウェブデータ ストリーム用の Google タグ スニペットを生成する(アルファ版)
- コンバージョン イベントを管理する
- カスタム ディメンションを管理する
- カスタム指標を管理する
- GA4 プロパティと Firebase プロジェクトの間のリンクを管理します。
- GA4 プロパティと Google 広告アカウント間のリンクを管理する
- GA4 プロパティとディスプレイ &ビデオ 360 広告主のリンクに関する提案を管理する(アルファ版)
- GA4 プロパティとディスプレイ &ビデオ 360 広告主のリンクを管理する(アルファ版)
- GA4 プロパティと検索広告 360(アルファ版)の間のリンクを管理する
- GA4 プロパティと BigQuery プロジェクト(アルファ版)との間のリンクを管理する
- アカウント階層と GA4 プロパティ(アルファ版)のユーザー権限を管理する
- データアクセス レポートを生成する(アルファ版)。
- オーディエンスの管理(アルファ版)。
- 展開済みのデータセットを管理する(アルファ版)。
- 自動化された GA4 設定プロセスのオプトアウト設定(アルファ版)を管理する。
利用可能なメソッド
アカウント プロビジョニング
accounts.provisionAccountTicket
このメソッドは、利用規約(TOS)の URL(
https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID
)に含める必要のあるaccountTicketId
フィールドを返します。ユーザーが TOS URL にアクセスして利用規約に同意すると、Google アナリティクス アカウントの作成が完了します(アカウントのプロビジョニング サンプル)。
アカウント管理
データ共有設定の管理
アカウント概要のリスト
変更履歴のイベントを検索する
不動産管理
ユーザーデータの収集の確認
データ保持設定の管理
Google シグナルの設定管理(アルファ版)
データ ストリーム管理
properties.dataStreams.create
properties.dataStreams.get
properties.dataStreams.list
properties.dataStreams.patch
properties.dataStreams.delete
Measurement Protocol シークレット管理
properties.dataStreams.measurementProtocolSecrets.create
properties.dataStreams.measurementProtocolSecrets.get
properties.dataStreams.measurementProtocolSecrets.patch
properties.dataStreams.measurementProtocolSecrets.list
properties.dataStreams.measurementProtocolSecrets.delete
コンバージョン イベントの管理
properties.conversionEvents.create
properties.conversionEvents.get
properties.conversionEvents.list
properties.conversionEvents.delete
カスタム ディメンションの管理
properties.customDimensions.create
properties.customDimensions.get
properties.customDimensions.list
properties.customDimensions.patch
properties.customDimensions.archive
カスタム指標の管理
properties.customMetrics.create
properties.customMetrics.get
properties.customMetrics.list
properties.customMetrics.patch
properties.customMetrics.archive
Firebase プロジェクトのリンク
Google 広告アカウントとのリンク
properties.googleAdsLinks.create
properties.googleAdsLinks.list
properties.googleAdsLinks.patch
properties.googleAdsLinks.delete
Google タグの生成(アルファ版)
GA4 プロパティとディスプレイ &ビデオ 360 広告主のリンクに関する提案(アルファ版)
properties.displayVideo360AdvertiserLinkProposals.create
properties.displayVideo360AdvertiserLinkProposals.approve
properties.displayVideo360AdvertiserLinkProposals.cancel
properties.displayVideo360AdvertiserLinkProposals.list
properties.displayVideo360AdvertiserLinkProposals.get
properties.displayVideo360AdvertiserLinkProposals.delete
ディスプレイ &ビデオ 360 広告主のアカウントのリンク(アルファ版)
properties.displayVideo360AdvertiserLinks.create
properties.displayVideo360AdvertiserLinks.get
properties.displayVideo360AdvertiserLinks.list
properties.displayVideo360AdvertiserLinks.delete
properties.displayVideo360AdvertiserLinks.patch
検索広告 360 アカウントのリンク(アルファ版)
properties.searchAds360Links.create
properties.searchAds360Links.delete
properties.searchAds360Links.patch
properties.searchAds360Links.list
properties.searchAds360Links.get
詳しくは、GA4 プロパティのアナリティクス 検索広告 360 統合の設定についての記事をご覧ください。
BigQuery アカウントのリンク(アルファ版)
GA4 プロパティの BigQuery Export の設定に関する詳細
ユーザー権限の管理(アルファ版)
accounts.accessBindings.create
accounts.accessBindings.delete
accounts.accessBindings.patch
accounts.accessBindings.list
accounts.accessBindings.get
accounts.accessBindings.batchCreate
accounts.accessBindings.batchDelete
accounts.accessBindings.batchUpdate
accounts.accessBindings.batchGet
properties.accessBindings.create
properties.accessBindings.delete
properties.accessBindings.patch
properties.accessBindings.list
properties.accessBindings.get
properties.accessBindings.batchCreate
properties.accessBindings.batchDelete
properties.accessBindings.batchUpdate
properties.accessBindings.batchGet
データアクセス レポート(アルファ版)
この機能の詳細については、データアクセス レポートに関するガイドをご覧ください。
オーディエンス管理(アルファ版)
properties.audiences.create
properties.audiences.archive
properties.audiences.patch
properties.audiences.list
properties.audiences.get
Google アナリティクスのオーディエンスについての詳細
拡張されたデータセット管理(アルファ版)
properties.expandedDataSets.create
properties.expandedDataSets.delete
properties.expandedDataSets.patch
properties.expandedDataSets.list
properties.expandedDataSets.get
詳しくは、Google アナリティクス 360 の拡張データセットについての記事をご覧ください。
自動化された GA4 設定プロセスのオプトアウト(アルファ版)
UA プロパティの自動 GA4 設定プロセスのオプトアウト ステータスの管理についての詳細