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

תאימות

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

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

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