變更記錄

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

2025-01-20 將使用者資料保留期限新增至 DataRetentionSettings

已將 userDataRetention 欄位新增至 Admin API v1alpha 和 v1beta 中的 DataRetentionSettings。使用這個欄位，即可擷取或修改使用者資料的保留設定。

2024-09-09 存取報表問卷調查表

runAccessReport 方法的說明文件已更新，新增了 Google Analytics 存取報表意見回饋表單的連結。我們非常重視您的意見，也鼓勵您分享對此 API 的想法，協助我們進一步改善 API。

新增 CreateBigQueryLink、UpdateBigQueryLink 和 DeleteBigQueryLink 方法，可透過 Admin API v1alpha 管理 BigQueryLink 資源。

在 BigQueryLink 資源中加入 dataset_location 欄位。

在 ChangeHistoryResourceType 中新增 BIGQUERY_LINK 值，並在變更記錄中加入 BigQuery 連結變更。

2024-08-01 createSubproperty 方法的破壞性變更

為符合自訂方法規範，在 Admin API v1alpha 中將 createSubproperty 自訂方法重新命名為 provisionSubproperty。

2024-08-01 新增事件編輯規則管理

GetEventEditRule、CreateEventEditRule、DeleteEventEditRule、ListEventEditRules、UpdateEventEditRules、ReorderEventEditRules，這些方法已新增至 Admin API v1alpha。

EventEditRule 會定義條件，根據來源事件的相符條件觸發建立全新事件。此外，EventEditRule 可定義來源事件的參數修改內容。

2024-08-01 其他變更

將 create_time 新增至 Audience 資源。

將 primary 新增至 ChannelGroup 資源，用於指出管道群組是否為報表的預設管道群組。任何時間點，只有一個管道群組可以將 primary 設為 true。將管道群組的 primary 設為 true 時，系統會自動將先前的預設管道群組的 primary 設為 false。

將 gmp_organization 新增至 Account 資源，如果帳戶已連結至 GMP 機構組織，這項資源就會包含 Google Marketing Platform 機構組織資源的 URI。

2024-05-06 新增按鍵事件管理方法

重要事件的資源和方法現已推出。

修改 API 整合，改用 KeyEvent 而非 ConversionEvent。ConversionEvent 已淘汰。

2023-12-15 所有 Google Analytics 資源現已支援資料存取報表。

所有 Google Analytics 資源 (包括標準版和 Google Analytics 360 客戶) 現已可使用「資料存取報表」功能的特定欄位。

詳情請參閱結構定義說明文件。

2023-12-15 將 accessDateHour 維度新增至資料存取報表架構。

accessDateHour 維度已加入資料存取報表架構。包含 Google Analytics 使用者存取 Google Analytics 報表資料的日期時間。

2023-10-05 資源的「最初點擊」、「線性」、「時間衰減」和「根據排序」歸因模式預設為跨管道以數據為準歸因。

自 2023 年 10 月中旬起，最初點擊、線性、時間衰減和根據排序歸因模式將無法搭配所有資源的 UpdateAttributionSettings 方法使用。

如果資源目前已設定為使用其中一種模式，系統會將其改為「跨管道以數據為準歸因」。您還是可以改用跨管道最終點擊或優先計入 Google Ads 最終點擊。

2023-09-01 新增 SKAdNetwork 轉換價值結構定義方法。

GetSKAdNetworkConversionValueSchema、CreateSKAdNetworkConversionValueSchema、DeleteSKAdNetworkConversionValueSchema、UpdateSKAdNetworkConversionValueSchema、ListSKAdNetworkConversionValueSchemas 方法已新增至 Admin API v1alpha。

這項功能可讓您管理 iOS 串流的 SKAdNetwork 轉換價值結構定義。

2023-09-01 新增 UpdateConversionEvent 方法。

UpdateConversionEvent 方法已新增至 Admin API v1beta。

2023-09-01 BigQueryLink.enterprise_export_enabled 欄位已重新命名為 fresh_daily_export_enabled。

BigQueryLink 資源的 enterprise_export_enabled 欄位已重新命名為 fresh_daily_export_enabled。

2023-07-14 對 properties.updateAttributionSettings、properties.getAttributionSettings 方法的破壞性變更。

自 2023 年 7 月 24 日起，Admin API v1 alpha 版將進行重大變更，這會影響 properties.getAttributionSettings 和 properties.updateAttributionSettings 方法的功能。

ReportingAttributionModel 列舉的成員會重新命名如下：

