יומן שינויים של ממשק ה-API לניהול של Google Analytics

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

בדף הזה מתועדים השינויים שבוצעו ב-Google Analytics Management API ושעשויים להשפיע על האפליקציה שלכם. מומלץ למפתחי API לבדוק מדי פעם את הרשימה הזו כדי לקבל הודעות חדשות. אפשר להירשם לשינויים גם דרך הפידים שמפורטים בקטע הרשמה שבהמשך.

הרשמה ליומני שינויים קשורים

האפשרות הזו כוללת את כל ממשקי ה-API של איסוף, הגדרה ודיווח.

כולל ממשק API לניהול וממשק API להקצאת משתמשים.

הגדרות שמירה של נתוני משתמשים ב-Management API

עכשיו אפשר עכשיו לקבוע באופן פרוגרמטי את הגדרות השמירה של נתוני המשתמשים באמצעות השדות החדשים dataRetentionTtl ו-dataRetentionResetOnNewActivity שנוספו למשאב WebProperty.

כתיבת פעולות בממשק ה-API לניהול

פעולות כתיבה בממשק ה-API לניהול (למשל יצירה, עדכון, מחיקה, תיקון) עבור נכס אינטרנט, תצוגה (פרופיל) ומשאבי יעדים כבר לא מחייבות הוספה של לרשימת היתרים. המגבלה היומית שמוגדרת כברירת מחדל לכל פעולות הכתיבה ב-Management API היא 50 פעולות כתיבה ביום. מידע נוסף זמין בדף מגבלות ומכסות.

מדדים מותאמים אישית

זוהי גרסה לתיקון באגים. היא פותרת את הבעיה שבה היצירה של מדד מותאם אישית מסוג TIME נכשלה כשלא הוגדר min_value. בבקשות בלי min_value נוצר עכשיו מדד מותאם אישית עם ערך ברירת המחדל של min_value שהוא 0.

סוגי מטבעות

זוהי גרסה לתיקון באגים. מהדורה זו פותרת בעיה שבה קבוצת משנה של מטבעות נתמכה בממשק האינטרנט של Analytics אך לא ב-API. בגרסה הזו נוספה תמיכה במטבעות הבאים:

  • UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL

למידע נוסף, ניתן לעיין במאמר: חומר העזר בנושא תצוגות (פרופילים). - המאמר במרכז העזרה מידע על מטבעות.

בגרסה הזו נוספו קהלים לרימרקטינג ל-Management API.

קהלים לרימרקטינג

Management API מאפשר ליצור קהלים לרימרקטינג ל-create, get, list, update וגם patch עבור נכס ב-Google Analytics. למידע נוסף על אופן הפעולה של קהלים לרימרקטינג, מומלץ לעיין במאמר מידע על קהלים לרימרקטינג ב-Google Analytics במרכז העזרה.

דוחות ללא דגימה

ה-API של דוחות ללא דגימה כבר לא מוגבל ל-100 דוחות ביום. ה-API משתמש באותה מערכת אסימונים לכל נכס, ליום כמו כשיוצרים דוח ללא דגימה דרך ממשק האינטרנט.

דוחות ללא דגימה

דוחות ללא דגימה שאינם נגישים למשתמש הנוכחי לא יכללו יותר קישור להורדה בהודעת התגובה של Management API. ההתנהגות הזו תואמת עכשיו לפונקציונליות של מרכז הבקרה של ממשק המשתמש, שבה רק הבעלים של הדוח יכולים לראות את הקישור להורדה של המסמך שנוצר.

צפיות (פרופילים)

בגרסה הזו נוספה המאפיין botFilteringEnabled למשאב של התצוגה המפורטת (פרופיל). המאפיין הזה מציין אם סינון הבוטים מופעל בתצוגה מפורטת (פרופיל). לפרטים, אפשר לעיין במסמכי העזר בנושא תצוגה (פרופילים).

דוחות ללא דגימה

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

פלחים

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

פלחים

זוהי גרסה לתיקון באגים. בגרסה הזו מתקנת בעיה שגורמת למשתמשים שהפלחים הפרטיים שלהם מוצמדים לכמה תצוגות מפורטות (פרופילים) לקבל את תגובת השגיאה 500 כשהם קוראים לשיטה של רשימת הפלחים.

אצווה

