概要: このドキュメントでは、Google アナリティクス Admin API バージョン 1.0 の概要を説明します。
API の Alpha チャンネルと Beta チャンネルの両方は引き続きサポートされます。Beta チャンネルには、アルファ版として利用可能な機能のサブセットが含まれています。これらの機能は安定版とみなされ、今後大幅な変更が行われることはないと想定されています。新しい機能は、完成したらベータ版に追加されます。
はじめに
Google Analytics Admin API を使用すると、Google アナリティクス 4(GA4)の設定データにプログラムでアクセスできます。GA4 プロパティにのみ対応しています。GA4 のプロパティの詳細もご覧ください。
Google Analytics Admin API を使用すると、次のことができます。
- 新しいアカウントのプロビジョニング。
- アカウントの管理。
- データ共有設定を管理します。
- アカウントの概要を一覧表示する。
- 変更履歴のイベントを検索する。
- プロパティの管理。
- ユーザーデータの収集を承認します。
- プロパティのデータ保持設定を管理します。
- プロパティの Google シグナル設定を管理する(アルファ版)。
- ストリームの管理。
- Measurement Protocol のシークレットの管理
- SKAdNetwork コンバージョン値スキーマ(アルファ版)を管理します。
- ウェブデータ ストリーム用の 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
SKAdNetwork コンバージョン値スキーマ管理(アルファ版)
properties.dataStreams.sKAdNetworkConversionValueSchema.get
properties.dataStreams.sKAdNetworkConversionValueSchema.create
properties.dataStreams.sKAdNetworkConversionValueSchema.delete
properties.dataStreams.sKAdNetworkConversionValueSchema.update
properties.dataStreams.sKAdNetworkConversionValueSchema.list
コンバージョン イベントの管理
properties.conversionEvents.create
properties.conversionEvents.get
properties.conversionEvents.list
properties.conversionEvents.delete
properties.conversionEvents.update
カスタム ディメンションの管理
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 設定プロセスについて