Method: properties.checkCompatibility

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

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

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

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
property

string

מזהה נכס GA4 של 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

תאימות

סוגי התאימות למאפיין או למדד יחיד.

טיפוסים בני מנייה (enums)
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)

התאימות של המדד הזה. אם התאימות תואמת, ניתן להוסיף את המדד הזה לדוח בהצלחה.