בגרסה הזו, בנוסף לתמיכה כללית, הוספנו תמיכה מיוחדת ל-User Permissions API. בבקשות מקובצות להרשאות משתמש יש שיפור משמעותי בביצועים וצמצום השימוש במכסות.

צפיות (פרופילים)

בגרסה הזו, נכס currency 'תצוגה (פרופיל)' יוגדר מעכשיו כברירת מחדל ל-USD אם לא הוגדר ערך במהלך פעולת הוספה. בנוסף, הפעולות get ו-list יחזירו USD בתצוגות מפורטות (פרופילים) שנוצרו קודם לכן ללא נכס currency.

מסננים

גרסה זו מסמנת את ההסרה הסופית של שדות הסינון IS_MOBILE ו-IS_TABLET שהוצאו משימוש. את השדות האלה צריך להחליף בשדות DEVICE_CATEGORY=mobile ו-DEVICE_CATEGORY=tablet. בקשות הוספה, עדכון ותיקון המגדירות את שדות הסינון לשימוש ב-IS_MOBILE ו-IS_TABLET יחזירו שגיאה.

מסננים

בגרסה הזו נוספה תמיכה בשימוש במאפיין מותאם אישית בשדה מסנן על ידי הוספת מאפיין fieldIndex לכל הקטעים של פרטי המסנן. לדוגמה, עכשיו אפשר להגדיר את ביטוי הסינון עם "field": "CUSTOM_DIMENSION" ועם "fieldIndex": "1" כך שהמסנן יפעל על המאפיין המותאם אישית הראשון.

שערים

הגרסה הזו גם מתקנת בעיה במהלך יצירת יעד באמצעות "comparisonValue": "0".

טופס אישור זה מציין את ההוצאה משימוש הסופית ואת הסרתה של dailyUpload. המשאב dailyUpload הוצא משימוש באופן רשמי ב-20 ביוני 2014; יש לבצע כעת את כל הייבוא של נתוני עלות באמצעות משאב ההעלאות.

בגרסה הזו נוספו שתי אוספים חדשים לממשק ה-API לניהול, למאפיינים מותאמים אישית ולמדדים מותאמים אישית.

מדדים ומאפיינים מותאמים אישית

עכשיו אפשר ליצור, להציג, לקבל, לתקן ולעדכן מאפיינים ומדדים מותאמים אישית באמצעות Management API.

התשובה של השיטה list לכל האוספים כוללת עכשיו רשימה ריקה עבור המאפיין items כשהאוסף לא מכיל משאבים. בעבר, המאפיין items יושמט מהתשובה. פרטים מלאים על שאילתות ותגובות עבור נתוני תצורה של Google Analytics זמינים בחומר העזר בנושא API.

בגרסה הזו נכלל היקף חדש של Google Analytics Management API. - analytics.manage.users.readonly - הצגת הרשאות משתמשים ב-Google Analytics.

נוסף שדה חדש של מסננים ב-DEVICE_CATEGORY, ו-IS_MOBILE ו-IS_TABLET הוצאו משימוש. משתמשים ב-DEVICE_CATEGORY=mobile וב-DEVICE_CATEGORY=tablet.

המשאב תצוגה מפורטת (פרופיל) כולל עכשיו נכס enhancedECommerceTracking שמציין אם מסחר אלקטרוני משופר מופעל (true) או מושבת (false).

הגרסה הזו כוללת סוגים חדשים של ייבוא נתונים והוצאה משימוש של המשאב dailyUpload.

ייבוא נתונים

עיין במדריך למפתחים בנושא ייבוא נתונים לקבלת פרטים על השימוש ב-Management API כדי לייבא נתונים לחשבון Google Analytics.

העלאות

  • המשאב upload תומך עכשיו בסוגי ההעלאה הבאים:
    • נתוני קמפיין
    • נתוני תוכן
    • נתוני עלות
    • נתוני המוצר
    • נתוני החזר כספי
    • נתוני משתמש
  • למשאב upload יש שיטה חדשה מסוג migrateDataImport להעברת נתוני העלות הקיימים customDataSources.

הוצאה משימוש של 'העלאות יומיות'

  • המשאב של dailyUpload הוצא משימוש. אפשר לעיין במדריך ההעברה לקבלת פרטים על המעבר לשימוש בתכונה ייבוא נתונים.
  • המשאב dailyUpload ימשיך לפעול למשך שישה חודשים נוספים, ולאחר מכן כל customDataSources שנותרו עם נכס uploadType שמוגדר כ-analytics#dailyUploads יועבר באופן אוטומטי ויעבוד רק עם המשאב upload.
  • המשתמשים הנוכחיים במשאב dailyUpload צריכים לעדכן את הקוד שלהם ולעבור להשתמש במשאב 'העלאה' בהקדם האפשרי.

