My Business Account Management API

ה-My Business Account Management API מספק ממשק לניהול הגישה למיקום ב-Google.

הערה – אם אחרי הפעלת ה-API יש מכסה של 0, צריך לשלוח בקשה להרשאת גישה ל-GBP API.

שירות: mybusinessaccountmanagement.googleapis.com

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

מסמך Discovery

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

נקודת הקצה של השירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות ה-API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:

  • https://mybusinessaccountmanagement.googleapis.com

משאב REST: v1.accounts

שיטות
create POST /v1/accounts
יצירת חשבון עם השם והסוג שצוינו מתחת להורה הנתון.
get GET /v1/{name=accounts/*}
הפונקציה מקבלת את החשבון שצוין.
list GET /v1/accounts
רשומים כל החשבונות של המשתמש המאומת.
patch PATCH /v1/{account.name=accounts/*}
עדכון החשבון העסקי שצוין.

משאב REST: v1.accounts.admins

שיטות
create POST /v1/{parent=accounts/*}/admins
הזמנה של המשתמש שצוין להפוך לאדמין של החשבון שצוין.
delete DELETE /v1/{name=accounts/*/admins/*}
הסרה של האדמין שצוין מהחשבון שצוין.
list GET /v1/{parent=accounts/*}/admins
רשימת האדמינים של החשבון שצוין.
patch PATCH /v1/{accountAdmin.name=accounts/*/admins/*}
עדכון האדמין עבור האדמין של החשבון שצוין.

משאב ל-REST: v1.accounts.invitations

שיטות
accept POST /v1/{name=accounts/*/invitations/*}:accept
יאשר את ההזמנה שצוינה.
decline POST /v1/{name=accounts/*/invitations/*}:decline
דוחה את ההזמנה שצוינה.
list GET /v1/{parent=accounts/*}/invitations
רשומים הזמנות בהמתנה לחשבון שצוין.

משאב ל-REST: v1.locations

שיטות
transfer POST /v1/{name=locations/*}:transfer
מעביר מיקום מחשבון שבבעלות המשתמש לחשבון אחר שאותו המשתמש מנהל.

משאב REST: v1.locations.admins

שיטות
create POST /v1/{parent=locations/*}/admins
הזמנה של המשתמש שצוין להפוך לאדמין של המיקום שצוין.
delete DELETE /v1/{name=locations/*/admins/*}
הסרת האדמין שצוין כמנהל של המיקום שצוין.
list GET /v1/{parent=locations/*}/admins
רשימה של כל האדמינים במיקום שצוין.
patch PATCH /v1/{locationAdmin.name=locations/*/admins/*}
האדמין יעדכן את המיקום שצוין.