שירות: businesscommunications.googleapis.com
כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, השתמשו במידע הבא כשתשלחו את בקשות ה-API.
מסמך הגילוי
מסמך Discovery הוא מפרט קריא למחשבים לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין בסביבת פיתוח משולבת (IDE) וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:
נקודת קצה בשירות
נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה (endpoints) של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:
https://businesscommunications.googleapis.com
משאב REST: v1.brands
שיטות | |
---|---|
create |
POST /v1/brands יצירת מותג חדש. |
delete |
DELETE /v1/{name=brands/*} מחיקת המותג מתבצעת. |
get |
GET /v1/{name=brands/*} קבלת מידע על מותג מסוים. |
list |
GET /v1/brands בתיבת הדו-שיח הזו מפורטים כל המותגים שנגישים למשתמש ששלח את הבקשה. |
patch |
PATCH /v1/{brand.name=brands/*} עדכון מידע לגבי מותג. |
משאב REST: v1.brands.agents
שיטות | |
---|---|
create |
POST /v1/{parent=brands/*}/agents יצירת נציג חדש לייצוג מותג. |
delete |
DELETE /v1/{name=brands/*/agents/*} הוצאה משימוש: מחיקת הנציג הוצאה משימוש. |
get |
GET /v1/{name=brands/*/agents/*} קבלת מידע על נציג תמיכה. |
getLaunch |
GET /v1/{name=brands/*/agents/*/launch} מקבלת את פרטי ההפעלה של הנציג. |
getVerification |
GET /v1/{name=brands/*/agents/*/verification} מקבלת את פרטי האימות של נציג התמיכה. |
list |
GET /v1/{parent=brands/*}/agents בתיבת הדו-שיח הזו מפורטים כל הנציגים שמשויכים למותג מסוים. |
patch |
PATCH /v1/{agent.name=brands/*/agents/*} עדכון המידע לגבי הנציג. |
requestLaunch |
POST /v1/{name=brands/*/agents/*}:requestLaunch התחלת תהליך ההפעלה של נציג. |
requestVerification |
POST /v1/{name=brands/*/agents/*}:requestVerification מתחיל אימות הפרטים העסקיים של נציג. |
updateLaunch |
PATCH /v1/{agentLaunch.name=brands/*/agents/*/launch} פרטי ההפעלה של הנציג יעודכנו. |
updateVerification |
PATCH /v1/{agentVerification.name=brands/*/agents/*/verification} סטטוס האימות של הנציג יתעדכן. |
משאב REST: v1.brands.agents.integrations
שיטות | |
---|---|
create |
POST /v1/{parent=brands/*/agents/*}/integrations יצירת שילוב. |
delete |
DELETE /v1/{name=brands/*/agents/*/integrations/*} מחיקת שילוב. |
get |
GET /v1/{name=brands/*/agents/*/integrations/*} קבלת שילוב. |
list |
GET /v1/{parent=brands/*/agents/*}/integrations הצגת רשימה של שילובים. |
patch |
PATCH /v1/{integration.name=brands/*/agents/*/integrations/*} מעדכנים שילוב. |
משאב REST: v1.brands.locations
שיטות | |
---|---|
create |
POST /v1/{parent=brands/*}/locations יצירת מיקום חדש למותג. |
delete |
DELETE /v1/{name=brands/*/locations/*} מוחק מיקום. |
get |
GET /v1/{name=brands/*/locations/*} קבלת מידע על מיקום מסוים. |
getLaunch |
GET /v1/{name=brands/*/locations/*/launch} מקבלת את פרטי ההפעלה של מיקום. |
getVerification |
GET /v1/{name=brands/*/locations/*/verification} מקבלת את פרטי האימות של מיקום. |
list |
GET /v1/{parent=brands/*}/locations בתיבת הדו-שיח הזו מפורטים כל המיקומים של המותג. |
patch |
PATCH /v1/{location.name=brands/*/locations/*} עדכון מידע לגבי מיקום. |
requestLaunch |
POST /v1/{name=brands/*/locations/*}:requestLaunch מתחיל את תהליך ההשקה של מיקום. |
requestVerification |
POST /v1/{name=brands/*/locations/*}:requestVerification מתחיל תהליך אימות של מיקום. |
updateLaunch |
PATCH /v1/{locationLaunch.name=brands/*/locations/*/launch} עדכון פרטי ההפעלה של מיקום מסוים. |
משאב REST: v1.partners
שיטות | |
---|---|
get |
GET /v1/{name=partners/*} לקבלת המידע על השותף. |
patch |
PATCH /v1/{partner.name=partners/*} עדכון המידע עבור השותף. |
משאב REST: v1.regions
שיטות | |
---|---|
list |
GET /v1/regions רשומים כל האזורים של RCS Business Messaging. |
משאב REST: v1.surveyQuestions
שיטות | |
---|---|
list |
GET /v1/surveyQuestions בתיבת הדו-שיח הזו מפורטות כל השאלות הסקר המוגדרות מראש של Google. |