REST Resource: projects.chatAppConfig

Tài nguyên: ChatAppConfig

Đại diện cho cấu hình của một ứng dụng Google Chat được xây dựng dưới dạng tiện ích bổ sung của Google Workspace.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "interactiveFeatureConfig": {
    object (InteractiveFeatureConfig)
  },
  "avatarUri": string,
  "state": enum (AppState),
  "errorLoggingEnabled": boolean,
  "markupSyntax": enum (MarkupSyntax)
}
Trường
name

string

Bắt buộc. Giá trị nhận dạng. Tên tài nguyên của cấu hình ứng dụng Chat.

Định dạng: projects/{project}/chatAppConfig, trong đó {project} là số dự án trên Google Cloud.
displayName

string

Bắt buộc. Tên hiển thị của ứng dụng Chat. Độ dài phải từ 3 đến 25 ký tự.
description

string

Bắt buộc. Nội dung mô tả ngắn về ứng dụng Chat. Phải có từ 1 đến 40 ký tự.
interactiveFeatureConfig

object (InteractiveFeatureConfig)

Không bắt buộc. Chế độ cài đặt cho các tính năng tương tác của ứng dụng. Nếu bạn không cung cấp chế độ cài đặt này, ứng dụng sẽ không tương tác được, tức là ứng dụng có thể sử dụng API Chat nhưng người dùng không thể tương tác với ứng dụng.
avatarUri

string

Không bắt buộc. URL của hình đại diện của ứng dụng. Phải là một URL loại HTTPS lưu trữ hình ảnh PNG hình vuông (tỷ lệ khung hình 1:1). Kích thước tối thiểu được đề xuất: 256 x 256 pixel. Hình đại diện mặc định của ứng dụng sẽ được dùng nếu bạn không chỉ định.
state

enum (AppState)

Không bắt buộc. Trạng thái của ứng dụng. Giá trị mặc định là ACTIVE nếu không được chỉ định.
errorLoggingEnabled

boolean

Không bắt buộc. Có ghi lại lỗi vào Cloud Logging hay không. Giá trị mặc định là false nếu không được chỉ định.
markupSyntax

enum (MarkupSyntax)

Không bắt buộc. Cú pháp đánh dấu mặc định cho tin nhắn do ứng dụng Chat này gửi hoặc đọc. Giá trị mặc định là MARKUP_SYNTAX_MARKDOWN nếu không được chỉ định.

AppState

Trạng thái hiện tại của ứng dụng Chat.

Enum
APP_STATE_UNSPECIFIED Giá trị mặc định. Không xác định.
ACTIVE Liên kết với LIVE trong trang cấu hình Chat API. Ứng dụng đang hoạt động, những người có quyền xem có thể tìm thấy và sử dụng ứng dụng này.
DISABLED Ứng dụng này đã bị vô hiệu hoá, không ai có thể tìm thấy và không ai có thể trò chuyện với ứng dụng này nữa.

InteractiveFeatureConfig

Chế độ cài đặt cho các tính năng tương tác của ứng dụng.

Biểu diễn dưới dạng JSON 
{
  "connectionConfig": {
    object (ConnectionConfig)
  },
  "appCommands": [
    {
      object (AppCommand)
    }
  ],
  "urlPatterns": [
    {
      object (UrlPattern)
    }
  ],
  "allowlistedTestingPrincipals": [
    string
  ],
  "supportsMultiuserSpaces": boolean
}
Trường
connectionConfig

object (ConnectionConfig)

Bắt buộc. Cách ứng dụng nhận sự kiện từ Google Chat.
appCommands[]

object (AppCommand)

Không bắt buộc. Cấu hình cho lệnh của ứng dụng.
urlPatterns[]

object (UrlPattern)

Không bắt buộc. Cấu hình cho bản xem trước đường liên kết.
allowlistedTestingPrincipals[]

string

Không bắt buộc. Địa chỉ email của người dùng và nhóm trong miền Google Workspace của bạn có thể tìm và sử dụng ứng dụng.
supportsMultiuserSpaces

boolean

Không bắt buộc. Liệu có thể thêm ứng dụng vào tin nhắn trực tiếp 1:1 giữa người với người, cuộc trò chuyện nhóm và không gian hay không. Giá trị mặc định là false nếu không được chỉ định.

ConnectionConfig

Cách ứng dụng nhận sự kiện.

Biểu diễn dưới dạng JSON 
{

  "httpEndpointConfig": {
    object (HttpEndpointConfig)
  },
  "appsScriptEndpointConfig": {
    object (AppsScriptEndpointConfig)
  },
  "cloudPubSubEndpointConfig": {
    object (CloudPubSubEndpointConfig)
  },
  "dialogflowEndpointConfig": {
    object (DialogflowEndpointConfig)
  }
}
Trường
Loại kết nối. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
httpEndpointConfig

object (HttpEndpointConfig)

Cấu hình điểm cuối HTTP.
appsScriptEndpointConfig

object (AppsScriptEndpointConfig)

Cấu hình triển khai Apps Script.
cloudPubSubEndpointConfig

object (CloudPubSubEndpointConfig)

Cấu hình chủ đề Pub/Sub.
dialogflowEndpointConfig

object (DialogflowEndpointConfig)

Cấu hình Dialogflow.
Kết thúc các trường loại trừ lẫn nhau.

HttpEndpointConfig

Cấu hình điểm cuối HTTP.

Biểu diễn dưới dạng JSON 
{

  "commonUrl": string,
  "perEventEndpointConfig": {
    object (HttpPerEventEndpointConfig)
  }
}
Trường
Cấu hình URL điểm cuối HTTP. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
commonUrl

string

Không bắt buộc. URL loại HTTPS mà Google Chat gửi tất cả sự kiện tương tác đến.
perEventEndpointConfig

object (HttpPerEventEndpointConfig)

Không bắt buộc. Các URL loại HTTPS riêng biệt mà Google Chat gửi từng loại sự kiện tương tác đến.
Kết thúc các trường loại trừ lẫn nhau.

HttpPerEventEndpointConfig

Cấu hình điểm cuối HTTP cho các loại sự kiện cụ thể.

Biểu diễn dưới dạng JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Trường
appCommandEndpoint

string

Bắt buộc. Điểm cuối URL loại HTTPS cho các sự kiện lệnh của ứng dụng.
addedToSpaceEndpoint

string

Bắt buộc. Điểm cuối URL loại HTTPS cho sự kiện được thêm vào không gian.
messageEndpoint

string

Bắt buộc. Điểm cuối URL loại HTTPS cho các sự kiện tin nhắn.
removedFromSpaceEndpoint

string

Bắt buộc. Điểm cuối URL loại HTTPS cho các sự kiện bị xoá khỏi không gian.

AppsScriptEndpointConfig

Cấu hình điểm cuối của Apps Script.

Biểu diễn dưới dạng JSON 
{
  "deploymentId": string,
  "perEventEndpointConfig": {
    object (AppsScriptPerEventEndpointConfig)
  }
}
Trường
deploymentId

string

Bắt buộc. Mã triển khai Apps Script.
perEventEndpointConfig

object (AppsScriptPerEventEndpointConfig)

Không bắt buộc. Tên của các hàm Apps Script mà Google Chat gọi cho từng loại sự kiện tương tác. Nếu bạn không chỉ định, Chat sẽ gọi hàm mặc định cho từng loại sự kiện.

AppsScriptPerEventEndpointConfig

Cấu hình điểm cuối của Apps Script cho các loại sự kiện cụ thể.

Biểu diễn dưới dạng JSON 
{
  "appCommandEndpoint": string,
  "addedToSpaceEndpoint": string,
  "messageEndpoint": string,
  "removedFromSpaceEndpoint": string
}
Trường
appCommandEndpoint

string

Không bắt buộc. Tên hàm cho các sự kiện lệnh của ứng dụng. Nếu bạn không chỉ định, tên hàm onAppCommand mặc định sẽ được sử dụng.
addedToSpaceEndpoint

string

Không bắt buộc. Tên hàm cho sự kiện được thêm vào không gian. Nếu bạn không chỉ định, tên hàm onAddedToSpace mặc định sẽ được sử dụng.
messageEndpoint

string

Không bắt buộc. Tên hàm cho sự kiện thông báo. Nếu bạn không chỉ định, tên hàm onMessage mặc định sẽ được sử dụng.
removedFromSpaceEndpoint

string

Không bắt buộc. Tên hàm cho sự kiện bị xoá khỏi không gian. Nếu bạn không chỉ định, tên hàm onRemovedFromSpace mặc định sẽ được sử dụng.

CloudPubSubEndpointConfig

Cấu hình điểm cuối Pub/Sub.

Biểu diễn dưới dạng JSON 
{
  "topic": string
}
Trường
topic

string

Bắt buộc. Chủ đề Pub/Sub mà Google Chat xuất bản tất cả sự kiện tương tác. Chủ đề phải nằm trong cùng một dự án trên đám mây của Google Cloud với ứng dụng và Chat phải có quyền xuất bản tin nhắn lên chủ đề đó. Để biết thông tin chi tiết, hãy xem bài viết Tạo ứng dụng Google Chat bằng Pub/Sub.

Định dạng projects/{project}/topics/{topic}

DialogflowEndpointConfig

Cấu hình điểm cuối Dialogflow.

Biểu diễn dưới dạng JSON 
{
  "dialogflowEdition": enum (DialogflowEdition),
  "agent": string
}
Trường
dialogflowEdition

enum (DialogflowEdition)

Bắt buộc. Phiên bản Dialogflow.
agent

string

Không bắt buộc. Tên của tác nhân hoặc môi trường Dialogflow CX. Bắt buộc đối với Dialogflow CX. Đừng đặt cho Dialogflow ES.

Định dạng: projects/{project}/locations/{location}/agents/{agent} hoặc projects/{project}/locations/{location}/agents/{agent}/environments/{environment}.

