Google Analytics Admin API の概要

概要: このドキュメントでは、Google Analytics Admin API バージョン 1.0 の概要を説明します。

この API は現在、アルファ版とベータ版のチャンネルで利用可能な機能を提供しています。

アルファ版

アルファ版チャンネルの機能は初期プレビュー段階です。今後の変更については随時お知らせしますが、API が一般公開される前に互換性を破る変更が適用される見込みです。

ベータ版

このチャンネルには互換性を破る変更はありません。pre-GA プロダクトではサポートが制限されることがあります。また、pre-GA プロダクトの変更は他の pre-GA バージョンと互換性がない可能性があります。

Google アナリティクス API に関する公式のお知らせについては、Google Analytics API Notify Group にご登録ください。

はじめに

Google Analytics Admin API を使用すると、Google アナリティクス 4（GA4）の設定データにプログラムでアクセスできます。GA4 プロパティにのみ対応しています。GA4 プロパティの詳細

Google Analytics Admin API を使用すると、次のことができます。

• 新しいアカウントのプロビジョニング。
• アカウントの管理。
• データ共有設定を管理します。
• アカウントの概要を一覧表示する。
• 変更履歴イベントを検索する。
• プロパティを管理する。
• ユーザーデータの収集を承認します。
• プロパティのデータ保持設定を管理する
• プロパティの Google シグナルの設定を管理する（アルファ版）
• ストリームを管理する。
• Measurement Protocol Secret を管理します。
• 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 アナリティクス アカウントの作成が完了します。アカウント プロビジョニングのサンプルをご覧ください。

アカウント管理

• 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 のシークレット管理

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

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

• 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.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 自動設定プロセスのオプトアウト（アルファ版）

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

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