Method: properties.checkCompatibility

วิธีความเข้ากันได้นี้จะแสดงรายการมิติข้อมูลและเมตริกที่สามารถเพิ่มลงในคำขอรายงานและรักษาความเข้ากันได้ วิธีนี้จะไม่สำเร็จหากมิติข้อมูลและเมตริกของคำขอใช้ร่วมกันไม่ได้

รายงานใน Google Analytics จะล้มเหลวหากขอมิติข้อมูลและ/หรือเมตริกที่ใช้ร่วมกันไม่ได้ ในกรณีนี้ คุณจะต้องนํามิติข้อมูลและ/หรือเมตริกออกจากรายงานที่ใช้ร่วมกันไม่ได้จนกว่ารายงานจะใช้งานร่วมกันได้

รายงานแบบเรียลไทม์และรายงานหลักมีกฎความเข้ากันได้แตกต่างกัน วิธีนี้จะตรวจสอบความเข้ากันได้ของรายงานหลัก

คำขอ HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

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

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

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

string

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

เช่น พร็อพเพอร์ตี้/1234

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
ช่อง
dimensions[]

object (Dimension)

มิติข้อมูลในรายงานนี้ dimensions ควรเป็นค่าเดียวกับในคำขอ runReport
metrics[]

object (Metric)

เมตริกในรายงานนี้ metrics ควรเป็นค่าเดียวกับในคำขอ runReport
dimensionFilter

object (FilterExpression)

ข้อความตัวกรองของมิติข้อมูล dimensionFilter ควรเป็นค่าเดียวกับในคำขอ runReport
metricFilter

object (FilterExpression)

ข้อความตัวกรองของเมตริก metricFilter ควรเป็นค่าเดียวกับในคำขอ runReport
compatibilityFilter

enum (Compatibility)

กรองมิติข้อมูลและเมตริกตามความเข้ากันได้นี้เท่านั้น โดยทั่วไปมักใช้ในฐานะ ”compatibilityFilter”: “COMPATIBLE” เพื่อแสดงผลเฉพาะมิติข้อมูลที่เข้ากันได้และ เมตริกต่างๆ

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

การตอบสนองเกี่ยวกับความเข้ากันได้ที่มีความเข้ากันได้ของแต่ละมิติข้อมูลและ เมตริก

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

การแสดง JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
ช่อง
dimensionCompatibilities[]

object (DimensionCompatibility)

ความเข้ากันได้ของมิติข้อมูลแต่ละรายการ
metricCompatibilities[]

object (MetricCompatibility)

ความเข้ากันได้ของเมตริกแต่ละรายการ

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

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

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

ความเข้ากันได้

ประเภทความเข้ากันได้สำหรับมิติข้อมูลหรือเมตริกรายการเดียว

Enum
COMPATIBILITY_UNSPECIFIED ความเข้ากันได้ที่ไม่ระบุ
COMPATIBLE มิติข้อมูลหรือเมตริกใช้ร่วมกันได้ เพิ่มมิติข้อมูลหรือเมตริกนี้ลงในรายงานเรียบร้อยแล้ว
INCOMPATIBLE มิติข้อมูลหรือเมตริกใช้ร่วมกันไม่ได้ เพิ่มมิติข้อมูลหรือเมตริกนี้ลงในรายงานไม่สำเร็จ

DimensionCompatibility

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

การแสดง JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
ช่อง
dimensionMetadata

object (DimensionMetadata)

ข้อมูลเมตาของมิติข้อมูลมีชื่อ API สําหรับข้อมูลความเข้ากันได้นี้ นอกจากนี้ ข้อมูลเมตาของมิติข้อมูลยังมีข้อมูลที่เป็นประโยชน์อื่นๆ เช่น ชื่อและคำอธิบาย UI
compatibility

enum (Compatibility)

ความเข้ากันได้ของมิติข้อมูลนี้ หากความเข้ากันได้สามารถเข้ากันได้ คุณจะเพิ่มมิติข้อมูลนี้ลงในรายงานได้สำเร็จ

MetricCompatibility

ความเข้ากันได้สำหรับเมตริกเดียว

การแสดง JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
ช่อง
metricMetadata

object (MetricMetadata)

ข้อมูลเมตาของเมตริกมีชื่อ API สำหรับข้อมูลความเข้ากันได้นี้ นอกจากนี้ ข้อมูลเมตาของเมตริกยังประกอบด้วยข้อมูลที่เป็นประโยชน์อื่นๆ เช่น ชื่อและคำอธิบาย UI
compatibility

enum (Compatibility)

ความเข้ากันได้ของเมตริกนี้ หากความเข้ากันได้สามารถเข้ากันได้ คุณจะเพิ่มเมตริกนี้ลงในรายงานได้สำเร็จ