Method: properties.checkCompatibility

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

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

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

בקשת HTTP

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

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

enum (Compatibility)

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

MetricCompatibility

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

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

object (MetricMetadata)

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

enum (Compatibility)

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