API Reference

ממשק API לניהול

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

כל קטע במדריך הזה מגדיר את שיטת הבקשה ואת התגובה לסוג ישות אחד בנתוני התצורה של משתמש מאומת. כל הבקשות מוצגות בפורמט REST. בסוף הדף עבור כל שיטה, אפשר לנסות את הבקשה באופן אינטראקטיבי ב-APIs Explorer באמצעות הקישור "Try it!" .

סוגי משאבים

  1. סיכומי החשבונות
  2. קישורי משתמשים לחשבון
  3. חשבונות
  4. קישורי AdWords
  5. מקורות נתונים מותאמים אישית
  6. מאפיינים מותאמים אישית
  7. מדדים מותאמים אישית
  8. ניסויים
  9. מסננים
  10. יעדים
  11. מזהה לקוח
  12. קישורים לסינון הפרופיל
  13. קישורי משתמשים בפרופיל
  14. קהלים לרימרקטינג
  15. פלחים
  16. דוחות ללא דגימה
  17. העלאות
  18. צפיות (פרופילים)
  19. נכסי אינטרנט
  20. קישורי משתמשים לנכס אינטרנט

סיכומי חשבונות

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
list GET  /management/accountSummaries רשימה של סיכומי החשבונות (עץ פשוט, המורכב מחשבונות/נכסים/פרופילים) שאליהם יש למשתמש גישה.

לפרטים על משאב קישורי המשתמשים בחשבון, עיין בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/entityUserLinks/linkId הסרה של משתמש מהחשבון הנתון.
insert POST  /management/accounts/accountId/entityUserLinks הוספה של משתמש חדש לחשבון הנתון אם למשתמש יש פחות מ-100 חשבונות.
list GET  /management/accounts/accountId/entityUserLinks רשימה של קישורי משתמש בחשבון עבור חשבון נתון.
עדכון PUT  /management/accounts/accountId/entityUserLinks/linkId עדכון ההרשאות של משתמש קיים בחשבון הנתון.

חשבונות

לפרטים על משאב החשבונות, עיינו בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
list GET  /management/accounts רשימה של כל החשבונות שיש למשתמש גישה אליהם.

פרטים על משאב של קישורים ב-AdWords זמינים בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId מחיקת קישור לנכס אינטרנט-AdWords.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId מחזירה קישור נכס אינטרנט-AdWords שאליו המשתמש יכול לגשת.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks תבנית זו יוצרת קישור לאינטרנט של נכס-AdWords.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks מפרט קישורי אינטרנט-נכס-AdWords עבור נכס אינטרנט נתון.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId עדכון קישור קיים של נכס אינטרנט-AdWords. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/entityAdWordsLinks/webPropertyAdWordsLinkId עדכון קישור קיים של נכס אינטרנט-AdWords.

מקורות נתונים מותאמים אישית

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources רשימה של מקורות נתונים מותאמים אישית שאליהם יש למשתמש גישה.

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

פרטים על המשאב 'מאפיינים מותאמים אישית' זמינים בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId לקבל מאפיין מותאם אישית שיש למשתמש גישה אליו.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customDimensions יוצרים מאפיין מותאם אישית חדש.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDimensions רשימה של מאפיינים מותאמים אישית שאליהם יש למשתמש גישה.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId עדכון מאפיין מותאם אישית קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId עדכון מאפיין מותאם אישית קיים.

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

בדף ייצוג משאבים ניתן למצוא פרטים על משאב המדדים המותאמים אישית.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId קבלת מדד מותאם אישית שאליו יש למשתמש גישה.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/customMetrics יוצרים מדד מותאם אישית חדש.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customMetrics רשימה של מדדים מותאמים אישית שאליהם יש למשתמש גישה.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId עדכון של מדד מותאם אישית שכבר קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId עדכון של מדד מותאם אישית שכבר קיים.

ניסויים

לפרטים על משאבי המשאב של הניסויים, עיינו בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId למחוק ניסוי.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId מחזירה ניסוי שיש למשתמש גישה אליו.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments יוצרים ניסוי חדש.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments רשימה של ניסויים שלמשתמש יש גישה אליהם.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId מעדכנים ניסוי קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId מעדכנים ניסוי קיים.

מסננים

לפרטים על משאב המסננים, עיינו בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/filters/filterId למחוק מסנן.
הורדה GET  /management/accounts/accountId/filters/filterId מחזירה מסננים שאליהם יש למשתמש גישה.
insert POST  /management/accounts/accountId/filters יוצרים מסנן חדש.
list GET  /management/accounts/accountId/filters הצגת כל המסננים של חשבון
תיקון PATCH  /management/accounts/accountId/filters/filterId עדכון של מסנן קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/filters/filterId עדכון של מסנן קיים.

יעדים

