Method: properties.checkCompatibility

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

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

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

คำขอ HTTP

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

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

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

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

string

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

ตัวอย่าง: properties/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)

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

MetricCompatibility

ความเข้ากันได้ของเมตริกเดียว

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

object (MetricMetadata)

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

enum (Compatibility)

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