REST Resource: projects.chatAppConfig

משאב: ChatAppConfig

מייצג את ההגדרות האישיות של אפליקציית Google Chat שנוצרה כתוסף ל-Google Workspace.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
שדות
name

string

חובה. מזהה. שם המשאב של הגדרת האפליקציה ל-Chat.

פורמט: projects/{project}/chatAppConfig, כאשר {project} הוא מספר הפרויקט בענן.
displayName

string

חובה. השם המוצג של אפליקציית הצ'אט. האורך צריך להיות בין 3 ל-25 תווים.
description

string

חובה. תיאור קצר של האפליקציה ל-Chat, באורך של 1 עד 40 תווים.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

אופציונלי. ההגדרות של התכונות האינטראקטיביות של האפליקציה. אם לא מגדירים את התכונות האלה, האפליקציה לא תהיה אינטראקטיבית, כלומר היא תוכל להשתמש ב-Chat API, אבל המשתמשים לא יוכלו לבצע פעולות באפליקציה.
avatarUri

string

אופציונלי. כתובת ה-URL של תמונת הדמות של האפליקציה. זו צריכה להיות כתובת URL מסוג HTTPS שמארחת תמונת PNG ריבועית (יחס גובה-רוחב של 1:1). גודל מינימלי מומלץ: 256 על 256 פיקסלים. אם לא תציינו דמות, המערכת תשתמש בדמות ברירת המחדל של האפליקציה.
state

enum (AppState)

אופציונלי. מצב האפליקציה. אם לא צוין, ברירת המחדל היא ACTIVE.
errorLoggingEnabled

boolean

אופציונלי. אם לרשום שגיאות ב-Cloud Logging. אם לא מגדירים ערך לפרמטר הזה, ערך ברירת המחדל שלו הוא false.
markupSyntax

enum (MarkupSyntax)

אופציונלי. תחביר ברירת המחדל של תגי העיצוב להודעות שנשלחות או נקראות על ידי אפליקציית Chat הזו. אם לא צוין אחרת, ברירת המחדל היא MARKUP_SYNTAX_MARKDOWN.

AppState

המצב הנוכחי של אפליקציית הצ'אט.

טיפוסים בני מנייה (enum)
APP_STATE_UNSPECIFIED ערך ברירת המחדל. לא צוין.
ACTIVE ממופה ל-LIVE בדף ההגדרות של Chat API. האפליקציה פעילה, ואנשים עם הרשאות גישה יכולים למצוא אותה ולהשתמש בה.
DISABLED האפליקציה מושבתת, אף אחד לא יכול למצוא אותה או לדבר איתה.

InteractiveFeatureConfig

הגדרות התכונות האינטראקטיביות של האפליקציה.

ייצוג ב-JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
שדות
connectionConfig

object (ConnectionConfig)

חובה. איך האפליקציה מקבלת אירועים מ-Google Chat.
appCommands[]

object (AppCommand)

אופציונלי. הגדרת פקודות לאפליקציות.
urlPatterns[]

object (UrlPattern)

אופציונלי. הגדרות לתצוגה מקדימה של קישורים.
allowlistedTestingPrincipals[]

string

אופציונלי. כתובות האימייל של המשתמשים והקבוצות בדומיין שלכם ב-Google Workspace שיכולים למצוא את האפליקציה ולהשתמש בה.
supportsMultiuserSpaces

boolean

אופציונלי. אם אפשר להוסיף את האפליקציה לצ'אטים אישיים, לצ'אטים קבוצתיים ולמרחבים משותפים. אם לא מגדירים ערך לפרמטר הזה, ערך ברירת המחדל שלו הוא false.

ConnectionConfig

איך האפליקציה מקבלת אירועים.

ייצוג ב-JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
שדות
סוג החיבור. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
httpEndpointConfig

object (HttpEndpointConfig)

הגדרת נקודת קצה (endpoint) ב-HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

הגדרת הפריסה של Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

הגדרת נושא Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

הגדרת Dialogflow.
סוף השדות שמוציאים זה את זה.

HttpEndpointConfig

הגדרת נקודת קצה (endpoint) ב-HTTP.

ייצוג ב-JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
שדות
הגדרת כתובת ה-URL של נקודת הקצה (endpoint) בפרוטוקול HTTP. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
commonUrl

string

