Google Analytics Admin API の概要

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

この API は、アルファ版と Beta チャンネルで機能を提供します。アルファ版とベータ版のプロダクトはサポートが制限されることがあり、これらのプロダクトの変更は、他のアルファ版とベータ版のバージョンと互換性がない可能性があります。

アルファ版: 機能は早期プレビュー版段階にあります。今後の変更については 通知するよう努めますが、API が一般公開される前に互換性を破る変更が発生する可能性があります。

ベータ版: このチャンネルでは、互換性を破る変更は予定されていません。

Google アナリティクス API の公式なお知らせを受け取るには、 Google Analytics API Notify Group にご登録ください。

はじめに

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

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

• 新しいアカウントをプロビジョニングする。
• アカウントを管理する。
• データ共有設定を管理する。
• アカウント概要を一覧表示する。
• 変更履歴イベントを検索する。
• プロパティを管理する。
• サブプロパティを管理する。
• ユーザーデータの収集を確認する。
• プロパティのユーザー削除リクエストを送信する（アルファ版）。
• プロパティのデータ保持設定を管理する。
• プロパティの Google シグナルの設定を管理する（アルファ版）。
• ストリームを管理する。
• Measurement Protocol Secret を管理する。
• SKAdNetwork コンバージョンの値スキーマを管理する（アルファ版）。
• ウェブデータ ストリームの Google タグスニペットを生成する（アルファ版）。
• キーイベントを管理する。
• コンバージョン イベントを管理する（非推奨）。
• イベント作成ルールを管理する（アルファ版）
• イベント編集ルールを管理する（アルファ版）
• カスタム ディメンションを管理する。
• カスタム指標を管理する。
• Google アナリティクスのプロパティと Firebase プロジェクト間のリンクを管理する。
• Google アナリティクスのプロパティと Google 広告アカウント間のリンクを管理する。
• Google アナリティクスのプロパティとディスプレイ＆ビデオ 360 広告主間のリンクの提案を管理する（アルファ版）。
• Google アナリティクスのプロパティとディスプレイ＆ビデオ 360 広告主間のリンクを管理する（アルファ版）。
• Google アナリティクスのプロパティと検索広告 360 間のリンクを管理する（アルファ版）。
• Google アナリティクスのプロパティと BigQuery プロジェクト間のリンクを管理する（アルファ版）。
• アカウント階層と Google アナリティクスのプロパティのユーザー権限を管理する（アルファ版）。
• データアクセス レポートを生成する。
• オーディエンスを管理する（アルファ版）。
• 拡張データセットを管理する（アルファ版）。
• レポートデータの注釈を管理する（アルファ版）。

利用可能なメソッド

利用可能なメソッドは次のとおりです。

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

• accounts.provisionAccountTicket

このメソッドは、利用規約（TOS）の URL に含める必要がある accountTicketId フィールドを返します。

https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID

ユーザーが利用規約の 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.provisionSubproperty

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

• properties.acknowledgeUserDataCollection

ユーザーの削除（アルファ版）

• properties.submitUserDeletion

データの保持設定の管理

• 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

SKAdNetwork コンバージョンの値スキーマの管理（アルファ版）

• properties.dataStreams.sKAdNetworkConversionValueSchema.get
• properties.dataStreams.sKAdNetworkConversionValueSchema.create
• properties.dataStreams.sKAdNetworkConversionValueSchema.delete
• properties.dataStreams.sKAdNetworkConversionValueSchema.update
• properties.dataStreams.sKAdNetworkConversionValueSchema.list

キーイベントの管理

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

コンバージョン イベントの管理

非推奨: 代わりに KeyEvent リソースとメソッドを使用してください。

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

イベント作成ルールの管理（アルファ版）

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

イベント編集ルールの管理（アルファ版）

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

カスタム ディメンションの管理

• 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

Google アナリティクスのプロパティとディスプレイ＆ビデオ 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

Google アナリティクスのプロパティの Analytics と検索広告 360 の統合の設定について詳しくは、こちらをご覧ください。

BigQuery アカウントのリンク（アルファ版）

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

Google アナリティクスのプロパティの 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 の拡張データセットについて詳しくは、こちらをご覧ください。

レポートデータの注釈の管理（アルファ版）

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

Google アナリティクスのリソースのReportingDataAnnotation注釈について詳しくは、こちらをご覧ください。