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