Method: properties.getMetadata

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

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

คำขอ HTTP

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

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

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

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

string

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

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

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

เนื้อความของคำขอ

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

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

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

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

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

string

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

object (DimensionMetadata)

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

object (MetricMetadata)

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

object (ComparisonMetadata)

คำอธิบายการเปรียบเทียบ
conversions[]

object (ConversionMetadata)

คำอธิบาย Conversion

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

ต้องใช้ขอบเขต 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
ช่อง
apiName

string

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

string

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

string

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

string

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

boolean

จริง หากมิติข้อมูลเป็นมิติข้อมูลที่กำหนดเองของพร็อพเพอร์ตี้นี้ ซึ่งรวมถึงมิติข้อมูลที่กำหนดเองระดับผู้ใช้ เหตุการณ์ และสินค้า ดูข้อมูลเพิ่มเติมเกี่ยวกับมิติข้อมูลที่กำหนดเองได้ที่ https://support.google.com/analytics/answer/14240153 ซึ่งรวมถึง Channel Group ที่กําหนดเองด้วย หากต้องการดูข้อมูลเพิ่มเติมเกี่ยวกับ Channel Group ที่กําหนดเอง โปรดดู https://support.google.com/analytics/answer/13051316
category

string

ชื่อที่แสดงของหมวดหมู่ที่มิติข้อมูลนี้เป็นของ มิติข้อมูลและเมตริกที่คล้ายกันจะจัดหมวดหมู่ไว้ด้วยกัน
sections[]

enum (Section)

ระบุส่วน Google Analytics ที่มิติข้อมูลนี้ใช้

MetricMetadata

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

การแสดง JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
ช่อง
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

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

enum (BlockedReason)

หากมีการระบุเหตุผล ระบบจะบล็อกการเข้าถึงเมตริกนี้สำหรับพร็อพเพอร์ตี้นี้ คำขอ API จากคุณไปยังพร็อพเพอร์ตี้สําหรับเมตริกนี้จะสําเร็จ แต่รายงานจะมีค่าเป็น 0 สําหรับเมตริกนี้เท่านั้น คำขอ API ที่มีตัวกรองเมตริกในเมตริกที่ถูกบล็อกจะล้มเหลว หากเหตุผลว่างเปล่า คุณจะมีสิทธิ์เข้าถึงเมตริกนี้

ดูข้อมูลเพิ่มเติมได้ที่การจัดการการเข้าถึงและการจํากัดข้อมูล
category

string

ชื่อที่แสดงของหมวดหมู่ที่เมตริกนี้เป็นของ มิติข้อมูลและเมตริกที่คล้ายกันจะจัดหมวดหมู่ไว้ด้วยกัน
sections[]

enum (Section)

ระบุส่วน Google Analytics ที่เมตริกนี้ใช้

BlockedReason

เหตุผลที่บล็อกเมตริกนี้

Enum
BLOCKED_REASON_UNSPECIFIED จะไม่ระบุในการตอบกลับของ API
NO_REVENUE_METRICS หากมีอยู่ ระบบจะบล็อกสิทธิ์เข้าถึงเมตริกที่เกี่ยวข้องกับรายได้สำหรับพร็อพเพอร์ตี้นี้ และเมตริกนี้เกี่ยวข้องกับรายได้
NO_COST_METRICS หากมีอยู่ ระบบจะบล็อกการเข้าถึงเมตริกที่เกี่ยวข้องกับต้นทุนสำหรับพร็อพเพอร์ตี้นี้ และเมตริกนี้เกี่ยวข้องกับต้นทุน

ComparisonMetadata

ข้อมูลเมตาสำหรับการเปรียบเทียบรายการเดียว

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

string

ชื่อทรัพยากรของการเปรียบเทียบนี้ ใช้ได้ในช่องcomparisonของการเปรียบเทียบ เช่น "comparisons/1234"
uiName

string

ชื่อการเปรียบเทียบนี้ภายในอินเทอร์เฟซผู้ใช้ Google Analytics
description

string

คำอธิบายของการเปรียบเทียบนี้

ConversionMetadata

ข้อมูลเมตาสำหรับ Conversion รายการเดียว

การแสดง JSON 
{
  "conversionAction": string,
  "displayName": string
}
ช่อง
conversionAction

string

ตัวระบุที่ไม่ซ้ำกันของการกระทำที่ถือเป็น Conversion ระบบจะใช้รหัสนี้เพื่อระบุ Conversion ที่จะรวมไว้ในรายงานโดยการป้อนข้อมูลในฟิลด์ conversionActions ใน ConversionsSpec ของคำขอรายงาน เช่น "conversionActions/1234"
displayName

string

ชื่อ Conversion นี้ภายในอินเทอร์เฟซผู้ใช้ Google Analytics