Google Analytics Admin API 總覽

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

警告： 這是 API 的預先發布版，隨時可能變更。雖然我們會試著通知您即將推出的異動，但您應在 API 公開發布之前，先完成破壞性變更。

持續支援 API 的 Alpha 版和 Beta 版。Beta 版包含 Alpha 版提供的部分功能，這些版本目前穩定，且日後不會大幅變更。這些功能將在成熟階段新增至 Beta 版。

如需 Google Analytics (分析) API 官方公告，請訂閱 Google Analytics API 通知群組。 如要回報 API 相關問題，請填寫 Google Analytics API 測試人員意見回饋表單。

簡介

Google Analytics Admin API 允許透過程式輔助方式存取 Google Analytics (分析) 4 (GA4) 設定資料，只與 GA4 資源相容。進一步瞭解 GA4 資源。

Google Analytics Admin API 可讓您：

• 佈建新帳戶。
• 管理帳戶：
• 管理資料共用設定。
• 帳戶摘要：
• 搜尋變更記錄事件。
• 管理資源。
• 確認收集使用者資料。
• 管理資源的資料保留設定。
• 管理資源的 Google 信號設定 (Alpha 版)。
• 管理直播。
• 管理 Measurement Protocol 密鑰。
• 產生網站資料串流 (Alpha 版) 的 Google 代碼片段。
• 管理轉換事件：
• 管理自訂維度。
• 管理自訂指標。
• 管理 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 版)
• 管理已展開的資料集 (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

轉換事件管理

• 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 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

資料存取報表 (Alpha 版)

• 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 設定程序，請參閱這篇文章。