Method: properties.getMetadata

แสดงข้อมูลเมตาสำหรับมิติข้อมูลและเมตริกที่ใช้ได้ในวิธีการรายงาน ใช้ในการสำรวจมิติข้อมูลและเมตริก ในวิธีนี้ จะมีการระบุตัวระบุพร็อพเพอร์ตี้ GA4 ของ Google Analytics ในคำขอ และการตอบกลับของข้อมูลเมตาจะมีมิติข้อมูลและเมตริกที่กําหนดเอง รวมถึงข้อมูลเมตาสากล

เช่น หากมีการบันทึกเมตริกที่กำหนดเองที่มีชื่อพารามิเตอร์ levels_unlocked กับพร็อพเพอร์ตี้ การตอบกลับของข้อมูลเมตาจะมี customEvent:levels_unlocked ข้อมูลเมตาสากลคือมิติข้อมูลและเมตริกที่ใช้ได้กับพร็อพเพอร์ตี้ใดก็ได้ เช่น country และ totalUsers

คำขอ HTTP

GET https://analyticsdata.googleapis.com/v1beta/{name=properties/*/metadata}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ต้องระบุ ชื่อทรัพยากรของข้อมูลเมตาที่จะดึงข้อมูล มีการระบุช่องชื่อนี้ในเส้นทาง URL ไม่ใช่พารามิเตอร์ URL พร็อพเพอร์ตี้คือตัวระบุพร็อพเพอร์ตี้ GA4 ที่เป็นตัวเลข ดูข้อมูลเพิ่มเติมได้ที่วิธีค้นหารหัสพร็อพเพอร์ตี้

ตัวอย่าง: property/1234/metadata

ตั้งค่ารหัสพร็อพเพอร์ตี้เป็น 0 สำหรับมิติข้อมูลและเมตริกที่ใช้ได้กับพร็อพเพอร์ตี้ทั้งหมด ในโหมดพิเศษนี้ เมธอดจะไม่แสดงมิติข้อมูลและเมตริกที่กำหนดเอง

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

มิติข้อมูล เมตริก และการเปรียบเทียบที่ยอมรับในวิธีการรายงานในปัจจุบัน

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
ช่อง
name

string

ชื่อทรัพยากรของข้อมูลเมตานี้

dimensions[]

object (DimensionMetadata)

คำอธิบายมิติข้อมูล

metrics[]

object (MetricMetadata)

คำอธิบายเมตริก

ขอบเขตการให้สิทธิ์

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics