Google My Business API

Google My Business API מספק ממשק לניהול פרטי מיקום העסק ב-Google.

שירות: mybusiness.googleapis.com

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

מסמך Discovery

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

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

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

  • https://mybusiness.googleapis.com

משאב REST: v4.accounts

שיטות
create
(deprecated)		 POST /v4/accounts
יצירת חשבון עם השם והסוג שצוינו מתחת להורה הנתון.
deleteNotifications
(deprecated)		 DELETE /v4/{name=accounts/*/notifications}
ניקוי ההגדרות של התראות pubsub בחשבון.
generateAccountNumber
(deprecated)		 POST /v4/{name=accounts/*}:generateAccountNumber
מייצר מספר חשבון לחשבון זה.
get
(deprecated)		 GET /v4/{name=accounts/*}
הפונקציה מקבלת את החשבון שצוין.
getNotifications
(deprecated)		 GET /v4/{name=accounts/*/notifications}
מחזירה את הגדרות ההתראות של Pubsub של החשבון.
list
(deprecated)		 GET /v4/accounts
רשומים כל החשבונות של המשתמש המאומת.
listRecommendGoogleLocations GET /v4/{name=accounts/*}:recommendGoogleLocations
רשימה של כל הערכים מסוג GoogleLocation שהומלצו לחשבון פרופיל העסק שצוין.
update
(deprecated)		 PUT /v4/{name=accounts/*}
עדכון החשבון העסקי שצוין.
updateNotifications
(deprecated)		 PUT /v4/{name=accounts/*/notifications}

המדיניות הזו קובעת את ההגדרות של ההתראות ב-Pubsub בחשבון שבו יישלחו התראות לגבי פרופיל העסק ב-Google לגבי הנושא הבא:

  • ביקורות חדשות על מיקומים שמנוהלים על ידי החשבון.

משאב REST: v4.accounts.admins

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

משאב REST: v4.accounts.invitations

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

משאב REST: v4.accounts.locations