פרטים על משאב היעד זמינים בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId מקבל יעד שלמשתמש יש גישה אליו.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals יוצרים מטרה עסקית חדשה.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals רשימה של היעדים שלמשתמשים יש גישה אליהם.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId עדכון יעד קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/goals/goalId עדכון יעד קיים.

Client ID

בדף ייצוג משאב ניתן למצוא פרטים על משאב Management.clientId.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
HashClientId POST  /management/clientId:hashClientId מתבצעת גיבוב (hash) של מזהה הלקוח הנתון.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId מחיקת קישור למסנן פרופיל.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId מחזירה קישור של מסנן פרופיל אחד.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks יצירת קישור חדש למסנן פרופיל.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks רשימה של כל קישורי הסינון של פרופיל.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId עדכון קישור של מסנן פרופיל קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks/linkId עדכון קישור של מסנן פרופיל קיים.

בדף ייצוג משאבים מפורט מידע על המשאבים של פרופילי המשתמשים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId הסרה של משתמש מהתצוגה המפורטת (פרופיל).
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks הוספה של משתמש חדש לתצוגה המפורטת (פרופיל) שנבחרה.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks רשימה של קישורי משתמש פרופיל עבור תצוגה מפורטת נתונה (פרופיל).
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/entityUserLinks/linkId עדכון ההרשאות של משתמש קיים בתצוגה המפורטת (פרופיל).

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

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId מחיקת קהל לרימרקטינג.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId מקבל קהל לרימרקטינג שאליו יש למשתמש גישה.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences ייצור קהל חדש לרימרקטינג.
list GET  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences רשימה של קהלים לרימרקטינג שאליהם יש למשתמש גישה.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId עדכון קהל קיים לרימרקטינג. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/remarketingAudiences/remarketingAudienceId עדכון קהל קיים לרימרקטינג.

פלחים

תוכלו למצוא פרטים על משאב המשאב בפלחים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
list GET  /management/segments רשימה של הפלחים שאליהם יש למשתמש גישה.

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

כדי לקבל פרטים על משאב הדוח ללא דגימה, יש לעיין בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId מחיקת דוח ללא דגימה.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports/unsampledReportId מחזירה דוח יחיד ללא דגימה.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports יוצרים דוח חדש ללא דגימה.
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/unsampledReports מפרט דוחות ללא דגימה שלמשתמש יש גישה אליהם.

העלאות

פרטים על המשאב 'העלאות' זמינים בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
deleteuploadData POST  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/deleteUploadData מחיקת נתונים המשויכים להעלאה קודמת.
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads/uploadId רשימה של ההעלאות שיש למשתמש גישה אליהן.
list GET  /management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads רשימה של ההעלאות שיש למשתמש גישה אליהן.
uploadData POST
https://www.googleapis.com/upload/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDataSources/customDataSourceId/uploads
העלאת נתונים עבור מקור נתונים מותאם אישית.

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

לפרטים על משאבי המשאב (צפיות) (פרופילים), עיינו בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId מחיקת צפייה (פרופיל).
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId מקבל תצוגה (פרופיל) שלמשתמש יש גישה אליה.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/profiles יצירת תצוגה מפורטת חדשה (פרופיל).
list GET  /management/accounts/accountId/webproperties/webPropertyId/profiles רשימה של התצוגות המפורטות (הפרופילים) שלמשתמש יש גישה אליהן.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId עדכון תצוגה קיימת (פרופיל). שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/profiles/profileId עדכון תצוגה קיימת (פרופיל).

נכסי אינטרנט

פרטים על משאב של נכסי אינטרנט זמינים בדף ייצוג משאבים.

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
הורדה GET  /management/accounts/accountId/webproperties/webPropertyId מקבל נכס שלמשתמש יש גישה אליו.
insert POST  /management/accounts/accountId/webproperties ייצור נכס חדש.
list GET  /management/accounts/accountId/webproperties רשימה של נכסים שלמשתמש יש גישה אליהם.
תיקון PATCH  /management/accounts/accountId/webproperties/webPropertyId עדכון נכס קיים. שיטה זו תומכת בסמנטיקה של תיקון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId עדכון נכס קיים.

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

שיטה בקשת HTTP תיאור
מזהי URI ביחס לכתובת https://www.googleapis.com/analytics/v3, אלא אם צוין אחרת
מחיקה DELETE  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId מסיר משתמש מנכס האינטרנט הנתון.
insert POST  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks הוספת משתמש חדש לנכס האינטרנט הנתון.
list GET  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks מפרט קישורים של משתמשי אינטרנט לנכס אינטרנט נתון.
עדכון PUT  /management/accounts/accountId/webproperties/webPropertyId/entityUserLinks/linkId עדכון ההרשאות של משתמש קיים בנכס האינטרנט הנתון.