REST Resource: brands.agents.integrations

משאב: אינטגרציה

מידע על השילוב.

ייצוג JSON 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // End of list of possible types for union field integration_info.
}
שדות
name

string

פלט בלבד. המזהה הייחודי של השילוב. קריאה בלבד. מוגדר על ידי הפלטפורמה.
status

enum (IntegrationStatus)

פלט בלבד. סטטוס השילוב.
שדה איחוד integration_info. מידע מפורט על השילוב. integration_info יכול להיות רק אחד מהבאים:
dialogflowEsIntegration

object (DialogflowEsIntegration)

מידע על פרויקט משויך ב-Dialogflow ES. https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

מידע על פרויקט משויך של Dialogflow CX. https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

מידע על התגובה לפעולה מאתר אחר (webhook) של נציג. אם ה-webhook מוגדר ברמת הנציג, הוא יחליף את התגובה לפעולה מאתר אחר ברמת השותף.

IntegrationStatus

סטטוסים של שילוב.

טיפוסים בני מנייה (enums)
INTEGRATION_STATUS_UNSPECIFIED סטטוס השילוב לא צוין.
ENABLED מופעל.
DISABLED מושבת.

DialogflowEsIntegration

מידע על נציג של Business Messages ועל שיוך לפרויקט Dialogflow ES.

ייצוג JSON 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
שדות
dialogflowProjectId

string

חובה. מזהה הפרויקט ב-Dialogflow.

לא ניתן לערוך אותו. כדי לשנות את הערך הזה, צריך למחוק את הפרויקט ב-Dialogflow מהסוכן הזה, ואז ליצור שילוב חדש.
autoResponseStatus

enum (AutoResponseStatus)

חובה. אם בוחרים באפשרות ENABLED, התשובות של Dialogflow יישלחו למשתמשים באופן אוטומטי על ידי Business Messages.
dialogflowServiceAccountEmail

string

פלט בלבד. חשבון השירות שצריך להגדיר בפרויקט Dialogflow עם התפקידים 'Dialogflow Console Agent Editor' ו-'Dialogflow API Client'. ההרשאה הזו נדרשת כדי לתת גישה ל-Dialogflow API.
operationInfo

object (OperationInfo)

פלט בלבד. מידע על מצב ההפעלה של השילוב עם Dialogflow.
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

מאגרי ידע שמשויכים לפרויקט Dialogflow.

אופציונלי

AutoResponseStatus

סטטוס התשובה האוטומטית של Dialogflow.

טיפוסים בני מנייה (enums)
AUTO_RESPONSE_STATUS_UNSPECIFIED לא צוינה תשובה אוטומטית.
ENABLED התשובה האוטומטית מופעלת.
DISABLED התשובה האוטומטית מושבתת.

OperationInfo

פרטי הפעולה ב-Dialogflow.

ייצוג JSON 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
שדות
operationName

string

פלט בלבד. השם שהוקצה על ידי השרת (מזהה פעולה), שהוא ייחודי רק בתוך אותו שירות שמחזיר אותו במקור.
operationType

enum (OperationType)

פלט בלבד. סוג הפעולה ב-Dialogflow.
operationState

enum (OperationState)

פלט בלבד. מצב הפעולה ב-Dialogflow.
error

object (Status)

פלט בלבד. תוצאת השגיאה, אם יש כזו.

OperationType

סוגי הפעולות של Dialogflow.

טיפוסים בני מנייה (enums)
OPERATION_TYPE_UNSPECIFIED הסוג לא צוין.
ASSOCIATE_DIALOGFLOW שיוך Dialogflow.
DISSOCIATE_DIALOGFLOW ביטול השיוך של Dialogflow.
ADD_DOCUMENT_TO_KNOWLEDGEBASE הוספת מסמך למאגר הידע.
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE מחיקת מסמך ממאגר ידע.

OperationState

סטטוסים של פעולות ב-Dialogflow.

טיפוסים בני מנייה (enums)
OPERATION_STATE_UNSPECIFIED המצב לא צוין.
PROCESSING מתבצע עיבוד.
COMPLETED הפעולה הושלמה.
FAILED הפעולה נכשלה.

סטטוס

בסוג Status מוגדר מודל שגיאה לוגית שמתאים לסביבות תכנות שונות, כולל ממשקי REST API ו-RPC API. הפרמטר הזה משמש את gRPC. כל הודעת Status מכילה שלושה נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

במדריך לעיצוב API מפורט מידע נוסף על מודל השגיאה הזה והסבר איך להשתמש בו.