אופציונלי. כתובת ה-URL מסוג HTTPS שאליה Google Chat שולח את כל האירועים האינטראקטיביים.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

אופציונלי. כתובות URL נפרדות מסוג HTTPS שאליהן Google Chat שולח כל סוג של אירוע אינטראקטיבי.
סוף השדות שמוציאים זה את זה.

HttpPerEventEndpointConfig

הגדרת נקודת קצה (endpoint) של HTTP לסוגי אירועים ספציפיים.

ייצוג ב-JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
שדות
appCommandEndpoint

string

חובה. נקודת קצה של כתובת URL מסוג HTTPS לאירועים של פקודות באפליקציה.
addedToSpaceEndpoint

string

חובה. נקודת קצה של כתובת URL מסוג HTTPS לאירועים של הוספה למרחב משותף.
messageEndpoint

string

חובה. נקודת קצה (endpoint) של כתובת URL מסוג HTTPS לאירועי הודעות.
removedFromSpaceEndpoint

string

חובה. נקודת קצה של כתובת URL מסוג HTTPS לאירועים של הסרה ממרחב משותף.

AppsScriptEndpointConfig

הגדרת נקודת קצה (endpoint) ב-Apps Script.

ייצוג ב-JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
שדות
deploymentId

string

חובה. מזהה הפריסה של Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

אופציונלי. השמות של הפונקציות ב-Apps Script ש-Google Chat מפעיל לכל סוג של אירוע אינטראקטיבי. אם לא מציינים פונקציה, Chat קורא לפונקציית ברירת המחדל של כל סוג אירוע.

AppsScriptPerEventEndpointConfig

הגדרת נקודת קצה ב-Apps Script לסוגי אירועים ספציפיים.

ייצוג ב-JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
שדות
appCommandEndpoint

string

אופציונלי. שם הפונקציה של אירועי פקודות באפליקציה. אם לא תציינו שם, המערכת תשתמש בשם ברירת המחדל של הפונקציה onAppCommand.
addedToSpaceEndpoint

string

אופציונלי. שם הפונקציה לאירועים של הוספה למרחב. אם לא תציינו שם, המערכת תשתמש בשם ברירת המחדל של הפונקציה onAddedToSpace.
messageEndpoint

string

אופציונלי. שם הפונקציה לאירועי הודעות. אם לא תציינו שם, המערכת תשתמש בשם ברירת המחדל של הפונקציה onMessage.
removedFromSpaceEndpoint

string

אופציונלי. שם הפונקציה לאירועים של הסרה ממרחב משותף. אם לא תציינו שם, המערכת תשתמש בשם ברירת המחדל של הפונקציה onRemovedFromSpace.

CloudPubSubEndpointConfig

הגדרת נקודת הקצה של Pub/Sub.

ייצוג ב-JSON 
{
  "topic": string
}
שדות
topic

string

חובה. נושא Pub/Sub שבו Google Chat מפרסם את כל האירועים האינטראקטיביים. הנושא צריך להיות באותו פרויקט בענן כמו האפליקציה, ול-Chat צריכה להיות הרשאה לפרסם הודעות בנושא. פרטים נוספים מופיעים במאמר פיתוח אפליקציה ל-Google Chat באמצעות Pub/Sub.

פורמט: projects/{project}/topics/{topic}

DialogflowEndpointConfig

הגדרת נקודת הקצה של Dialogflow.

ייצוג ב-JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
שדות
dialogflowEdition

enum (DialogflowEdition)

חובה. מהדורת Dialogflow.
agent

string

אופציונלי. השם של הסוכן או הסביבה ב-Dialogflow CX. חובה ב-Dialogflow CX. אל תגדירו את זה ב-Dialogflow ES.

פורמט: projects/{project}/locations/{location}/agents/{agent} או projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

סוג המהדורה של Dialogflow.

טיפוסים בני מנייה (enum)
DIALOGFLOW_EDITION_UNSPECIFIED ערך ברירת המחדל. לא צוין.
ES מהדורת Dialogflow ES. כדי להשתמש במהדורה הזו, צריך להיות נציג Dialogflow ES באותו פרויקט בענן של Google שבו נמצאת האפליקציה. Google Chat שולח את כל האירועים האינטראקטיביים לנציג הזה.
CX מהדורת Dialogflow CX. כדי להשתמש במהדורה הזו, צריך להיות סוכן Dialogflow CX באותו פרויקט ב-Google Cloud שבו נמצאת האפליקציה, והוא צריך להיות מצוין בשדה agent. מערכת Google Chat שולחת את כל האירועים האינטראקטיביים לנציג הזה.

