Measurement Protocol 參考資料

總覽

使用評估功能將資料傳送至 Google Analytics 的步驟分為兩個部分 通訊協定：

  1. 傳輸方式 - 傳送資料的位置和方式
  2. 酬載 - 您傳送的資料

本文件說明傳輸和酬載的格式。

運輸

網址端點

您會使用 Measurement Protocol 傳送資料，方法是向 以下端點：

https://www.google-analytics.com/mp/collect

如要傳送事件，請發出下列 POST 要求：

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
<payload_data>

  • 要求的 BODY。請參閱酬載。

回應碼

如果 HTTP，Measurement Protocol 一律會傳回 2xx 狀態碼 的顯示時間。如果出現錯誤，Measurement Protocol 不會傳回錯誤代碼 酬載資料格式錯誤，或如果酬載中的資料不正確， 則未由 Google Analytics 處理。

酬載

系統會使用兩個 Measurement Protocol 資料，將資料傳送至 Google Analytics 部分：

  1. 查詢參數
  2. JSON POST 主體

查詢參數

參數名稱 說明

api_secret

必要。透過以下方式產生的 API Secret： Google Analytics 使用者介面

如要建立新的密鑰，請在 Google Analytics 使用者介面中進行以下操作：
管理 >資料串流 >選擇直播 &gt;Measurement Protocol >建立

建議你只讓貴機構的使用者存取這些資訊。如果 您在用戶端部署 Measurement Protocol 的 定期旋轉 api_secret，避免過多的垃圾內容。

JSON 貼文內文

鍵 類型 說明

user_id

 string

選用設定。使用者的專屬 ID。請參閱「User-ID 類型： 進一步瞭解這個 ID。

timestamp_micros

 number

選用設定。關聯時間的 Unix 時間戳記 (以微秒為單位) 與活動一起顯示。這個模式應設為記錄發生的事件， 例如使用者過去是否曾在相同的裝置上 或在類似的地點登入這個值可以透過下列方式覆寫： user_property 或事件時間戳記。事件可回溯 最多 3 天 (以房源的時區為準)。

user_properties

 object 選用設定。測量的使用者屬性。請參閱使用者 資源。
object 選用設定。為請求設定同意聲明設定。詳情請參閱同意聲明一節。

non_personalized_ads

 boolean 選用設定。設為 true，表示使用者資料不應 用於個人化廣告

events[]

 array 必要。事件項目的陣列。每種事件最多可以傳送 25 個事件 請求。查看事件 。

events[].name

 string 必要。事件的名稱。查看事件 所有選項的參考資料。

events[].params

 object 選用設定。事件的參數。查看事件 。

consent 屬性會設定同意聲明類型和狀態。 如果未指定 consent，Google Analytics 會使用同意聲明 設定用戶端或應用程式執行個體相對應的線上互動設定。

鍵 類型 說明

ad_user_data

 string

選用。設定同意聲明，允許從請求的 事件和使用者屬性傳送給 Google。

必須是 GRANTED 或 DENIED。

ad_personalization

 string

選用。設定使用者同意聲明，指明可否放送個人化廣告。

必須是 GRANTED 或 DENIED。

自訂參數

除了規定的參數外，您還可以加入 自訂以使用者為範圍、以事件為範圍和以商品為範圍 參數 位於 Measurement Protocol 酬載中

  • 使用者範圍的自訂參數可加入酬載的 user_properties 物件中。
  • 事件範圍的自訂參數可納入 events[].params 中 酬載物件
  • 以商品為範圍的自訂參數可加到 items 陣列 。

部分事件有建議參數。如要查看建議做法，請參閱事件 參數。

保留名稱

預留事件名稱

以下是保留的事件名稱，無法使用：

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

保留參數名稱

以下是保留的參數名稱，無法使用：

  • firebase_conversion

此外，參數名稱的開頭不得為：

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

預留使用者屬性名稱

以下是保留的使用者屬性名稱，無法使用：

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

此外，使用者屬性名稱的開頭不得為：

  • _ (underscore)
  • firebase_
  • ga_
  • google_