במסמך הזה מתוארת המדיניות לגבי הוצאה משימוש של ממשקי API לדיווח ולמטא-נתונים.
סקירה כללית
מאפיינים ומדדים (עמודות) משמשים לשליחת שאילתות בממשקי API של דיווח ב-Google Analytics. לפעמים צריך להוסיף, להסיר או לשנות את השמות של העמודות האלה. מטרת המדיניות בנושא הוצאה משימוש של נתונים היא להגביר את השקיפות של השינויים.
כל השינויים בעמודות יפורסמו באמצעות loglogs ו-Metadata API יעודכן באופן אוטומטי בהתאם לשינויים האלה.
מה נכלל במדיניות הזו
המדיניות הזו כוללת את המאפיינים והמדדים שנחשפו על ידי ממשקי API ציבוריים. היא לא כוללת את הבקשה ל-API (פרמטרים של השאילתה), התגובה ל-API, הערכים שה-API החזיר, או שילובים חוקיים של מאפיינים ומדדים.
נתונים חדשים
כשמוסיפים עמודות חדשות ל-API:
- מילון השינויים של ה-API המתאים יעודכן עם פרטים לגבי העמודות החדשות.
- העמודות יהיו זמינות ב-Metadata API.
הסרת נתונים
כשמסירים עמודות מ-API:
- מילון השינויים של ה-API המתאים יעודכן לפי הפרטים לגבי העמודות המוסרות.
- ב-
Metadata API, המאפיין
של העמודה
status
יוגדר כ-DEPRECATED
. - העמודות ימשיכו לפעול בשאילתות דיווח למשך 6 חודשים לפחות.
- אחרי 6 חודשים, העמודות יוסרו מ-Metadata API והשאילתות מעמודות ה-API לדיווח יובילו לשגיאה
400 Bad Request
.
שינוי של שם הנתונים
לאחר שינוי השם של עמודות:
- יומני השינויים של ה-API המתאים יעודכנו עם הפרטים על העמודה המקורית וההחלפה.
- ב-Metadata API
, המאפיין
status
של העמודה המקורית יוגדר כ-DEPRECATED
, והמאפייןreplacedBy
יוגדר כמזהה של העמודה החלופית. - העמודות המקוריות ימשיכו לפעול בשאילתות הדיווח למשך 6 חודשים לפחות.
- אחרי 6 חודשים, העמודות המקוריות יוסרו
מה-Metadata API והשאילתה של העמודות עבור ה-API לדיווח תוביל לשגיאה
400 Bad Request
.
הסרת מאפיין
כשמסירים מאפיינים מה-Metadata API:
- היומן של המטא-נתונים של שינוי ה-API יעודכן עם הפרטים לגבי המאפיינים שהוסרו.
- המאפיינים ימשיכו להיות זמינים ב-Metadata API למשך 6 חודשים לפחות.
- לאחר 6 חודשים, המאפיינים יוסרו מ-Metadata API.
קבוצות
לפעמים צריך לשנות את השם של קבוצה או את סדר העמודות. כאשר זה קורה:
- יומן המטא-נתונים של שינוי ה-API יעודכן עם פרטים על שם הקבוצה ועל השינויים בהזמנה.