Method: properties.getMetadata

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

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

คำขอ HTTP

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

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

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

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

string

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

เช่น พร็อพเพอร์ตี้/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

DimensionMetadata

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

การแสดง JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
ช่อง
apiName

string

ชื่อของมิติข้อมูลนี้ ใช้ได้ใน name ของมิติข้อมูล เช่น eventName
uiName

string

ชื่อของมิติข้อมูลนี้ภายในอินเทอร์เฟซผู้ใช้ Google Analytics เช่น Event name
description

string

คำอธิบายเกี่ยวกับวิธีใช้และคำนวณมิติข้อมูลนี้
deprecatedApiNames[]

string

ชื่อมิติข้อมูลนี้ยังใช้ได้อยู่แต่เลิกใช้งานไปแล้ว หากมีการป้อนข้อมูล มิติข้อมูลนี้จะพร้อมใช้งานตาม apiName หรือ deprecatedApiNames เป็นระยะเวลาหนึ่ง หลังระยะเวลาการเลิกใช้งาน มิติข้อมูลจะพร้อมใช้งานภายในวันที่ apiName เท่านั้น
customDefinition

boolean

เป็นจริงหากมิติข้อมูลเป็นมิติข้อมูลที่กําหนดเองสําหรับพร็อพเพอร์ตี้นี้

MetricMetadata

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

การแสดง JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
ช่อง
apiName

string

ชื่อเมตริก ใช้ได้ใน name ของเมตริก เช่น eventCount
uiName

string

ชื่อของเมตริกนี้ภายในอินเทอร์เฟซผู้ใช้ Google Analytics เช่น Event count
description

string

คำอธิบายวิธีการใช้และคำนวณเมตริกนี้
deprecatedApiNames[]

string

ชื่อเมตริกนี้ยังใช้ได้อยู่แต่เลิกใช้งานแล้ว หากมีการป้อนข้อมูล เมตริกนี้จะพร้อมใช้งานตาม apiName หรือ deprecatedApiNames เป็นระยะเวลาหนึ่ง หลังจากระยะเวลาการเลิกใช้งาน เมตริกจะใช้ได้ภายในวันที่ apiName เท่านั้น
type

enum (MetricType)

ประเภทของเมตริกนี้
expression

string

นิพจน์ทางคณิตศาสตร์สำหรับเมตริกที่ได้มานี้ ใช้ในช่อง expression ของเมตริกสำหรับรายงานที่เทียบเท่า เมตริกส่วนใหญ่ไม่ใช่นิพจน์ และสําหรับสิ่งที่ไม่ใช่นิพจน์ ฟิลด์นี้จะว่างเปล่า
customDefinition

boolean

เป็นจริงหากเมตริกเป็นเมตริกที่กําหนดเองสําหรับพร็อพเพอร์ตี้นี้