הקצאת חשבונות בניהול שותף - מדריך למפתחי API

מבוא

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

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

לפני שתתחיל

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

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

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

  1. רשום את האפליקציה שלך במסוף Google API.
  2. הרשאה ליצור חשבון Google Analytics חדש.
  3. יוצרים אובייקט שירות של Analytics.

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

חשבון התבנית

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

הקצאת חשבון

כדי להקצות חשבון Google Analytics חדש, צריך להגיש בקשה לנקודת הקצה של ה-API ב-createAccountTree. נדרשים הפרטים הבאים של ניהול הקצאות:

  • השדות Account (חשבון)
    • accountName של החשבון.
  • שדות של נכס אינטרנט
    • webpropertyName של הנכס.
    • websiteUrl. זו צריכה להיות כתובת ה-URL המשויכת למאפיין המשתמש של חשבון Analytics הזה.
  • הצגת שדות
    • profileName של התצוגה.
    • timezone של התצוגה.

אחרי שיהיו בידכם הפרטים, מבצעים קריאה מאומתת לנקודת הקצה ל-API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

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

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

בעלות וניהול על החשבון

חשבון Google Analytics שייווצר יהיה בבעלות חשבון המשתמש שאישר את התגובה באמצעות OAuth. לכן מומלץ שהארגון שלכם ישתמש בחשבון שירות כדי לנהל את חשבון Analytics, ולא בחשבון משתמש פרטי.

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

הבהרה בנוגע לקשרי החשבונות

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