概要: このドキュメントでは、Google アナリティクス Admin API バージョン 1.0 の概要を説明します。
はじめに
Google アナリティクス Admin API を使用すると、Google アナリティクスの設定データにプログラムでアクセスできます。この API は Google アナリティクスのプロパティとのみ互換性があります。詳しくは、Google アナリティクスのプロパティをご覧ください。
Google Analytics Admin API を使用すると、次のことができます。
- 新しいアカウントをプロビジョニングします。
- アカウントを管理する。
- データ共有設定を管理します。
- アカウントの概要を一覧表示します。
- 変更履歴イベントを検索します。
- プロパティを管理します。
- サブプロパティを管理する。
- ユーザーデータの収集を確認します。
- プロパティのデータ保持設定を管理します。
- プロパティの Google シグナルの設定を管理します（アルファ版）。
- ストリームを管理します。
- Measurement Protocol のシークレットを管理します。
- SKAdNetwork コンバージョンの値スキーマを管理する（アルファ版）。
- ウェブデータ ストリーム用の Google タグスニペットを生成します（アルファ版）。
- キーイベントを管理します。
- コンバージョン イベントを管理する（非推奨）。
- イベント作成ルールを管理する（アルファ版）
- イベント編集ルールを管理する（アルファ版）
- カスタム ディメンションを管理します。
- カスタム指標を管理します。
- Google アナリティクスのプロパティと Firebase プロジェクトの間のリンクを管理します。
- Google アナリティクスのプロパティと Google 広告アカウントとのリンクを管理します。
- Google アナリティクスのプロパティとディスプレイ＆ビデオ 360 広告主のリンクに関する提案を管理します（アルファ版）。
- Google アナリティクスのプロパティとディスプレイ＆ビデオ 360 広告主間のリンクを管理します（アルファ版）。
- Google アナリティクスのプロパティと検索広告 360 のリンクを管理する（アルファ版）。
- Google アナリティクスのプロパティと BigQuery プロジェクト間のリンクを管理します（アルファ版）。
- アカウント階層と Google アナリティクス プロパティのユーザー権限を管理します（アルファ版）。
- データアクセス レポートを生成します。
- オーディエンスを管理する（アルファ版）。
- 拡張データセットを管理します（アルファ版）。
- Google アナリティクスの自動設定プロセスのオプトアウト設定を管理します（アルファ版）。
利用可能なメソッド
使用可能なメソッドは次のとおりです。
アカウント プロビジョニング
このメソッドは、利用規約（TOS）の URL に含める必要がある accountTicketId フィールドを返します。
https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID
ユーザーが利用規約の URL にアクセスして利用規約に同意すると、Google アナリティクス アカウントの作成が完了します。アカウント プロビジョニングのサンプルをご覧ください。
アカウント管理
データ共有設定の管理
アカウント概要のリスト
変更履歴イベントを検索する
プロパティの管理
サブプロパティの管理（アルファ版）
ユーザーデータ収集の確認
データ保持設定の管理
Google シグナルの設定の管理（アルファ版）
データ ストリームの管理
properties.dataStreams.createproperties.dataStreams.getproperties.dataStreams.listproperties.dataStreams.patchproperties.dataStreams.delete
Measurement Protocol シークレットの管理
properties.dataStreams.measurementProtocolSecrets.createproperties.dataStreams.measurementProtocolSecrets.getproperties.dataStreams.measurementProtocolSecrets.patchproperties.dataStreams.measurementProtocolSecrets.listproperties.dataStreams.measurementProtocolSecrets.delete
SKAdNetwork コンバージョンの値スキーマの管理（アルファ版）
properties.dataStreams.sKAdNetworkConversionValueSchema.getproperties.dataStreams.sKAdNetworkConversionValueSchema.createproperties.dataStreams.sKAdNetworkConversionValueSchema.deleteproperties.dataStreams.sKAdNetworkConversionValueSchema.updateproperties.dataStreams.sKAdNetworkConversionValueSchema.list
キーイベントの管理
properties.keyEvents.createproperties.keyEvents.getproperties.keyEvents.listproperties.keyEvents.deleteproperties.keyEvents.patch
コンバージョン イベントの管理
properties.conversionEvents.createproperties.conversionEvents.getproperties.conversionEvents.listproperties.conversionEvents.deleteproperties.conversionEvents.patch
イベント作成ルールの管理（アルファ版）
properties.dataStreams.eventCreateRules.createproperties.dataStreams.eventCreateRules.getproperties.dataStreams.eventCreateRules.listproperties.dataStreams.eventCreateRules.deleteproperties.dataStreams.eventCreateRules.patch
イベント編集ルールの管理（アルファ版）
properties.dataStreams.eventEditRules.createproperties.dataStreams.eventEditRules.getproperties.dataStreams.eventEditRules.listproperties.dataStreams.eventEditRules.deleteproperties.dataStreams.eventEditRules.patchproperties.dataStreams.eventEditRules.reorder
カスタム ディメンションの管理
properties.customDimensions.createproperties.customDimensions.getproperties.customDimensions.listproperties.customDimensions.patchproperties.customDimensions.archive
カスタム指標の管理
properties.customMetrics.createproperties.customMetrics.getproperties.customMetrics.listproperties.customMetrics.patchproperties.customMetrics.archive
Firebase プロジェクトのリンク
Google 広告アカウントとのリンク
properties.googleAdsLinks.createproperties.googleAdsLinks.listproperties.googleAdsLinks.patchproperties.googleAdsLinks.delete
Google タグの生成（アルファ版）
Google アナリティクスのプロパティとディスプレイ＆ビデオ 360 広告主のリンクの提案（アルファ版）
properties.displayVideo360AdvertiserLinkProposals.createproperties.displayVideo360AdvertiserLinkProposals.approveproperties.displayVideo360AdvertiserLinkProposals.cancelproperties.displayVideo360AdvertiserLinkProposals.listproperties.displayVideo360AdvertiserLinkProposals.getproperties.displayVideo360AdvertiserLinkProposals.delete
ディスプレイ＆ビデオ 360 広告主アカウントのリンク（アルファ版）
properties.displayVideo360AdvertiserLinks.createproperties.displayVideo360AdvertiserLinks.getproperties.displayVideo360AdvertiserLinks.listproperties.displayVideo360AdvertiserLinks.deleteproperties.displayVideo360AdvertiserLinks.patch
検索広告 360 アカウントのリンク（アルファ版）
properties.searchAds360Links.createproperties.searchAds360Links.deleteproperties.searchAds360Links.patchproperties.searchAds360Links.listproperties.searchAds360Links.get
詳しくは、Google アナリティクス プロパティの アナリティクスと検索広告 360 の統合を設定するをご覧ください。
BigQuery アカウントのリンク（アルファ版）
properties.bigQueryLinks.createproperties.bigQueryLinks.deleteproperties.bigQueryLinks.getproperties.bigQueryLinks.listproperties.bigQueryLinks.patch
Google アナリティクスのプロパティの BigQuery Export の設定の詳細をご確認ください。
ユーザー権限の管理（アルファ版）
accounts.accessBindings.createaccounts.accessBindings.deleteaccounts.accessBindings.patchaccounts.accessBindings.listaccounts.accessBindings.getaccounts.accessBindings.batchCreateaccounts.accessBindings.batchDeleteaccounts.accessBindings.batchUpdateaccounts.accessBindings.batchGetproperties.accessBindings.createproperties.accessBindings.deleteproperties.accessBindings.patchproperties.accessBindings.listproperties.accessBindings.getproperties.accessBindings.batchCreateproperties.accessBindings.batchDeleteproperties.accessBindings.batchUpdateproperties.accessBindings.batchGet
データアクセス レポート
この機能について詳しくは、データアクセス レポートのガイドをご覧ください。
オーディエンス管理（アルファ版）
properties.audiences.createproperties.audiences.archiveproperties.audiences.patchproperties.audiences.listproperties.audiences.get
詳しくは、Google アナリティクスのオーディエンスをご覧ください。
拡張データセットの管理（アルファ版）
properties.expandedDataSets.createproperties.expandedDataSets.deleteproperties.expandedDataSets.patchproperties.expandedDataSets.listproperties.expandedDataSets.get
Google アナリティクス 360 の拡張データセットの詳細をご覧ください。
Google アナリティクスの自動設定プロセスのオプトアウト（アルファ版）
ユニバーサル アナリティクス プロパティの Google アナリティクス自動設定プロセスのオプトアウト ステータスを管理する方法