การอ้างอิง Measurement Protocol

ภาพรวม

การส่งข้อมูลไปยัง Google Analytics โดยใช้การวัดมี 2 ส่วน โปรโตคอล:

  1. การขนส่ง - ตำแหน่งและวิธีการส่งข้อมูล
  2. เพย์โหลด - ข้อมูลที่คุณส่ง

เอกสารนี้อธิบายวิธีจัดรูปแบบการรับส่งข้อมูลและเพย์โหลด

การขนส่ง

ปลายทางของ URL

คุณจะส่งข้อมูลโดยใช้ Measurement Protocol โดยส่งคำขอ HTTP POST ไปยัง ปลายทางต่อไปนี้

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>

โค้ดตอบกลับ

Measurement Protocol จะแสดงรหัสสถานะ 2xx เสมอหาก HTTP ได้รับคำขอแล้ว Measurement Protocol จะไม่แสดงผลรหัสข้อผิดพลาด หาก ข้อมูลเพย์โหลดผิดรูปแบบ หรือข้อมูลในเพย์โหลดไม่ถูกต้องหรือ ไม่ได้ประมวลผลโดย Google Analytics

เพย์โหลด

ข้อมูลจะถูกส่งไปยัง Google Analytics โดยใช้ข้อมูล Measurement Protocol ในส่วน ชิ้นส่วน:

  1. พารามิเตอร์การค้นหา
  2. เนื้อความ JSON POST

พารามิเตอร์การค้นหา

ชื่อพารามิเตอร์ คำอธิบาย

api_secret

ต้องระบุ API Secret ที่สร้างขึ้นโดยใช้ UI ของ Google Analytics

หากต้องการสร้างข้อมูลลับใหม่ ให้ไปที่ UI ของ Google Analytics เพื่อดําเนินการต่อไปนี้
ผู้ดูแลระบบ > สตรีมข้อมูล > เลือกสตรีมของคุณ Measurement Protocol > สร้าง

เราขอแนะนำให้ตั้งค่าข้อมูลเหล่านี้เป็นแบบส่วนตัวเฉพาะในองค์กร ถ้า ที่คุณติดตั้งใช้งานฝั่งไคลเอ็นต์ของ Measurement Protocol คุณควร หมุนเวียน api_secret เป็นประจำเพื่อหลีกเลี่ยงสแปมมากเกินไป

measurement_id

 รหัสการวัด ตัวระบุสำหรับสตรีมข้อมูล พบใน Google UI ของ Analytics ภายใต้
ผู้ดูแลระบบ > สตรีมข้อมูล > เลือกสตรีมของคุณ รหัสการวัด

เนื้อหาของโพสต์ JSON

คีย์ ประเภท คำอธิบาย

client_id

 string

ต้องระบุ ระบุอินสแตนซ์ของผู้ใช้ของเว็บไคลเอ็นต์โดยไม่ซ้ำกัน ดูการส่งเหตุการณ์ไปที่ Measurement Protocol

user_id

 string

ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับผู้ใช้ โปรดดู User-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_