DialogflowEdition

Loại phiên bản Dialogflow.

Enum
DIALOGFLOW_EDITION_UNSPECIFIED Giá trị mặc định. Không xác định.
ES Phiên bản Dialogflow ES. Để sử dụng phiên bản này, tác nhân Dialogflow ES phải tồn tại trong cùng một dự án trên đám mây của Google Cloud với ứng dụng. Google Chat sẽ gửi tất cả sự kiện tương tác đến tác nhân đó.
CX Phiên bản Dialogflow CX. Để sử dụng phiên bản này, tác nhân Dialogflow CX phải tồn tại trong cùng một dự án trên đám mây của Google Cloud với ứng dụng và được chỉ định trong trường agent. Google Chat sẽ gửi tất cả sự kiện tương tác đến tác nhân đó.

AppCommand

Cấu hình cho lệnh ứng dụng.

Biểu diễn dưới dạng JSON 
{
  "commandType": enum (CommandType),
  "commandId": integer,
  "command": string,
  "displayName": string,
  "description": string,
  "dialogEnabled": boolean,
  "loadingNotificationMessage": string
}
Trường
commandType

enum (CommandType)

Bắt buộc. Loại lệnh này.
commandId

integer

Bắt buộc. Mã của lệnh (1-1000). Phải là duy nhất trong ứng dụng.
command

string

Không bắt buộc. Tên lệnh. Bắt buộc đối với SLASH_COMMAND, không đặt cho các loại lệnh khác. Phải bắt đầu bằng dấu "/", ví dụ: "/command".
displayName

string

Không bắt buộc. Tên hiển thị thân thiện với người dùng của lệnh. Bắt buộc đối với MESSAGE_ACTION và QUICK_COMMAND, không đặt cho SLASH_COMMAND.
description

string

Bắt buộc. Nội dung mô tả ngắn về lệnh.
dialogEnabled

boolean

Không bắt buộc. Liệu lệnh này có kích hoạt hộp thoại hay không. Giá trị mặc định là false nếu không được chỉ định.
loadingNotificationMessage

string

Không bắt buộc. Thông báo sẽ được gửi đến người dùng khi họ kích hoạt hành động gửi tin nhắn. Chỉ hỗ trợ cho các lệnh MESSAGE_ACTION.

CommandType

Loại Lệnh ứng dụng.

Enum
COMMAND_TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
SLASH_COMMAND Một lệnh được gọi bằng cách nhập dấu "/" theo sau là tên lệnh. Nó có thể chấp nhận các đối số bổ sung trong văn bản thông báo.
QUICK_COMMAND Một lệnh nhanh được gọi từ trình đơn theo bối cảnh soạn thư. Lệnh nhanh không chấp nhận các đối số bổ sung.
MESSAGE_ACTION Một lệnh được gọi từ trình đơn theo bối cảnh của tin nhắn.

UrlPattern

Cấu hình cho bản xem trước đường liên kết.

Biểu diễn dưới dạng JSON 
{
  "hostPattern": string,
  "pathPrefix": string
}
Trường
hostPattern

string

Bắt buộc. Miền cần so khớp. So khớp một miền con cụ thể, chẳng hạn như "subdomain.example.com" hoặc toàn bộ miền bằng cách thêm dấu hoa thị (*) làm ký tự đại diện ở đầu. Ví dụ: "*.example.com" khớp với "https://subdomain.example.com" và "https://any.number.of.subdomains.example.com".
pathPrefix

string

Không bắt buộc. Tiền tố đường dẫn được thêm vào mẫu tên miền. Nếu để trống, thì tất cả URL trong mẫu máy chủ lưu trữ đều khớp. Ví dụ: khi kết hợp với mẫu máy chủ lưu trữ "subdomain.example.com", hãy chỉ định "path/" để khớp với các URL trang bắt đầu bằng "https://subdomain.example.com/path/".

MarkupSyntax

Cú pháp đánh dấu dùng để định dạng văn bản tin nhắn cho ứng dụng Chat này.

Enum
MARKUP_SYNTAX_UNSPECIFIED Giá trị mặc định. Không xác định. Các ứng dụng Chat hiện có được tạo trước khi markup_syntax ra mắt sẽ có giá trị này và sử dụng MARKUP_SYNTAX_CHAT cho đến khi được cập nhật rõ ràng.
MARKUP_SYNTAX_CHAT Sử dụng cú pháp đánh dấu của Google Chat. Hãy xem https://developers.google.com/workspace/chat/format-messages#format-texts để biết thêm thông tin.
MARKUP_SYNTAX_MARKDOWN Sử dụng cú pháp Markdown. Cú pháp này dựa trên quy cách CommonMark, có thêm các phần mở rộng. Hãy xem https://developers.google.com/workspace/chat/format-messages#format-texts để biết thêm thông tin.

Phương thức

get

 Lấy cấu hình ứng dụng Chat của một dự án.

patch

 Cập nhật cấu hình ứng dụng Chat của một dự án.