Google Analytics Admin API 總覽

摘要：本文件將概略介紹 Analytics Admin API 1.0 版。

這個 API 提供 Alpha 和 Beta 版的功能。Alpha 版和 Beta 版產品僅提供有限支援，且這類產品的變更可能與其他 Alpha 版和 Beta 版不相容。

Alpha 版： 功能目前仍處於早期預先發布版階段，當我們嘗試通知您 但預計會在 API 公開發布前遇到破壞性變更。

Beta 版： 這個頻道不會有破壞性變更。

如需 Google Analytics API 官方公告，請訂閱 Google Analytics API 通知群組。

簡介

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

Google Analytics Admin API 的用途如下：

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

可用方法

以下是可用的方法。

帳戶佈建

• accounts.provisionAccountTicket

這個方法會傳回應包含在 accountTicketId 中的 服務條款 (TOS) 網址： 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

子資源管理 (Alpha 版)

• properties.provisionSubproperty

使用者資料收集確認聲明

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

事件建立規則管理 (Alpha 版)

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

事件編輯規則管理 (Alpha 版)

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

自訂維度管理

• 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 資源與多媒體和多媒體連結的提案Video 360 廣告主 (Alpha 版)

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

多媒體和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

進一步瞭解如何設定 Analytics Search Ads 360 GA4 整合 資源。

BigQuery 帳戶連結 (Alpha 版)

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

進一步瞭解如何設定 BigQuery Export Google Analytics 4 資源

使用者權限管理 (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 設定程序。