Google Analytics Admin API の概要

概要: このドキュメントでは、Google アナリティクス Admin API バージョン 1.0 の概要を説明します。

API の Alpha チャンネルと Beta チャンネルは、引き続きサポートされます。Beta チャンネルには、アルファ版で利用可能な機能の一部が含まれています。それらは安定版と見なされ、今後大規模な変更が行われないと想定されています。ベータ版のリリース時には新機能が追加される予定です。

はじめに

Google アナリティクス Admin API を使用すると、Google アナリティクス 4（GA4）の設定データにプログラムでアクセスできます。GA4 プロパティとのみ互換性があります。GA4 のプロパティの詳細もご覧ください。

Google アナリティクス Admin API を使用すると、次のことができます。

• 新しいアカウントをプロビジョニングする。
• アカウントの管理
• データ共有設定を管理する
• アカウントの概要を一覧表示します。
• 検索履歴のイベントを検索します。
• プロパティを管理する。
• ユーザーデータの収集を認める。
• プロパティのデータの保持設定を管理する
• プロパティの Google シグナルの設定を管理する（アルファ版）。
• ストリームの管理。
• Measurement Protocol Secret を管理します。
• ウェブデータ ストリーム用の Google タグ スニペットを生成する（アルファ版）。
• コンバージョン イベントを管理する
• カスタム ディメンションを管理する
• カスタム指標を管理する。
• GA4 プロパティと Firebase プロジェクト間のリンクを管理する
• GA4 プロパティと Google 広告アカウント間のリンクを管理する
• GA4 プロパティとディスプレイ & amp;ビデオ 360 広告主（アルファ版）のリンクに関するプロポーザルを管理する
• GA4 プロパティとディスプレイ & amp;ビデオ 360 広告主（アルファ版）とのリンクを管理する
• GA4 プロパティと検索広告 360（アルファ版）のリンクを管理する
• GA4 プロパティと BigQuery プロジェクト（アルファ版）とのリンクを管理します。
• アカウント階層と GA4 プロパティ（アルファ版）のユーザー権限を管理する。
• データアクセス レポート（アルファ版）を生成する。
• オーディエンスの管理（アルファ版）
• 拡張データセットを管理する（アルファ版）。
• GA4 設定プロセスの自動オプトアウト設定（アルファ版）を管理する

利用可能なメソッド

アカウント プロビジョニング

• accounts.provisionAccountTicket

  このメソッドは、利用規約（TOS）の URL に含める必要がある accountTicketId フィールドを返します。 https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_IDユーザーが TOS URL にアクセスして利用規約に同意すると、Google アナリティクス アカウントの作成が完了します（アカウントのプロビジョニング サンプル）。

アカウント管理

• accounts.delete
• accounts.get
• accounts.list
• accounts.patch

データ共有設定の管理

• accounts.getDataSharingSettings

アカウント概要のリスト

• accountSummaries.list

変更履歴のイベントを検索

• accounts.searchChangeHistoryEvents

不動産管理

• properties.get
• properties.patch
• properties.delete
• properties.list
• properties.create

ユーザーデータの収集確認

• properties.acknowledgeUserDataCollection

データ保持設定の管理

• properties.getDataRetentionSettings
• properties.updateDataRetentionSettings

Google シグナルの設定管理（アルファ版）

• properties.getGoogleSignalsSettings
• properties.updateGoogleSignalsSettings

データ ストリーム管理

• properties.dataStreams.create
• properties.dataStreams.get
• properties.dataStreams.list
• properties.dataStreams.patch
• properties.dataStreams.delete

Measurement Protocol Secret 管理

• 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 プロジェクトのリンク

• properties.firebaseLinks.create
• properties.firebaseLinks.list
• properties.firebaseLinks.delete

Google 広告アカウントとのリンク

• properties.googleAdsLinks.create
• properties.googleAdsLinks.list
• properties.googleAdsLinks.patch
• properties.googleAdsLinks.delete

Google タグの生成（アルファ版）

• properties.webDataStreams.getGlobalSiteTag

GA4 プロパティとディスプレイ & amp;ビデオ 360 の広告主（アルファ版）のリンクに関するプロポーザル

• properties.displayVideo360AdvertiserLinkProposals.create
• properties.displayVideo360AdvertiserLinkProposals.approve
• properties.displayVideo360AdvertiserLinkProposals.cancel
• properties.displayVideo360AdvertiserLinkProposals.list
• properties.displayVideo360AdvertiserLinkProposals.get
• properties.displayVideo360AdvertiserLinkProposals.delete

ディスプレイ & amp;ビデオ 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 アカウントのリンク（アルファ版）

• properties.bigQueryLinks.get
• properties.bigQueryLinks.list

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.runAccessReport

この機能について詳しくは、データアクセス レポート ガイドをご覧ください。

オーディエンス管理（アルファ版）

• properties.audience.create
• properties.audience.archive
• properties.audience.patch
• properties.audience.list
• properties.audience.get

詳しくは、Google アナリティクスのオーディエンスに関する記事をご覧ください。

拡張データセット管理（アルファ版）

• properties.expandedDataSets.create
• properties.expandedDataSets.delete
• properties.expandedDataSets.patch
• properties.expandedDataSets.list
• properties.expandedDataSets.get

詳しくは、Google アナリティクス 360 で拡張データセットについての説明をご確認ください。

GA4 設定プロセスの自動オプトアウト（アルファ版）

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

UA プロパティの自動 GA4 設定プロセスのオプトアウト ステータスの管理に関する詳細