- בקשת HTTP
- פרמטרים של נתיב
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- תאימות
- DimensionCompatibility
- MetricCompatibility
- רוצים לנסות?
שיטת התאימות הזו מפרטת מאפיינים ומדדים שאפשר להוסיף לבקשת דוח ולשמור על תאימות. השיטה הזו תיכשל אם המאפיינים והמדדים של הבקשה לא תואמים.
ב-Google Analytics, דוחות נכשלים אם הם מבקשים מאפיינים ו/או מדדים לא תואמים. במקרה כזה, תצטרכו להסיר מאפיינים ו/או מדדים מהדוח שאינו תואם עד שהדוח יהיה תואם.
לדוחות 'זמן אמת' ולדוחות הליבה יש כללי תאימות שונים. השיטה הזו בודקת תאימות לדוחות ליבה.
בקשת HTTP
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
property |
מזהה נכס GA4 של Google Analytics שיש מעקב אחרי האירועים שלו. למידע נוסף, אפשר לעיין במאמר איפה למצוא את מזהה הנכס. דוגמה: properties/1234 |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensions": [ { object ( |
שדות | |
---|---|
dimensions[] |
המאפיינים בדוח הזה. |
metrics[] |
המדדים בדוח הזה. |
dimensionFilter |
סעיף הסינון של המאפיינים. |
metricFilter |
סעיף הסינון של המדדים. |
compatibilityFilter |
סינון המאפיינים והמדדים בתגובה לתאימות הזו בלבד. משמש בדרך כלל בתור |
גוף התשובה
תגובת התאימות לתאימות של כל מאפיין ומדד.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dimensionCompatibilities": [ { object ( |
שדות | |
---|---|
dimensionCompatibilities[] |
התאימות של כל מאפיין. |
metricCompatibilities[] |
תאימות של כל מדד. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
תאימות
סוגי התאימות למאפיין או למדד יחיד.
טיפוסים בני מנייה (enums) | |
---|---|
COMPATIBILITY_UNSPECIFIED |
לא צוינה תאימות. |
COMPATIBLE |
המאפיין או המדד תואמים. ניתן להוסיף את המאפיין או המדד הזה לדוח. |
INCOMPATIBLE |
המאפיין או המדד לא תואמים. לא ניתן להוסיף לדוח את המאפיין או המדד הזה. |
DimensionCompatibility
התאימות של מאפיין יחיד.
ייצוג JSON |
---|
{ "dimensionMetadata": { object ( |
שדות | |
---|---|
dimensionMetadata |
המטא-נתונים של המאפיין מכילים את שם ה-API של פרטי התאימות האלה. המטא-נתונים של המאפיין מכילים גם מידע שימושי נוסף, כמו השם והתיאור של ממשק המשתמש. |
compatibility |
התאימות של המאפיין הזה. אם התאימות תואמת, ניתן להוסיף את המאפיין הזה לדוח. |
MetricCompatibility
התאימות של מדד יחיד.
ייצוג JSON |
---|
{ "metricMetadata": { object ( |
שדות | |
---|---|
metricMetadata |
המטא-נתונים של המדד מכילים את שם ה-API של פרטי התאימות האלה. המטא-נתונים של המדד מכילים גם מידע שימושי נוסף, כמו השם והתיאור של ממשק המשתמש. |
compatibility |
התאימות של המדד הזה. אם התאימות תואמת, ניתן להוסיף את המדד הזה לדוח בהצלחה. |