בגרסה הזו נוספו שני ממשקי API חדשים להגדרה.

מסננים

דוחות ללא דגימה: ממשק API לניהול

בקרוב יתווסף משאב חדש ל-Management API בשם דוחות ללא דגימה. דוחות ללא דגימה הם דוחות של Google Analytics (GA) שנוצרו באמצעות נתונים ללא דגימה.בשלב זה, דוחות ללא דגימה זמינים רק למשתמשי GA Premium. 

פלחים: Management API v2.4 ו-v3.0

השינויים הבאים בוצעו באוסף הפלחים:

  • מעכשיו יש תמיכה ב-API של פלחי משתמשים ופלחי רצף.
  • אוסף הפלחים מחזיר עכשיו את כל הפלחים המובנים והמותאמים אישית ברמת הביקור וברמת המשתמש.
  • הנכס definition לפלחים ישתמש עכשיו בתחביר החדש של פלחים. זה כולל הגדרות לפלחים קיימים ברמת הסשן, שישתנו מ-definition: "" ל-definition: "sessions::condition::".
  • נכס type חדש נוסף למשאב פלח כדי לציין אם הפלח הוא CUSTOM (כלומר, נוצר על ידי משתמש בממשק האינטרנט) או BUILT_IN (כלומר, מסופק על ידי Google Analytics).

ניסויים

המדדים הבאים של AdSense יכולים עכשיו לשמש כיעדי אופטימיזציה:

  • ga:adsenseAdsClicks - מספר הפעמים שלחצו על מודעות AdSense באתר שלך.
  • ga:adsenseAdsViewed - מספר מודעות AdSense שהוצגו. אפשר להציג כמה מודעות בתוך יחידת מודעות.
  • ga:adsenseRevenue - סך כל ההכנסות ממודעות AdSense.

אוסף חדש של סיכומי חשבונות

בעקבות הוצאה משימוש של המאפיינים ga:isMobile ו-ga:isTablet, בוצעו השינויים הבאים בפלחי ברירת המחדל:

  • השם של הפלח gaid::-11 השתנה מתנועה בנייד לתנועה בניידים ובטאבלטים. ההגדרה של הפלח הזה השתנתה מ-ga:isMobile==Yes ל-ga:deviceCategory==mobile,ga:deviceCategory==tablet. לתשומת ליבך, ga:isMobile כללה תנועה מטאבלטים, הבאה לידי ביטוי בהגדרה החדשה. אם אתם רוצים לקבל רק תנועה מניידים, לא כולל הטאבלטים, עליכם לעבור לפלח תנועה בנייד (gaid::-14) החדש.
  • ההגדרה של הפלח gaid::-13 השתנתה מ-ga:isTablet==Yes ל-ga:deviceCategory==tablet. הנתונים האלה ממשיכים לייצג תנועה בטאבלט.
  • הפלח gaid::-14 נוסף. שם הפלח הוא תנועה מנייד וההגדרה שלו היא ga:deviceCategory==mobile.

תיקוני באגים:

  • פרטי אזור הזמן של התצוגות (פרופילים) תוקנו. פרטים: לפני התיקון הזה, במקרים מסוימים כשתצוגת כרטיסי המוצר (פרופילים) ב-Management API, הוחזרה מידע שגוי על אזור הזמן של תצוגה מפורטת (פרופיל). המידע על אזור הזמן של התצוגות (פרופילים) תואם עכשיו להגדרות בממשק הניהול של Google Analytics.

גרסה זו כוללת פעולות כתיבה למשאבי נכס אינטרנט, תצוגה (פרופיל) ויעדים, וקבוצה של 3 משאבים חדשים שמאפשרים ניהול של הרשאות משתמשים.

ממשקי API להגדרת חשבון ולהגדרת חשבון

הרשאות משתמשים ב-Management API

