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 Transcoding

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

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

string

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

เช่น พร็อพเพอร์ตี้/1234/ข้อมูลเมตา

ตั้งค่ารหัสพร็อพเพอร์ตี้เป็น 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