舊名稱 新名稱
CROSS_CHANNEL_DATA_DRIVEN PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN
CROSS_CHANNEL_LAST_CLICK PAID_AND_ORGANIC_CHANNELS_LAST_CLICK
CROSS_CHANNEL_FIRST_CLICK PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK
CROSS_CHANNEL_LINEAR PAID_AND_ORGANIC_CHANNELS_LINEAR
CROSS_CHANNEL_POSITION_BASED PAID_AND_ORGANIC_CHANNELS_POSITION_BASED
CROSS_CHANNEL_TIME_DECAY PAID_AND_ORGANIC_CHANNELS_TIME_DECAY
ADS_PREFERRED_LAST_CLICK GOOGLE_PAID_CHANNELS_LAST_CLICK

AdsWebConversionDataExportScope 列舉的成員會重新命名如下：

舊名稱 新名稱
CROSS_CHANNEL PAID_AND_ORGANIC_CHANNELS
ADS_PREFERRED GOOGLE_PAID_CHANNELS

2023-07-10 在 AttributionSettings 類型中新增 ads_web_conversion_data_export_scope 欄位

將 ads_web_conversion_data_export_scope 欄位新增至 AttributionSettings 類型，可使用 UpdateAttributionSettings 方法進行修改。

2023-06-05 停用「最初點擊」、「線性」、「時間衰減」和「根據排序」歸因模式。

自 2023 年 6 月起，您將無法使用 UpdateAttributionSettings 方法，透過「最初點擊」、「線性」、「時間衰減」和「根據排序」歸因模式設定 GA4 資源。自 2023 年 9 月起，所有資源都無法使用這些模式。

詳情請參閱 Google Analytics 產品公告。

GetAdSenseLink、CreateAdSenseLink、DeleteAdSenseLink、ListAdSenseLinks 方法已新增至 Admin API v1alpha。

這項功能可讓您管理 GA4 資源的 AdSense 與 Analytics 連結。

2023-05-31 新增方法來查詢已連結的 GA4 資源。

FetchConnectedGa4Property 方法已新增至 Admin API v1alpha

這項功能可在 GA4 遷移期間，取得已連結通用 Analytics 資源的 GA4 資源相關資訊。

2023-05-31 新增方法來管理事件建立規則。

新增 CreateEventCreateRule、UpdateEventCreateRule、DeleteEventCreateRule、ListEventCreateRules、GetEventCreateRule 方法至 Admin API 第 1 版 Alpha。

這項功能可用於管理事件建立規則，根據來源事件的符合條件觸發建立全新事件。

2023-05-31 新增方法來管理自訂管道群組。

在 Admin API 第 1 版 Alpha 中新增 GetChannelGroup、ListChannelGroups、CreateChannelGroup、UpdateChannelGroup 和 DeleteChannelGroup 方法。

這項功能可讓您管理網站流量來源的自訂管道群組。

建立自訂管道群組後，您可以使用 Google Analytics Data API v1 查詢這些群組。

2023-03-31 新增加強型評估設定管理方法。

properties.dataStreams.updateEnhancedMeasurementSettings、properties.dataStreams.getEnhancedMeasurementSettings 方法已新增至 Admin API v1alpha。

這項功能可讓您管理 GA4 資源的網站資料串流的加強型評估設定。

2023-03-31 新增已連結的網站代碼管理方法。

properties.createConnectedSiteTag、properties.deleteConnectedSiteTag、properties.listConnectedSiteTags 方法已新增至 Admin API 第 1 版 Alpha。

這項功能可用於管理已連結的網站代碼，並用於將流量從通用 Analytics 資源轉送至 Google Analytics 4 資源。

2023-03-31 在 Admin API v1beta 中新增帳戶和資源層級 runAccessReport 方法。

properties.runAccessReport 和 accounts.runAccessReport 方法已新增至 v1beta 版的 Admin API。方法會傳回自訂的資料存取記錄報表。

2023-02-24 新增展開資料集管理方法。

ExpandedDataSet 資源已新增至 API 的 v1alpha 版本，以及對應的 properties.expandedDataSets.create、properties.expandedDataSets.delete、properties.expandedDataSets.patch、properties.expandedDataSets.list、properties.expandedDataSets.get 作業。這項功能可用於管理 Google Analytics 360 中的展開資料集。

AccessBinding 資源已加入 API 的 v1alpha 版本，以及下列作業：

這項功能可管理 GA4 帳戶或資源的使用者權限，應取代使用者連結。

User Links 功能將於 6/1/23 從 Admin API v1 alpha 版中移除

2023-02-24 淘汰使用者權限稽核方法。