AppCommand

הגדרה של פקודת אפליקציה.

ייצוג ב-JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
שדות
commandType

enum (CommandType)

חובה. סוג הפקודה.
commandId

integer

חובה. מזהה הפקודה (1-1000). המזהה חייב להיות ייחודי באפליקציה.
command

string

אופציונלי. שם הפקודה. חובה להגדיר את השדה הזה לפקודות מסוג SLASH_COMMAND, אבל לא לפקודות מסוגים אחרים. הפקודה חייבת להתחיל בלוכסן, למשל "‎/command".
displayName

string

אופציונלי. השם המוצג ידידותי למשתמש של הפקודה. חובה להגדיר את השדה הזה ל-MESSAGE_ACTION ול-QUICK_COMMAND, אבל לא ל-SLASH_COMMAND.
description

string

חובה. תיאור קצר של הפקודה.
dialogEnabled

boolean

אופציונלי. אם הפקודה הזו צריכה להפעיל תיבת דו-שיח. אם לא מציינים ערך, ברירת המחדל היא false.
loadingNotificationMessage

string

אופציונלי. התראה שתישלח למשתמש כשהוא יפעיל את פעולת ההודעה. נתמך רק בפקודות MESSAGE_ACTION.

CommandType

סוג הפקודה באפליקציה.

טיפוסים בני מנייה (enum)
COMMAND_TYPE_UNSPECIFIED ערך ברירת המחדל. לא צוין.
SLASH_COMMAND פקודה שמופעלת על ידי הקלדת "/" ואחריו שם הפקודה. הוא יכול לקבל ארגומנטים נוספים בטקסט של ההודעה.
QUICK_COMMAND פקודה מהירה שמופעלת מתפריט ההקשר של כתיבת ההודעה. אי אפשר להוסיף ארגומנטים לפקודות מהירות.
MESSAGE_ACTION פקודה שמופעלת מתפריט ההקשר של ההודעה.

UrlPattern

הגדרה של תצוגה מקדימה של קישור.

ייצוג ב-JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
שדות
hostPattern

string

חובה. הדומיין שצריך להתאים. כדי להתאים לתת-דומיין ספציפי, כמו "subdomain.example.com", או לדומיין שלם, צריך להוסיף כוכבית (*) בתחילת הכתובת כתו כללי לחיפוש. לדוגמה, "‎*.example.com" תואם ל-"https://subdomain.example.com" ול-"https://any.number.of.subdomains.example.com".
pathPrefix

string

אופציונלי. תחילית הנתיב שמתווספת לתבנית המארח. אם השדה ריק, תהיה התאמה לכל כתובות ה-URL בתבנית המארח. לדוגמה, בשילוב עם תבנית המארח "subdomain.example.com", מציינים את "path/‎" כדי להתאים לכתובות URL של דפים שמתחילות ב-"https://subdomain.example.com/path/‎".

MarkupSyntax

תחביר תגי העיצוב שמשמש לעיצוב הטקסט של ההודעות באפליקציה הזו ל-Chat.

טיפוסים בני מנייה (enum)
MARKUP_SYNTAX_UNSPECIFIED ערך ברירת המחדל. לא צוין. לאפליקציות Chat קיימות שנוצרו לפני שהושקה הגרסה markup_syntax יש את הערך הזה, והן משתמשות ב-MARKUP_SYNTAX_CHAT עד שהן מתעדכנות באופן מפורש.
MARKUP_SYNTAX_CHAT משתמש בתחביר של תגי עיצוב ב-Google Chat. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts.
MARKUP_SYNTAX_MARKDOWN משתמש בתחביר Markdown. התחביר הזה מבוסס על המפרט של CommonMark, עם תוספות. מידע נוסף זמין בכתובת https://developers.google.com/workspace/chat/format-messages#format-texts.

Methods

get

 אחזור ההגדרות האישיות של אפליקציית הצ'אט בפרויקט.

patch

 עדכון ההגדרות האישיות של אפליקציית Chat בפרויקט.