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

ภาพรวม

การส่งข้อมูลไปยัง Google Analytics โดยใช้ Measurement Protocol แบ่งออกเป็น 2 ส่วนดังนี้

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

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

การขนส่ง

ปลายทางของ URL

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

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

หมายเหตุ: ข้อมูลทั้งหมดต้องส่งผ่าน HTTPS อย่างปลอดภัย

หากต้องการส่งเหตุการณ์ ให้ส่งคําขอ POST ต่อไปนี้

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

• BODY ของคำขอ ดูเพย์โหลด

โค้ดตอบกลับ

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

สำคัญ: หากไม่ได้รับรหัสสถานะ 2xx คุณไม่ควรส่งคำขออีกครั้ง แต่คุณควรหยุดและแก้ไขข้อผิดพลาดในคําขอ HTTP

เพย์โหลด

Firebase gtag.js

ระบบจะส่งข้อมูลไปยัง Google Analytics โดยใช้ข้อมูล Measurement Protocol 2 ส่วนดังนี้

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

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

ชื่อพารามิเตอร์	คำอธิบาย
api_secret	ต้องระบุ API Secret ที่สร้างขึ้นผ่าน UI ของ Google Analytics หากต้องการสร้างข้อมูลลับใหม่ ให้ไปที่ UI ของ Google Analytics เพื่อดําเนินการต่อไปนี้ ผู้ดูแลระบบ > สตรีมข้อมูล > เลือกสตรีม > Measurement Protocol > สร้าง เราขอแนะนำให้คุณเก็บข้อมูลเหล่านี้ไว้ภายในองค์กร หากคุณติดตั้งใช้งาน Measurement Protocol ฝั่งไคลเอ็นต์ คุณควรหมุนเวียน api_secret เป็นประจําเพื่อหลีกเลี่ยงสแปมมากเกินไป

เนื้อความของโพสต์ JSON

คีย์	ประเภท	คำอธิบาย
user_id	string	ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับผู้ใช้ ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวระบุนี้ได้ที่User-ID สําหรับการวิเคราะห์ข้ามแพลตฟอร์ม user_id ต้องมีอักขระ utf-8 เท่านั้น
timestamp_micros	number	ไม่บังคับ การประทับเวลา Unix (เป็นไมโครวินาที) สำหรับเวลาที่จะเชื่อมโยงกับเหตุการณ์ ควรตั้งค่านี้เพื่อบันทึกเหตุการณ์ที่เกิดขึ้นในอดีตเท่านั้น ค่านี้สามารถลบล้างได้ผ่าน user_property หรือการประทับเวลาของเหตุการณ์ คุณสามารถย้อนเวลาเหตุการณ์ได้สูงสุด 3 วันตามปฏิทินโดยอิงตามเขตเวลาของที่พัก ค่านี้ควรเป็นไมโครวินาที ไม่ใช่มิลลิวินาที
user_properties	object	ไม่บังคับ พร็อพเพอร์ตี้ผู้ใช้สําหรับการวัด ดูข้อมูลเพิ่มเติมได้ที่พร็อพเพอร์ตี้ผู้ใช้
user_data	object	ไม่บังคับ ข้อมูลที่ได้จากผู้ใช้ ดูข้อมูลเพิ่มเติมได้ที่คู่มือเกี่ยวกับข้อมูลที่ได้จากผู้ใช้
consent	object	ไม่บังคับ ตั้งค่าความยินยอมสําหรับคําขอ ดูข้อมูลเพิ่มเติมได้ที่ส่วนความยินยอม
non_personalized_ads	boolean	ไม่บังคับ ตั้งค่าเป็น true เพื่อระบุว่าไม่ควรใช้ข้อมูลของผู้ใช้สําหรับโฆษณาที่ปรับตามโปรไฟล์ของผู้ใช้ เลิกใช้งานแล้ว: ใช้ฟิลด์ ad_personalization ของ consent แทนฟิลด์นี้ Google Analytics ยอมรับทั้ง 2 ฟิลด์ แต่เราขอแนะนําให้ใช้ ad_personalization
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 arrayสำหรับแต่ละเหตุการณ์

ค่าที่แนะนำสำหรับเหตุการณ์บางอย่าง

บางเหตุการณ์มีพารามิเตอร์ที่แนะนํา ดูพารามิเตอร์ที่แนะนําสําหรับเหตุการณ์ที่รองรับทั้งหมดได้ที่เหตุการณ์

ชื่อที่สงวนไว้

ชื่อเหตุการณ์ที่สงวนไว้

ชื่อเหตุการณ์ต่อไปนี้เป็นชื่อที่สงวนไว้และไม่สามารถใช้ได้

• 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_