本頁說明 Measurement Protocol 的傳輸機制和資料參數。
運輸
所有資料都必須透過 HTTPS POST 要求安全傳送。
將要求傳送至下列端點:
https://www.google-analytics.com/mp/collect
如要在歐盟境內處理資料,請改用下列端點:
https://region1.google-analytics.com/mp/collect
以下是 POST 要求範例:
POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA
如果收到 HTTP 要求,Measurement Protocol 會傳回 2xx 狀態碼。如果酬載格式錯誤,或資料不正確或未經 Google Analytics 處理,Measurement Protocol 就不會傳回錯誤代碼。
酬載
酬載包含兩個部分:
- 查詢參數。
- JSON
POST內文。
查詢參數
| 參數名稱 | 說明 |
|---|---|
|
必填。Google Analytics 使用者介面中的 API 密鑰。
依序前往「管理」 >「資料串流」 >「選擇所需串流」 >「Measurement Protocol」 >「建立」。 貴機構專屬。應定期更新,以免垃圾內容過多。 |
JSON POST 內文
| 鍵 | 類型 | 說明 |
|---|---|---|
|
string |
(選用) 使用者的專屬 ID,如要進一步瞭解這個 ID,請參閱「跨平台分析的 User-ID」。只能包含 UTF-8 字元。 |
|
number |
(選用) Unix 時間戳記,以微秒為單位,而非毫秒。代表活動時間。只能設為記錄過去發生的事件。可由 |
|
object |
(選用) 用於評估的使用者屬性。 |
|
object |
(選用) 使用者提供的資料。 |
|
object |
(選用) 要求的同意聲明設定。詳情請參閱同意聲明部分。 |
|
boolean |
選填。設為 true,表示不應將使用者的資料用於個人化廣告。 |
|
object |
(選用) 以結構化格式為要求設定地理資訊。 |
|
string |
(選用) Google Analytics 用來推導要求地理區域資訊的 IP 位址。 |
|
object |
(選用步驟) 以結構化格式為要求設定裝置資訊。 |
|
array |
必填。event 個項目的陣列。每個要求最多可傳送 25 個事件。如要查看所有有效事件,請參閱事件參考資料。 |
|
string |
必填。活動名稱。如要瞭解所有選項,請參閱「事件」。 |
|
object |
(選用) 事件的參數。請參閱「事件」 一文,瞭解各事件的建議參數,以及「常見事件參數」。 |
常見事件參數
Measurement Protocol 具有下列常見的事件參數:
| 鍵 | 類型 | 說明 |
|---|---|---|
|
number |
用來識別使用者工作階段的正數。這是常見用途的必要條件。必須符合規則運算式 ^\d+$。
|
|
number |
事件的使用者參與時間長度 (以毫秒為單位)。使用的值應反映自前一個事件以來的使用者參與時間量。 |
|
number |
事件的 Unix 紀元時間 (以微秒表示)。使用這個參數覆寫事件的時間戳記。 |
同意聲明
consent 屬性會設定同意聲明類型和狀態。
如果您未指定 consent,Google Analytics 會使用用戶端或應用程式執行個體相應線上互動的同意聲明設定。
| 鍵 | 類型 | 說明 |
|---|---|---|
|
string |
(選用) 同意聲明狀態,指明可否基於廣告用途,將要求事件和使用者屬性中的使用者資料傳送給 Google。
|
|
string |
(選用) 使用者是否同意放送個人化廣告。
|
地理位置資訊
user_location 和 ip_override 屬性會提供地理資訊。user_location 的優先順序高於 ip_override。
以下是 user_location 欄位的結構。請盡可能提供多一點屬性。建議至少使用 country_id 和 region_id。
| 鍵 | 類型 | 說明 |
|---|---|---|
|
string |
(選用) 城市名稱。如果城市位於美國,請一併設定 country_id 和 region_id,讓 Google Analytics 正確將城市名稱對應至城市 ID。
|
|
string |
(選用) ISO 3166 國家/地區和子區域。例如:US-CA、US-AR、CA-BC、GB-LND、CN-HK。 |
|
string |
(選用) 採 ISO 3166-1 alpha-2 格式的國家/地區。例如:US、AU、ES、FR。 |
|
string |
(選用) UN M49 格式的子洲別。例如:011、021、030、039。 |
|
string |
(選用) UN M49 格式的大陸。例如:002、019、142、150。 |
以下是 user_location 的範例:
"user_location": {
"city": "Mountain View",
"region_id": "US-CA",
"country_id": "US",
"subcontinent_id": "021",
"continent_id": "019"
}
ip_override 是 user_location 的替代方案。如果您改為傳送 ip_override,Google Analytics 會從 IP 位址取得地理資訊。如果您傳送 user_location,Google Analytics 會忽略 ip_override。
如果未傳送 user_location 或 ip_override,Google Analytics 會使用
client_id。
無論傳送的地理資訊為何,Google Analytics 都會將資源的精細位置資料設定套用至要求。
裝置資訊
如要傳送裝置資訊,請使用 device 欄位。以下是 device 欄位的結構。請盡可能多提供屬性。建議至少 category。
| 鍵 | 類型 | 說明 |
|---|---|---|
|
string |
選填。裝置類別。例如:
desktop、
tablet、
mobile、
smart TV。
|
|
string |
選填。語言,採 ISO 639-1 格式。例如:en、en-US。 |
|
string |
選填。裝置的解析度,格式為 WIDTHxHEIGHT。例如:1280x2856、1080x2340。 |
|
string |
選填。作業系統或平台。例如:
MacOS。
|
|
string |
選填。作業系統或平台版本。例如:13.5。 |
|
string |
選填。裝置型號。例如:Pixel 9 Pro、Samsung Galaxy S24。 |
|
string |
選填。裝置品牌。例如:Google、Samsung。 |
|
string |
選填。瀏覽器的品牌或類型。例如:Chrome、Firefox。 |
|
string |
選填。瀏覽器版本。例如:136.0.7103.60、5.0。 |
以下程式碼片段顯示 device 設定範例:
"device": {
"category": "mobile",
"language": "en",
"screen_resolution": "1280x2856",
"operating_system": "Android",
"operating_system_version": "14",
"model": "Pixel 9 Pro",
"brand": "Google",
"browser": "Chrome",
"browser_version": "136.0.7103.60"
}
無論您指定 Google Analytics 都會將資源的精細裝置資料設定套用至要求。
自訂參數
您可以在 Measurement Protocol 酬載中加入以使用者、事件和商品為範圍的自訂參數。
- 以使用者為範圍的自訂參數可納入
user_properties。 - 以事件為範圍的自訂參數可納入
events[].params。 - 以商品為範圍的自訂參數可納入
items。
特定事件的建議值
部分事件有建議參數。如要查看所有支援事件的建議參數,請參閱「事件」。
保留名稱
部分事件、參數和使用者屬性名稱為保留名稱,無法使用:
預留事件名稱
以下是保留的事件名稱,無法使用:
ad_activeviewad_clickad_exposuread_queryad_rewardadunit_exposureapp_clear_dataapp_exceptionapp_installapp_removeapp_store_refundapp_updateapp_upgradedynamic_link_app_opendynamic_link_app_updatedynamic_link_first_openerrorfirebase_campaignfirebase_in_app_message_actionfirebase_in_app_message_dismissfirebase_in_app_message_impressionfirst_openfirst_visitin_app_purchasenotification_dismissnotification_foregroundnotification_opennotification_receivenotification_sendos_updatesession_startuser_engagement
保留參數名稱
以下是保留的參數名稱,無法使用:
firebase_conversion
參數名稱開頭不得為下列字元:
_ (underscore)firebase_ga_google_gtag.
預留使用者屬性名稱
以下是保留的使用者屬性名稱,無法使用:
first_open_timefirst_visit_timelast_deep_link_referreruser_idfirst_open_after_install
此外,使用者屬性名稱的開頭不得為:
_ (underscore)firebase_ga_google_