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

ภาพรวม

การส่งข้อมูลไปยัง Google Analytics โดยใช้โปรโตคอลการวัดมี 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 เป็นประจำเพื่อหลีกเลี่ยงสแปมมากเกินไป
firebase_app_id	จำเป็น รหัสแอป Firebase ตัวระบุสำหรับแอป Firebase พบในคอนโซล Firebase ในส่วน การตั้งค่าโปรเจ็กต์ > ทั่วไป > แอปของคุณ > รหัสแอป
measurement_id	รหัสการวัด ตัวระบุสําหรับสตรีมข้อมูล อยู่ใน UI ของ Google Analytics ในส่วน ผู้ดูแลระบบ > สตรีมข้อมูล > เลือกสตรีม > รหัสการวัด

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

คีย์	ประเภท	คำอธิบาย
app_instance_id	string	จำเป็น ระบุการติดตั้งแอป Firebase อย่างเจาะจง ค่านี้ต้องเรียกผ่าน Firebase SDK Android - getAppInstanceId() Kotlin - getAppInstanceId() Swift - appInstanceID() Objective-C - appInstanceID C++ - GetAnalyticsInstanceId() Unity - GetAnalyticsInstanceIdAsync() แอปนี้แตกต่างจากเว็บ client_id
client_id	string	จำเป็น ระบุอินสแตนซ์ของผู้ใช้ของเว็บไคลเอ็นต์โดยไม่ซ้ำกัน ดูส่งเหตุการณ์ไปยัง Measurement Protocol
user_id	string	ไม่บังคับ ตัวระบุที่ไม่ซ้ำกันสำหรับผู้ใช้ ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวระบุนี้ได้ที่รหัสผู้ใช้สำหรับการวิเคราะห์ข้ามแพลตฟอร์ม user_id มีได้เฉพาะอักขระ utf-8
timestamp_micros	number	ไม่บังคับ การประทับเวลา Unix (เป็นไมโครวินาที) สำหรับเวลาที่จะเชื่อมโยงกับเหตุการณ์ ซึ่งควรตั้งค่าให้บันทึกเหตุการณ์ที่เกิดขึ้นในอดีตเท่านั้น คุณลบล้างค่านี้ได้ผ่าน user_property หรือการประทับเวลาของเหตุการณ์ คุณย้อนข้อมูลกิจกรรมได้สูงสุด 3 วันตามปฏิทินตามเขตเวลาของที่พัก ค่านี้ควรเป็นไมโครวินาที ไม่ใช่ มิลลิวินาทีวินาที
user_properties	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 ของแต่ละเหตุการณ์ได้

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

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

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

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

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

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