Google Analytics Admin API 總覽

摘要：本文件提供 Google Analytics Admin API 1.0 版的概略總覽。

這個 API 目前提供 Alpha 版和 Beta 版提供的功能。

Alpha 測試版

Alpha 版功能仍在早期預先發布版階段。我們會盡量通知您即將發布的異動，但 API 公開發布前，您應該還是會遇到破壞性變更。

測試版

這個管道預計不會發生破壞性變更。請注意，正式發布前的產品僅提供有限支援，且正式發布前產品的變更可能與其他正式發布前版本不相容。

如需 Google Analytics (分析) API 官方公告，請訂閱 Google Analytics API Notify Group。

簡介

Google Analytics Admin API 可讓您以程式輔助方式存取 Google Analytics (分析) 4 (GA4) 設定資料，而且僅與 GA4 資源相容。進一步瞭解 GA4 資源。

Google Analytics Admin API 的用途如下：

• 佈建新帳戶。
• 管理帳戶。
• 管理資料共用設定。
• 清單帳戶摘要。
• 搜尋變更記錄事件。
• 管理資源。
• 確認使用者資料收集作業。
• 管理資源的資料保留設定。
• 管理資源的 Google 信號設定 (Alpha 版)。
• 管理直播。
• 管理 Measurement Protocol 密鑰。
• 管理 SKAdNetwork 轉換價值結構定義 (Alpha 版)。
• 產生網站資料串流的 Google 代碼片段 (Alpha 版)。
• 管理轉換事件。
• 管理自訂維度。
• 管理自訂指標。
• 管理 GA4 資源和 Firebase 專案之間的連結。
• 管理 GA4 資源和 Google Ads 帳戶之間的連結。
• 管理 GA4 資源與 Display & Video 360 廣告主 (Alpha 版) 之間的連結提案。
• 管理 GA4 資源與 Display & Video 360 廣告主 (Alpha 版) 之間的連結。
• 管理 GA4 資源與 Search Ads 360 (Alpha 版) 之間的連結。
• 管理 GA4 資源與 BigQuery 專案 (Alpha 版) 之間的連結。
• 管理帳戶階層和 GA4 資源 (Alpha 版) 的使用者權限。
• 產生資料存取報表。
• 管理目標對象 (Alpha 版)。
• 管理展開資料集 (Alpha 版)。
• 管理自動 GA4 設定程序的選擇不採用設定 (Alpha 版)。

可用方法

以下提供可用的方法。

帳戶佈建

• accounts.provisionAccountTicket

這個方法會傳回應納入服務條款 (TOS) 網址中的 accountTicketId 欄位：https://analytics.google.com/analytics/web/?provisioningSignup=false#/termsofservice/ACCOUNT_TICKET_ID。使用者造訪《服務條款》網址並接受《服務條款》後，系統就會完成 Google Analytics (分析) 帳戶建立程序。請參閱帳戶佈建範例。

帳戶管理

• 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 信號設定管理 (Alpha 版)

• 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 轉換價值結構定義管理 (Alpha 版)

• 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 Ads 帳戶連結

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

產生 Google 代碼 (Alpha 版)

• properties.webDataStreams.getGlobalSiteTag

GA4 資源與 Display & Video 360 廣告客戶之間的連結提案 (Alpha 版)

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

Display & Video 360 廣告主帳戶連結 (Alpha 版)

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

Search Ads 360 帳戶連結 (Alpha 版)

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

進一步瞭解如何為 GA4 資源設定 Analytics (分析) Search Ads 360 整合。

BigQuery 帳戶連結 (Alpha 版)

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

如要進一步瞭解如何為 GA4 資源設定 BigQuery 匯出作業，請參閱這篇文章。

使用者權限管理 (Alpha 版)

• 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

如要進一步瞭解這項功能，請參閱資料存取報表指南。

目標對像管理 (Alpha 版)

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

進一步瞭解 Google Analytics (分析) 目標對象。

展開資料集管理 (Alpha 版)

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

如要進一步瞭解 Google Analytics (分析) 360 中的展開資料集，請參閱本文。

自動選擇不採用 GA4 設定程序 (Alpha 版)

• properties.setAutomatedGa4ConfigurationOptOut
• properties.fetchAutomatedGa4ConfigurationOptOut

進一步瞭解如何管理通用 Analytics (分析) 資源的自動 GA4 設定程序，管理停用狀態。