Tham chiếu Measurement Protocol

Tổng quan

Có hai phần để gửi dữ liệu đến Google Analytics bằng phương pháp Đo lường Giao thức:

  1. Phương tiện vận chuyển – địa điểm và cách thức bạn gửi dữ liệu
  2. Tải trọng – dữ liệu mà bạn gửi

Tài liệu này mô tả cách định dạng phương thức vận chuyển và tải trọng.

Giao thông vận tải

Điểm cuối URL

Bạn gửi dữ liệu thông qua Measurement Protocol bằng cách thực hiện các yêu cầu POST qua HTTP đến điểm cuối sau:

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

Để gửi một sự kiện, hãy đưa ra yêu cầu POST sau:

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

Mã phản hồi

Measurement Protocol luôn trả về mã trạng thái 2xx nếu HTTP đã nhận được yêu cầu. Measurement Protocol không trả về mã lỗi nếu dữ liệu tải trọng không đúng định dạng hoặc dữ liệu trong tải trọng không chính xác hoặc không được Google Analytics xử lý.

Dung lượng

Dữ liệu được gửi đến Google Analytics bằng Dữ liệu Measurement Protocol trong hai phần:

  1. Tham số truy vấn
  2. Nội dung JSON POST

tham số truy vấn

Tên thông số Mô tả

api_secret

Bắt buộc. API Secret được tạo qua giao diện người dùng Google Analytics.

Để tạo khoá bí mật mới, hãy điều hướng trong giao diện người dùng Google Analytics để:
Quản trị > Luồng dữ liệu > chọn sự kiện phát trực tiếp &gt; Measurement Protocol > Tạo

Bạn nên giữ những thông tin này ở chế độ riêng tư với tổ chức của mình. Nếu khi triển khai Measurement Protocol ở phía máy khách, bạn nên thường xuyên xoay api_secret để tránh SPAM quá mức.

measurement_id

 Mã đo lường. Giá trị nhận dạng của một Luồng dữ liệu. Tìm thấy trong Google Giao diện người dùng Analytics trong:
Quản trị > Luồng dữ liệu > chọn sự kiện phát trực tiếp &gt; Mã đo lường

Nội dung của bài đăng JSON

Khoá Loại Mô tả

client_id

 string

Bắt buộc. Xác định duy nhất một phiên bản người dùng của ứng dụng web. Xem phần gửi sự kiện đến Measurement Protocol.

user_id

 string

Không bắt buộc. Giá trị nhận dạng duy nhất của người dùng. Xem bài viết User-ID cho bản phân tích trên nhiều nền tảng để biết thêm thông tin về giá trị nhận dạng này.

timestamp_micros

 number

Không bắt buộc. Dấu thời gian Unix (tính bằng micrô giây) cho thời gian liên kết với sự kiện. Bạn chỉ nên đặt chế độ này để ghi lại những sự kiện đã xảy ra trong quá khứ. Bạn có thể ghi đè giá trị này thông qua user_property hoặc dấu thời gian của sự kiện. Các sự kiện có thể lùi ngày tối đa 3 ngày theo lịch dựa trên múi giờ của thuộc tính.

user_properties

 object Không bắt buộc. Thuộc tính người dùng cho hoạt động đo lường. Xem phần Người dùng thuộc tính để biết thêm thông tin.
object Không bắt buộc. Đặt chế độ cài đặt về sự đồng ý cho yêu cầu. Hãy xem mục đồng ý để biết thêm thông tin.

non_personalized_ads

 boolean Không bắt buộc. Đặt thành true để cho biết rằng dữ liệu người dùng không nên để cá nhân hoá quảng cáo.

events[]

 array Bắt buộc. Một mảng các mục sự kiện. Có thể gửi tối đa 25 sự kiện mỗi của bạn. Xem sự kiện cho tất cả các sự kiện hợp lệ.

events[].name

 string Bắt buộc. Tên của sự kiện. Xem sự kiện tham khảo cho tất cả các lựa chọn.

events[].params

 object Không bắt buộc. Các thông số cho sự kiện. Xem sự kiện cho các thông số được đề xuất cho từng sự kiện.

Thuộc tính consent định cấu hình loại và trạng thái đồng ý. Nếu bạn không chỉ định consent, thì Google Analytics sẽ sử dụng trạng thái đồng ý chế độ cài đặt của các lượt tương tác trực tuyến tương ứng đối với ứng dụng hoặc phiên bản ứng dụng.

Khoá Loại Mô tả

ad_user_data

 string

Không bắt buộc. Đặt trạng thái đồng ý đối với việc gửi dữ liệu người dùng từ sự kiện và thuộc tính người dùng đến Google cho mục đích quảng cáo.

Phải là GRANTED hoặc DENIED.

ad_personalization

 string

Không bắt buộc. Đặt trạng thái đồng ý đối với quảng cáo được cá nhân hoá cho người dùng.

Phải là GRANTED hoặc DENIED.

Thông số tùy chỉnh

Ngoài các thông số quy định, bạn có thể thêm ở phạm vi người dùng tuỳ chỉnh, ở phạm vi sự kiện và ở phạm vi mặt hàng tham số bên trong tải trọng Measurement Protocol.

  • Thông số tuỳ chỉnh ở phạm vi người dùng có thể được đưa vào đối tượng user_properties của tải trọng.
  • Bạn có thể thêm thông số tuỳ chỉnh ở phạm vi sự kiện vào events[].params đối tượng của tải trọng.
  • Bạn có thể thêm thông số tuỳ chỉnh ở phạm vi mặt hàng vào Mảng items cho từng sự kiện.

Một số sự kiện có các thông số được đề xuất. Xem sự kiện để biết các sự kiện được đề xuất cho tất cả sự kiện được hỗ trợ.

Tên dành riêng

Tên sự kiện chuyên dụng

Những tên sự kiện sau đây đã được dành riêng và không thể sử dụng:

  • 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

Tên dành riêng cho thông số

Những tên thông số sau đây đã được dành riêng và không thể sử dụng:

  • firebase_conversion

Ngoài ra, tên thông số không được bắt đầu bằng:

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

Tên thuộc tính người dùng chuyên dụng

Những tên thuộc tính người dùng sau đây đã được dành riêng và không thể sử dụng:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Ngoài ra, tên thuộc tính người dùng không được bắt đầu bằng:

  • _ (underscore)
  • firebase_
  • ga_
  • google_