Method: brands.agents.requestLaunch

מתחילים את תהליך ההשקה של סוכן. נציג זמין למשתמשים אחרי שהוא מופעל. לכל סוכן יכולה להיות רק הפעלה אחת בכל זמן נתון.

בקשת HTTP

POST https://businesscommunications.googleapis.com/v1/{name=brands/*/agents/*}:requestLaunch

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
name

string

חובה. המזהה הייחודי של הסוכן. אם מזהה המותג הוא '1234' ומזהה הסוכן הוא '5678', הפרמטר הזה יומר לערך 'brands/1234/agents/5678'.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "agentLaunch": {
    object (AgentLaunch)
  }
}
שדות
agentLaunch

object (AgentLaunch)

חובה. הסוכן יופעל כדי ליצור. המערכת מתעלמת מהשם ומסטטוס ההשקה.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של AgentLaunch.

היקפי הרשאה

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/businesscommunications

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.