כחלק מהשקת הפלחים החדשים, נשיק את השינויים הבאים באוסף הפלחים:

  • כל מזהי הפלחים ישתנו ממספרים שלמים חיוביים למחרוזות אלפאנומריות. אם שמרת מזהי פלחים של משתמשים, מומלץ לעדכן אותם כך שישתמשו במזהים החדשים.
  • אוסף הפלחים יחזיר רק את הפלחים הקיימים ברמת הביקור. פלחים חדשים של מבקרים, קבוצות בעלות מאפיינים משותפים ופלחים בהמשכים לא נתמכים כרגע ב-API.
  • אוסף הפלחים ימשיך להחזיר את פלחי ברירת המחדל הקיימים בעלי אותם מזהים מספריים שליליים, אך כרגע פלחי ברירת המחדל החדשים אינם נתמכים.

בגרסה הזו נוספו 2 נכסים חדשים למשאב של נכס האינטרנט:

  • profileCount - מחזירה מספר פרופילים של נכס. כך תוכלו לסנן נכסים שלא מכילים פרופילים (למשל, profileCount = 0).
  • industryVertical - החזרת הענף/הקטגוריה של התחום שנבחרו עבור נכס.

תיקוני באגים:

  • המאפיין eCommerceTracking של משאב הפרופיל תואם עכשיו להגדרות המסחר האלקטרוני בקטע האדמין של ממשק האינטרנט. הפונקציה מחזירה את הערך true כשהמעקב אחר מסחר אלקטרוני מופעל, ואת הערך false אם לא.
  • נקודת קצה חדשה נוספה ל-Management API v3 כדי לגשת למשאבים של ניסויים ולשנות אותם.
  • משאב הפרופיל כולל עכשיו את המאפיין type לזיהוי אם פרופיל מוגדר לאתר אינטרנט או לאפליקציה. שני הערכים האפשריים הם: WEB או APP.

בגרסה הזו נוספו תגובות שגיאה מועילות ל-Management API.

  • קודי שגיאות, סיבות ותיאורים חדשים נוספו לגוף התגובות לשגיאות API. כל הקודים תועדו לשתי הגרסאות - גרסה 2.4 וגרסה 3.0 - של ממשק ה-API לניהול.

בגרסה הזו נוספים נתונים, משנה פונקציונליות קיימת ומתקנת באג.

נתונים חדשים

  • האוסף 'פלח מתקדם' מכיל עכשיו שדה segmentId שיכול לשמש בפרמטר segment של API לייצוא נתונים.

השינויים

  • סוג הנתונים עבור max-results השתנה ל-integer.

  • ערך ברירת המחדל והערך המקסימלי עבור max-results השתנו ל-1,000.

תיקוני באגים

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

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

גרסה 3.0

  • זוהי הגרסה הראשית האחרונה של ה-API שלנו והיא לא תואמת לאחור. כל הפיתוחים העתידיים של ה-API יתבצעו בגרסה הזו.

  • נתונים חדשים

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

גרסה 2.4

  • זהו שדרוג גרסה משני שלרוב תואם לאחור לגרסה 2.3 הקיימת.

  • השינויים

    • מדיניות חדשה בנושא מכסות
    • שילוב עם Google APIs Console כדי לנהל את הגישה ל-API ולבקש עוד מכסה
    • תמיכה מתמשכת במנגנוני הרשאות קיימים וב-OAuth 2.0
    • כתובת URL חדשה לשליחת בקשות: https://www.googleapis.com/analytics/v2.4/management/…
    • תשובות ב-XML בלבד
    • אין תמיכה בספריית הלקוח של JavaScript לנתוני Google
    • פלט XML שתואם לגרסה 2.3, כך שספריות הלקוח האחרות של נתוני Google ימשיכו לפעול.

הוצאה משימוש

  • אנחנו מודיעים על הוצאה משימוש של גרסה 2.3 של ממשק ה-API לניהול מדור קודם. היא תמשיך לפעול במשך חודשיים, ולאחר מכן כל הבקשות לגרסה 2.3 יחזירו תגובה בגרסה 2.4.

זוהי גרסת הבטא של Google Analytics Management API!

פידים חדשים

ספריות לקוח מעודכנות

  • בקרוב נשיק את Management API לאותה ספרייה שבה נמצא ממשק ה-API לייצוא נתונים של Google Analytics. ספריות Google Data Java ו-JavaScript עודכנו. כדי לגשת לכל פיד, צריך לציין את ה-URI המתאים של הפיד לשיטה getManagementFeed() של הספריות.

מסמכי תיעוד חדשים