下列方法已淘汰，並將於 6/1/23 從 Admin API v1 alpha 版中移除：

2023-02-24 新增目標對象管理方法。

Audience 資源已新增至 API 的 v1alpha 版本，以及對應的 properties.audience.create、properties.audience.archive、properties.audience.patch、properties.audience.list、properties.audience.get 作業。

這項功能可讓您管理 GA4 資源的目標對象。

2023-02-15 新增自動 GA4 設定程序的拒絕方法。

properties.setAutomatedGa4ConfigurationOptOut、properties.fetchAutomatedGa4ConfigurationOptOut 作業已新增至 API 的 v1alpha 版本。

這項功能可讓您管理通用 Analytics 資源的 自動 GA4 設定程序停用狀態。

BigQueryLink 資源已新增至 v1alpha 版 API，以及對應的 properties.bigQueryLinks.get、properties.bigQueryLinks.list 作業。

這項功能可擷取 GA4 資源與 BigQuery 專案之間的連結相關資訊。

SearchAds360Link 資源已新增至 API 的 v1alpha 版本，以及對應的 properties.searchAds360Links.create、properties.searchAds360Links.delete、properties.searchAds360Links.patch、properties.searchAds360Links.list、properties.searchAds360Links.get 作業。

這項功能可讓您管理 GA4 資源與 Search Ads 360 實體之間的連結。

2023-02-15 破壞性變更。

2023-02-15 其他變更。

2022-08-11 runAccessReport 方法已新增至 Admin API 第 1 版 alpha。

properties.runAccessReport 方法已新增至 Admin API 的 v1alpha 版本。這個 API 會傳回資料存取記錄的自訂報表。這份報表會記錄使用者每次讀取 Google Analytics 報表資料的情形。資料存取報表適用於 Google Analytics 360 資源的管理員。

2022-07-11 Admin API v1beta 版發布。

Google Analytics Admin API 的 v1beta 版現已發布。

管理員 API 仍支援 API 的 Alpha 版和 Beta 版。Beta 版包含 Alpha 版提供的部分功能，這些功能已視為穩定版，且預期不會在日後大幅變動。新功能成熟後，就會加入 Beta 版。

2021 年 10 月 12 日：從 API 中移除 EnhancedMeasurementSettings 方法。

  • properties.webDataStreams.getEnhancedMeasurementSettings、properties.webDataStreams.updateEnhancedMeasurementSettings 方法已從 API 中移除，但強化評估設定很快就能再次透過 API 修改。
  • UserLink 資源的 directRoles 欄位不再支援 predefinedRoles/manage-users 角色。請改用新的 predefinedRoles/admin 角色，這相當於舊版 predefinedRoles/edit 和 predefinedRoles/manage-users 角色的組合。這項變更會影響 accounts.userLinks 和 properties.userLinks 方法的行為，並與 Google Analytics 中推出的存取權和資料限制管理異動保持一致。

2021-06-05 新增功能。

下列功能已新增至 API：

2021-06-05 破壞性變更。

以下為重大變更：

  • properties.iosAppDataStreams.create、properties.androidAppDataStreams.create 方法已從 API 中移除。請使用 Firebase 在 Google Analytics 4 資源中建立應用程式串流。
  • properties.delete 方法現在會以 Property 類型傳回已刪除的資源資料，而非傳回空白回應。
  • Property 類型的 time_zone 欄位現在為必填欄位。
  • 已從 Property 類型中移除 deleted 欄位。
  • UserLink 類型的 email_address 欄位現在無法變更。
  • UserLink 類型的 name 欄位現在僅供輸出。

2021-01-28 破壞性變更。

重大變更： - 所有更新作業都需要 update_mask 欄位。

  • country_code 欄位已在 Account 中重新命名為 region_code。

  • url_query_parameter 欄位已在 EnhancedMeasurementSettings 中重新命名為 uri_query_parameter。

  • 已從 GoogleAdsLink 中移除 parent 欄位。

2020 年 10 月 20 日：新增帳戶摘要支援功能。

新增帳戶摘要方法支援。

2020 年 10 月 13 日：應用程式 + 網站資源已更名為 Google Analytics 4 (GA4)。

2020 年 8 月 15 日 管理應用程式 + Web API 已改名為 Admin API。

Google Analytics 管理應用程式 + 網站 API 已更名為 Google Analytics Admin API。因此，API 端點已變更為 analyticsadmin.googleapis.com。針對舊版 API 端點網址和用戶端程式庫編寫的現有程式碼，需要據此更新。