Method: properties.checkCompatibility

בשיטת התאימות הזו מפורטים המאפיינים והמדדים שאפשר להוסיף לבקשת דוח ולשמור על תאימות. השיטה הזו תיכשל אם המאפיינים והמדדים של הבקשה לא תואמים.

ב-Google Analytics, הדוחות נכשלים אם הם מבקשים מאפיינים או מדדים לא תואמים. במקרה כזה, תצטרכו להסיר מהדוח מאפיינים או מדדים לא תואמים עד שהדוח יהיה תואם.

יש כללי תאימות שונים לדוחות בזמן אמת ולדוחות הליבה. השיטה הזו בודקת את התאימות של דוחות הליבה.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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 של פרטי התאימות האלה. המטא-נתונים של המאפיין מכילים גם מידע מועיל אחר, כמו השם והתיאור שמופיעים בממשק המשתמש.
compatibility

enum (Compatibility)

התאימות של המאפיין הזה. אם התאימות היא COMPATIBLE, אפשר להוסיף את המאפיין הזה לדוח.

MetricCompatibility

התאימות למדד יחיד.

ייצוג JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
שדות
metricMetadata

object (MetricMetadata)

המטא-נתונים של המדד מכילים את שם ה-API של פרטי התאימות האלה. המטא-נתונים של המדד מכילים גם מידע מועיל אחר, כמו השם והתיאור שמופיעים בממשק המשתמש.
compatibility

enum (Compatibility)

התאימות של המדד הזה. אם התאימות היא COMPATIBLE, אפשר להוסיף את המדד הזה לדוח.