Business Communications

שירות: businesscommunications.googleapis.com

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

מסמך Discovery

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

• https://businesscommunications.googleapis.com/$discovery/rest?version=v1

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

נקודת קצה (endpoint) היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. בשירות אחד יכולות להיות כמה נקודות קצה בשירות. לשירות הזה יש את נקודת הקצה הבאה לכל שירות, וכל מזהי ה-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.surveyQuestions

שיטות
list	GET /v1/surveyQuestions רשימה של כל השאלות בסקרים שהוגדרו מראש על ידי Google.