ייצוג JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך 'טיפוסים בני מנייה (enum)' של google.rpc.Code.
message

string

הודעת שגיאה למפתחים, שאמורה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה לעבור לוקליזציה ולשלוח בשדה google.rpc.Status.details, או להתאים אותן לשוק המקומי על ידי הלקוח.
details[]

object

רשימה של הודעות שמציגות את פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות בממשקי API שבהם אפשר להשתמש.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI המזהה את הסוג. לדוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }.

DialogflowKnowledgebase

מידע ממאגר ידע. למאגר ידע יכולות להיות כמה כתובות URL של שאלות נפוצות.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
שדות
name

string

פלט בלבד. מזהה של מאגר ידע.

מזהה ייחודי שהוחזר על ידי שירות Dialogflow אחרי היצירה של מאגר ידע. אם מזהה המותג הוא '1234', מזהה הסוכן הוא '5678', מזהה השילוב הוא '9092' ומזהה מאגר הידע הוא '1111', הפרמטר הזה מקבל את הערך 'brands/1234/agents/5678/integrations/9092/knowledgebases/1111'.
displayName

string

חובה. השם המוצג של מאגר הידע.
documents[]

object (DialogflowDocument)

מסמכים של מאגר ידע.

אופציונלי
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה מאגר הידע נוצר או עודכן.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

DialogflowDocument

מסמך של מאגר ידע. מסמך יכול להיות כתובת אתר או כתובת URL של קובץ CSV. כתובות ה-URL חייבות להיות זמינות לציבור. קובצי CSV צריכים להכיל צמד אחד או יותר של שאלה/תשובה, עם שורה אחת לכל צמד.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
שדות
name

string

מזהה מסמך שנוצר על ידי המערכת.

אם מזהה המותג הוא 1234, מזהה הסוכן הוא '5678', מזהה השילוב הוא '9092', המזהה של מאגר הידע הוא '1111' ומזהה המסמך הוא '2222', הפרמטר הזה הוא 'brands/1234/agents/5678/integrations/9092/k121base2base2'
displayName

string

חובה. השם המוצג של מסמך השאלות הנפוצות.
updateTime

string (Timestamp format)

פלט בלבד. השעה שבה המסמך נוצר/עודכן.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
operationInfo

object (OperationInfo)

פלט בלבד. פרטי הפעולה מאוכלסים רק כשמוסיפים מסמך למאגר ידע קיים.
שדה איחוד content. תוכן המסמך. content יכול להיות רק אחד מהבאים:
faqUrl

string

כתובת URL של מסמך שאלות נפוצות.
rawContent

string (bytes format)

התוכן הגולמי של המסמך.

מחרוזת בקידוד base64.

DialogflowCxIntegration

מידע על נציג של Business Messages ועל שיוך לפרויקט CX ב-Dialogflow.

ייצוג JSON 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
שדות
dialogflowProjectId

string

חובה. מזהה הפרויקט ב-Dialogflow.

לא ניתן לערוך אותו. כדי לשנות את הערך הזה, צריך למחוק את הפרויקט ב-Dialogflow מהסוכן הזה, ואז ליצור שילוב חדש.
dialogflowAgentId

string

חובה. מזהה הסוכן ב-Dialogflow.
autoResponseStatus

enum (AutoResponseStatus)

חובה. אם בוחרים באפשרות ENABLED, התשובות של Dialogflow יישלחו למשתמשים באופן אוטומטי על ידי Business Messages.
dialogflowServiceAccountEmail

string

פלט בלבד. חשבון השירות שצריך להגדיר בפרויקט Dialogflow עם התפקידים 'Dialogflow Console Agent Editor' ו-'Dialogflow API Client'. ההרשאה הזו נדרשת כדי לתת גישה ל-Dialogflow API.
operationInfo

object (OperationInfo)

פלט בלבד. מידע על מצב ההפעלה של השילוב עם Dialogflow.

AgentWebhookIntegration

מידע על התגובה לפעולה מאתר אחר (webhook) לנציג של Business Messages.

ייצוג JSON 
{
  "webhookUri": string,
  "verificationToken": string
}
שדות
webhookUri

string

חובה. ה-webhook URL שאליו ההודעות יועברו.
verificationToken

string

קלט בלבד. אסימון האימות

שיטות

create

 יוצרים שילוב.

delete

 מחיקת שילוב.

get

 מקבלים שילוב.

list

 הצגת רשימה של שילובים.

patch

 מעדכנים שילוב.