ב-My Business Notifications API, ההתראות מתפרסמות בשירות Cloud Pub/Sub. אחרי שמגדירים את Cloud Pub/Sub ויוצרים נושא, אפשר לבצע את הפעולות הבאות על ההתראות:
אפשר לשלוח ביקורות חדשות או מעודכנות, שאלות ותשובות, העלאות מדיה, עדכונים מ-Google לבדיקה, שינויים במצב המיקום ועוד. האובייקט NotificationType מציג ומתאר את סוגי ההתראות הזמינים.
לפני שמתחילים
כדי להשתמש ב-My Business Notifications API, צריך לרשום את האפליקציה ולקבל פרטי כניסה ל-OAuth 2.0. במאמר הגדרה בסיסית מוסבר איך מתחילים להשתמש ב-API.
הגדרת Cloud Pub/Sub
כדי להגדיר התראות API באמצעות Cloud Pub/Sub:
- פועלים לפי המדריך של Cloud Pub/Sub כדי להגדיר את האפליקציה.
- יוצרים נושא בפרויקט Cloud Pub/Sub ומתעדים את השם של הנושא שנוצר.
- מעניקים לפחות את ההרשאות
pubsub.topics.publish
ל-mybusiness-api-pubsub@system.gserviceaccount.com. - כדי להגדיר התראות מסוג 'דחיפה' או 'משיכה', פועלים לפי ההוראות במדריך סקירה כללית על מנויים.
- כדי לקבל התראות, צריך לבצע קריאה לנקודת הקצה
accounts.updateNotificationSetting
ב-My Business Notifications API. בשיחה, משתמשים בשם הנושא שיצרתם ב-Cloud Pub/Sub כדי לקשר את החשבון בפרופיל העסק לנושא. - (אופציונלי) חוזרים על שלב 5 לכל חשבון של פרופיל העסק שרוצים לקבל התראות לגביה.
אחזור הגדרות ההתראות
נקודת הקצה accounts.getNotificationSetting
מחזירה את הגדרות ההתראות הנוכחיות של Cloud Pub/Sub בחשבון. בטבלה הבאה מוסבר איך להפעיל אותה:
GET https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
עדכון של הגדרת ההתראות
נקודת הקצה accounts.updateNotificationSetting
מעדכנת את הגדרות ההתראות של Cloud Pub/Sub שמשויכות לחשבון. בטבלה הבאה מוסבר איך להפעיל אותו:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate} { pubsubTopic: your/pubsub/topicName }
מחיקת הגדרות ההתראות
קריאה לפונקציה accounts.updateNotificationSetting
עם pubsubTopic
ריק מוחקת את הגדרות ההתראות של Cloud Pub/Sub מהחשבון.
בטבלה הבאה מוסבר איך להפעיל אותו:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic