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} คือหมายเลขโปรเจ็กต์ Google Cloud
displayName

string

ต้องระบุ ชื่อที่แสดงของแอปใน Chat ความยาวควรอยู่ระหว่าง 3 ถึง 25 อักขระ
description

string

ต้องระบุ คำอธิบายสั้นๆ ของแอปใน Chat ควรมีความยาวระหว่าง 1 ถึง 40 อักขระ
interactiveFeatureConfig

object (InteractiveFeatureConfig)

ไม่บังคับ การตั้งค่าสำหรับฟีเจอร์แบบอินเทอร์แอกทีฟของแอป หากไม่ได้ระบุไว้ แอปจะเป็นแบบไม่โต้ตอบ ซึ่งหมายความว่าแอปจะใช้ Chat API ได้ แต่ผู้ใช้จะโต้ตอบกับแอปไม่ได้
avatarUri

string

ไม่บังคับ URL ของรูปภาพโปรไฟล์ของแอป ต้องเป็น HTTPS URL ที่โฮสต์รูปภาพ PNG สี่เหลี่ยมจัตุรัส (สัดส่วนภาพ 1:1) ขนาดขั้นต่ำที่แนะนำ: 256 x 256 พิกเซล ระบบจะใช้รูปโปรไฟล์แอปเริ่มต้นหากไม่ได้ระบุไว้
state

enum (AppState)

ไม่บังคับ สถานะของแอป ค่าเริ่มต้นจะเป็น ACTIVE หากไม่ได้ระบุไว้
errorLoggingEnabled

boolean

ไม่บังคับ เลือกว่าจะบันทึกข้อผิดพลาดไปยัง Cloud Logging หรือไม่ ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้
markupSyntax

enum (MarkupSyntax)

ไม่บังคับ ไวยากรณ์มาร์กอัปเริ่มต้นสำหรับข้อความที่ส่งหรืออ่านโดยแอปใน Chat นี้ ค่าเริ่มต้นคือ MARKUP_SYNTAX_MARKDOWN หากไม่ได้ระบุไว้

AppState

สถานะปัจจุบันของแอปใน Chat

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

ไม่บังคับ แอปจะเพิ่มลงใน DM แบบ 1:1 ระหว่างบุคคล แชทเป็นกลุ่ม และพื้นที่ทำงานได้หรือไม่ ค่าเริ่มต้นจะเป็น false หากไม่ได้ระบุไว้

ConnectionConfig

วิธีที่แอปได้รับเหตุการณ์

การแสดง JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
ช่อง
ประเภทการเชื่อมต่อ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
httpEndpointConfig

object (HttpEndpointConfig)

การกำหนดค่าปลายทาง HTTP
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

การกำหนดค่าการติดตั้งใช้งาน Apps Script
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

การกำหนดค่าหัวข้อ Pub/Sub
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

การกำหนดค่า Dialogflow
สิ้นสุดฟิลด์ที่แยกกัน

HttpEndpointConfig

การกำหนดค่าปลายทาง HTTP

การแสดง JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
ช่อง
การกำหนดค่า URL ปลายทาง HTTP ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
commonUrl

string

ไม่บังคับ HTTPS URL ที่ Google Chat ส่งเหตุการณ์แบบอินเทอร์แอกทีฟทั้งหมดไปให้
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

ไม่บังคับ HTTPS URL แยกต่างหากที่ Google Chat ส่งเหตุการณ์แบบอินเทอร์แอกทีฟแต่ละประเภทไปให้
สิ้นสุดฟิลด์ที่แยกกัน

HttpPerEventEndpointConfig

การกำหนดค่าปลายทาง HTTP สำหรับประเภทเหตุการณ์ที่เฉพาะเจาะจง

การแสดง JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
ช่อง
appCommandEndpoint

string

ต้องระบุ ปลายทาง HTTPS URL สำหรับเหตุการณ์คำสั่งแอป
addedToSpaceEndpoint

string

ต้องระบุ ปลายทาง HTTPS URL สำหรับเหตุการณ์การเพิ่มไปยังพื้นที่ทำงาน
messageEndpoint

string

ต้องระบุ ปลายทาง HTTPS URL สำหรับเหตุการณ์ข้อความ
removedFromSpaceEndpoint

string

ต้องระบุ ปลายทาง HTTPS URL สำหรับเหตุการณ์การนำออกจากพื้นที่ทำงาน

AppsScriptEndpointConfig

การกำหนดค่าปลายทางของ 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 เผยแพร่เหตุการณ์แบบอินเทอร์แอกทีฟทั้งหมด หัวข้อต้องอยู่ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google เดียวกันกับแอป และ Chat ต้องมีสิทธิ์เผยแพร่ข้อความไปยังหัวข้อนั้น โปรดดูรายละเอียดที่หัวข้อสร้างแอป Google Chat ด้วย Pub/Sub

รูปแบบ: projects/{project}/topics/{topic}

DialogflowEndpointConfig

การกำหนดค่าปลายทาง Dialogflow

การแสดง JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
ช่อง
dialogflowEdition

enum (DialogflowEdition)

ต้องระบุ รุ่น Dialogflow
agent

string

ไม่บังคับ ชื่อ Agent หรือสภาพแวดล้อม 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 หากต้องการใช้รุ่นนี้ ต้องมี Agent ของ Dialogflow ES อยู่ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ Google เดียวกันกับแอป โดย Google Chat จะส่งเหตุการณ์แบบอินเทอร์แอกทีฟทั้งหมดไปยัง Agent ดังกล่าว
CX รุ่น Dialogflow CX หากต้องการใช้รุ่นนี้ ตัวแทน Dialogflow CX ต้องอยู่ในโปรเจ็กต์ที่อยู่ในระบบคลาวด์ Google เดียวกันกับแอปและระบุไว้ในช่อง agent Google Chat จะส่งเหตุการณ์แบบอินเทอร์แอกทีฟทั้งหมดไปยัง Agent นั้น

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 ใช้ไวยากรณ์มาร์กดาวน์ ไวยากรณ์นี้อิงตามข้อกำหนด CommonMark โดยมีส่วนขยายเพิ่มเติม ดูข้อมูลเพิ่มเติมได้ที่ https://developers.google.com/workspace/chat/format-messages#format-texts

เมธอด

get

 รับการกำหนดค่าแอปใน Chat ของโปรเจ็กต์

patch

 อัปเดตการกำหนดค่าแอปใน Chat ของโปรเจ็กต์