שיטות
associate POST /v4/{name=accounts/*/locations/*}:associate
משייך מיקום למזהה מקום.
batchGet POST /v4/{name=accounts/*}/locations:batchGet
הפונקציה מקבלת את כל המיקומים שצוינו בחשבון הנתון.
batchGetReviews POST /v4/{name=accounts/*}/locations:batchGetReviews
מחזירה רשימה מעומדת של ביקורות לכל המיקומים שצוינו.
clearAssociation POST /v4/{name=accounts/*/locations/*}:clearAssociation
ניקוי השיוך בין מיקום למזהה המקום שלו.
create POST /v4/{parent=accounts/*}/locations
הפונקציה יוצרת location חדש בבעלות החשבון שצוין ומחזירה אותו.
delete DELETE /v4/{name=accounts/*/locations/*}
מוחק מיקום.
fetchVerificationOptions POST /v4/{name=accounts/*/locations/*}:fetchVerificationOptions
כולל דיווח על כל אפשרויות האימות המתאימות למיקום בשפה מסוימת.
findMatches POST /v4/{name=accounts/*/locations/*}:findMatches
הפונקציה מחפשת את כל המיקומים האפשריים שתואמים למיקום שצוין.
get GET /v4/{name=accounts/*/locations/*}
הפונקציה מקבלת את המיקום שצוין.
getFoodMenus GET /v4/{name=accounts/*/locations/*/foodMenus}
מחזירה את תפריטי האוכל של מיקום ספציפי.
getGoogleUpdated GET /v4/{name=accounts/*/locations/*}:googleUpdated
קבלת הגרסה המעודכנת של Google של המיקום שצוין.
getHealthProviderAttributes GET /v4/{name=accounts/*/locations/*/healthProviderAttributes}
מחזירה את המאפיינים של ספק שירותי הבריאות של מיקום ספציפי.
getServiceList GET /v4/{name=accounts/*/locations/*/serviceList}
קבלת רשימת השירותים שצוינה עבור מיקום מסוים.
list GET /v4/{parent=accounts/*}/locations
מציג את המיקומים של החשבון שצוין.
patch PATCH /v4/{name=accounts/*/locations/*}
עדכון המיקום שצוין.
reportInsights POST /v4/{name=accounts/*}/locations:reportInsights
מחזיר דוח עם תובנות על מדד אחד או יותר לפי מיקום.
transfer
(deprecated)		 POST /v4/{name=accounts/*/locations/*}:transfer
מעביר מיקום מחשבון שבבעלות המשתמש לחשבון אחר שאותו המשתמש מנהל.
updateFoodMenus PATCH /v4/{foodMenus.name=accounts/*/locations/*/foodMenus}
עדכון תפריטי האוכל של מיקום ספציפי.
updateHealthProviderAttributes PATCH /v4/{healthProviderAttributes.name=accounts/*/locations/*/healthProviderAttributes}
עדכון המאפיינים של ספק שירותי הבריאות במיקום ספציפי.
updateServiceList PATCH /v4/{serviceList.name=accounts/*/locations/*/serviceList}
עדכון רשימת השירותים שצוינה עבור מיקום מסוים.
verify POST /v4/{name=accounts/*/locations/*}:verify
מתחיל תהליך האימות של מיקום.

משאב REST: v4.accounts.locations.admins

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

משאב ל-REST: v4.accounts.locations.followers

שיטות
getMetadata GET /v4/{name=accounts/*/locations/*/followers/metadata}
הצגת ההגדרות של העוקבים לגבי מיקום מסוים.

מקור מידע ל-REST: v4.accounts.locations.insuranceNetworks

שיטות
list GET /v4/{parent=accounts/*/locations/*}/insuranceNetworks
מחזירה רשימה של כל חברות הביטוח הנתמכות על ידי Google.

משאב REST: v4.accounts.locations.localPosts

שיטות
create POST /v4/{parent=accounts/*/locations/*}/localPosts
יוצרת פוסט מקומי חדש שמשויך למיקום שצוין ומחזירה אותו.
delete DELETE /v4/{name=accounts/*/locations/*/localPosts/*}
מחיקת פוסט מקומי.
get GET /v4/{name=accounts/*/locations/*/localPosts/*}
הפונקציה מקבלת את הפוסט המקומי שצוין.
list GET /v4/{parent=accounts/*/locations/*}/localPosts
מחזירה רשימה של פוסטים מקומיים המשויכים למיקום מסוים.
patch PATCH /v4/{name=accounts/*/locations/*/localPosts/*}
מעדכנת את הפוסט המקומי שצוין ומחזירה את הפוסט המקומי המעודכן.
reportInsights POST /v4/{name=accounts/*/locations/*}/localPosts:reportInsights
מחזיר תובנות לגבי קבוצה של פוסטים מקומיים המשויכים לדף אפליקציה אחד.

משאב REST: v4.accounts.locations.media

שיטות
create POST /v4/{parent=accounts/*/locations/*}/media
יצירת פריט מדיה חדש למיקום.
delete DELETE /v4/{name=accounts/*/locations/*/media/*}
מחיקת פריט המדיה שצוין.
get הפונקציה GET /v4/{name=accounts/*/locations/*/media/*}
מחזירה מטא-נתונים של פריט המדיה המבוקש.
list GET /v4/{parent=accounts/*/locations/*}/media
מחזירה רשימה של פריטי מדיה שמשויכים למיקום מסוים.
patch PATCH /v4/{name=accounts/*/locations/*/media/*}
עדכון המטא-נתונים של פריט המדיה שצוין.
startUpload POST /v4/{parent=accounts/*/locations/*}/media:startUpload
הפונקציה יוצרת MediaItemDataRef להעלאת פריט מדיה.

משאב REST: v4.accounts.locations.media.customers

שיטות
get GET /v4/{name=accounts/*/locations/*/media/customers/*}
מחזיר מטא-נתונים של פריט המדיה המבוקש של הלקוח.
list GET /v4/{parent=accounts/*/locations/*}/media/customers
מחזירה רשימה של פריטי מדיה שמשויכים למיקום שנוסף על ידי לקוחות.

משאב REST: v4.accounts.locations.questions

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

משאב REST: v4.accounts.locations.questions.answers

שיטות
delete DELETE /v4/{parent=accounts/*/locations/*/questions/*}/answers:delete
מחיקת התשובה שכתב המשתמש הנוכחי לשאלה.
list GET /v4/{parent=accounts/*/locations/*/questions/*}/answers
מחזירה את רשימת התשובות המעומדת לשאלה שצוינה.
upsert POST /v4/{parent=accounts/*/locations/*/questions/*}/answers:upsert
ההגדרה הזו יוצרת תשובה או מעדכנת את התשובה הקיימת שהמשתמש כתב לשאלה שצוינה.

משאב REST: v4.accounts.locations.reviews

שיטות
deleteReply DELETE /v4/{name=accounts/*/locations/*/reviews/*}/reply
מחיקת התגובה לביקורת שצוינה.
get GET /v4/{name=accounts/*/locations/*/reviews/*}
מחזירה את הביקורת שצוינה.
list GET /v4/{parent=accounts/*/locations/*}/reviews
מחזירה רשימה מעומדת של ביקורות עבור המיקום שצוין.
updateReply PUT /v4/{name=accounts/*/locations/*/reviews/*}/reply
התשובה תעודכן לביקורת שצוינה.

משאב REST: v4.accounts.locations.verifications

שיטות
complete POST /v4/{name=accounts/*/locations/*/verifications/*}:complete
ישלים אימות של PENDING.
list GET /v4/{parent=accounts/*/locations/*}/verifications
רשימת האימותים של מיקום, מסודרת לפי מועד היצירה.

משאב REST: v4.attributes

שיטות
list GET /v4/attributes
מחזירה את רשימת המאפיינים הזמינים שיהיו זמינים למיקום עם הקטגוריה הראשית והמדינה שצוינו.

משאב ל-REST: v4.categories

שיטות
batchGet GET /v4/categories:batchGet
מחזירה רשימה של קטגוריות עסקיות עבור השפה ומזהי GConcept שצוינו.
list הפונקציה GET /v4/categories
מחזירה רשימה של קטגוריות של עסקים.

משאב REST: v4.chains

שיטות
get GET /v4/{name=chains/*}
הפונקציה מקבלת את השרשרת שצוינה.
search GET /v4/chains:search
מחפשת את הרשת לפי שם הרשת.

משאב ל-REST: v4.googleLocations

שיטות
report POST /v4/{name=googleLocations/*}:report
דיווח על GoogleLocation.
search POST /v4/googleLocations:search
יש לחפש בכל המיקומים האפשריים שתואמים לבקשה שצוינה.

שירות: mybusiness.googleapis.com

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

מסמך Discovery

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

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

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

  • https://mybusiness.googleapis.com

משאב REST: v1.media

שיטות
upload POST /v1/media/{resourceName=**}
POST /upload/v1/media/{resourceName=**}
מתבצעת העלאה של מדיה.