- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ComparisonMetadata
- ลองใช้งาน
แสดงข้อมูลเมตาสำหรับมิติข้อมูลและเมตริกที่มีอยู่ในวิธีการรายงาน ใช้เพื่อสำรวจมิติข้อมูลและเมตริก วิธีนี้มีการระบุตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ในคำขอ และการตอบกลับข้อมูลเมตาจะมีมิติข้อมูลและเมตริกที่กําหนดเอง รวมถึงข้อมูลเมตาสากล
ตัวอย่างเช่น หากมีการบันทึกเมตริกที่กำหนดเองที่มีชื่อพารามิเตอร์ levels_unlocked
กับพร็อพเพอร์ตี้ การตอบกลับของข้อมูลเมตาจะมี customEvent:levels_unlocked
ข้อมูลเมตาสากลคือมิติข้อมูลและเมตริกที่ใช้กับพร็อพเพอร์ตี้ต่างๆ เช่น country
และ totalUsers
คำขอ HTTP
GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของข้อมูลเมตาที่จะดึงข้อมูล ช่องชื่อนี้ระบุไว้ในเส้นทาง URL ไม่ใช่พารามิเตอร์ของ URL พร็อพเพอร์ตี้คือตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ที่เป็นตัวเลข ดูข้อมูลเพิ่มเติมได้ในวิธีค้นหารหัสพร็อพเพอร์ตี้ เช่น พร็อพเพอร์ตี้/1234/ข้อมูลเมตา ตั้งรหัสพร็อพเพอร์ตี้เป็น 0 สําหรับมิติข้อมูลและเมตริกที่มีอยู่ในพร็อพเพอร์ตี้ทั้งหมด ในโหมดพิเศษนี้ วิธีนี้จะไม่แสดงมิติข้อมูลและเมตริกที่กำหนดเอง |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
มิติข้อมูล เมตริก และการเปรียบเทียบที่ยอมรับในวิธีการรายงานในปัจจุบัน
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{ "name": string, "dimensions": [ { object ( |
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของข้อมูลเมตานี้ |
dimensions[] |
คำอธิบายมิติข้อมูล |
metrics[] |
คำอธิบายเมตริก |
comparisons[] |
คำอธิบายการเปรียบเทียบ |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
ComparisonMetadata
ข้อมูลเมตาสำหรับการเปรียบเทียบ 1 รายการ
การแสดง JSON |
---|
{ "apiName": string, "uiName": string, "description": string } |
ช่อง | |
---|---|
apiName |
ชื่อทรัพยากรของการเปรียบเทียบนี้ ใช้ในช่อง |
uiName |
ชื่อของการเปรียบเทียบนี้ภายในอินเทอร์เฟซผู้ใช้ Google Analytics |
description |
คำอธิบายของการเปรียบเทียบนี้ |