Event

Một sự kiện tương tác với ứng dụng Google Chat.

Để tìm hiểu về các sự kiện tương tác, hãy xem bài viết Nhận và phản hồi các lượt tương tác với ứng dụng Google Chat. Để tìm hiểu về các loại sự kiện và ví dụ về tải trọng sự kiện, hãy xem bài viết Các loại sự kiện tương tác với ứng dụng Google Chat.

Ngoài việc nhận sự kiện từ hoạt động tương tác của người dùng, các ứng dụng trong Chat có thể nhận được sự kiện về những thay đổi đối với không gian, chẳng hạn như khi một thành viên mới được thêm vào không gian. Để tìm hiểu về các sự kiện trong không gian, hãy xem bài viết Làm việc với các sự kiện trên Google Chat.

Biểu diễn dưới dạng JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}
Trường
type

enum (EventType)

Loại sự kiện tương tác. Để biết thông tin chi tiết, hãy xem bài viết Các loại sự kiện tương tác với ứng dụng Google Chat.
eventTime

string (Timestamp format)

Dấu thời gian cho biết thời điểm xảy ra sự kiện tương tác.
token

string

Giá trị bí mật mà các ứng dụng Chat cũ có thể sử dụng để xác minh xem một yêu cầu có phải là của Google hay không. Google tạo mã thông báo ngẫu nhiên và giá trị của mã vẫn không thay đổi. Bạn có thể lấy, thu hồi hoặc tạo lại mã thông báo trên trang cấu hình API Chat trong Google Cloud Console.

Các ứng dụng Chat hiện đại không sử dụng trường này. Tính năng này không có trong tính năng phản hồi của API và trang cấu hình của API Chat.
threadKey

string

Khoá do ứng dụng Chat xác định cho chuỗi liên quan đến sự kiện tương tác. Xem spaces.messages.thread.threadKey để biết thêm thông tin.
message

object (Message)

Thông báo đã kích hoạt sự kiện tương tác, nếu có.
user

object (User)

Người dùng đã kích hoạt sự kiện tương tác.
space

object (Space)

Không gian xảy ra sự kiện tương tác.
action

object (FormAction)

Đối với sự kiện tương tác CARD_CLICKED, dữ liệu hành động trên biểu mẫu được liên kết khi người dùng nhấp vào một thẻ hoặc hộp thoại. Để tìm hiểu thêm, hãy xem bài viết Đọc dữ liệu biểu mẫu do người dùng nhập trên thẻ.
configCompleteRedirectUrl

string

URL mà ứng dụng Chat phải chuyển hướng người dùng đến sau khi họ hoàn tất quy trình uỷ quyền hoặc định cấu hình bên ngoài Google Chat. Để biết thêm thông tin, hãy xem bài viết Kết nối một ứng dụng trong Chat với các dịch vụ và công cụ khác.
isDialogEvent

boolean

Đối với các sự kiện tương tác CARD_CLICKED, xem người dùng có tương tác bằng hộp thoại hay không.
dialogEventType

enum (DialogEventType)

Loại sự kiện tương tác hộp thoại đã nhận được.
common

object (CommonEventObject)

Biểu thị thông tin về ứng dụng của người dùng, chẳng hạn như ngôn ngữ, ứng dụng lưu trữ và nền tảng. Đối với các ứng dụng trong Chat, CommonEventObject bao gồm thông tin do người dùng tương tác bằng hộp thoại, chẳng hạn như dữ liệu đã nhập trên thẻ.

CommonEventObject

Biểu thị thông tin về ứng dụng của người dùng, chẳng hạn như ngôn ngữ, ứng dụng lưu trữ và nền tảng. Đối với các ứng dụng trong Chat, CommonEventObject bao gồm dữ liệu do người dùng tương tác với thẻ gửi, chẳng hạn như dữ liệu được nhập vào hộp thoại.

Biểu diễn dưới dạng JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Trường
userLocale

string

locale.displayName đầy đủ ở định dạng [mã ngôn ngữ ISO 639] – [mã quốc gia/khu vực theo ISO 3166], chẳng hạn như "en-US".
hostApp

enum (HostApp)

Enum hostApp cho biết ứng dụng mà tiện ích bổ sung được gọi qua đó. Luôn CHAT đối với các ứng dụng trong Chat.
platform

enum (Platform)

Enum nền tảng cho biết nền tảng nơi sự kiện bắt đầu (WEB, IOS hoặc ANDROID). Không được các ứng dụng trong Chat hỗ trợ.
timeZone

object (TimeZone)

Mã múi giờ và chênh lệch so với Múi giờ phối hợp quốc tế (UTC). Chỉ hỗ trợ cho các loại sự kiện CARD_CLICKED và SUBMIT_DIALOG.
formInputs

map (key: string, value: object (Inputs))

Bản đồ chứa các giá trị mà người dùng nhập vào tiện ích từ thẻ hoặc hộp thoại. Khoá ánh xạ là mã nhận dạng chuỗi được chỉ định cho mỗi tiện ích và các giá trị này đại diện cho dữ liệu đầu vào cho tiện ích.

Để biết thông tin chi tiết, hãy xem bài viết Xử lý thông tin do người dùng nhập.
parameters

map (key: string, value: string)

Thông số tuỳ chỉnh được truyền đến hàm được gọi. Cả khoá và giá trị đều phải là chuỗi.
invokedFunction

string

Tên của hàm được gọi liên kết với tiện ích. Chỉ dành cho các ứng dụng trong Chat.

TimeZone

Mã múi giờ và chênh lệch so với Múi giờ phối hợp quốc tế (UTC). Chỉ hỗ trợ cho các loại sự kiện CARD_CLICKED và SUBMIT_DIALOG.

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

string

Mã cơ sở dữ liệu múi giờ IANA TZ, chẳng hạn như "America/Toronto".
offset

integer

Chênh lệch múi giờ của người dùng (tính bằng mili giây) tính theo Múi giờ phối hợp quốc tế (UTC).

Thông tin đầu vào

Các loại dữ liệu mà người dùng có thể nhập trên thẻ hoặc hộp thoại. Loại dữ liệu đầu vào phụ thuộc vào loại giá trị mà tiện ích chấp nhận.

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

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
Trường

Trường hợp inputs.

inputs chỉ có thể là một trong những trạng thái sau:
stringInputs

object (StringInputs)

Danh sách chuỗi đại diện cho những giá trị mà người dùng nhập vào trong một tiện ích.

Nếu tiện ích chỉ chấp nhận một giá trị, chẳng hạn như tiện ích TextInput, thì danh sách sẽ chứa một đối tượng chuỗi. Nếu tiện ích chấp nhận nhiều giá trị, chẳng hạn như tiện ích SelectionInput của các hộp đánh dấu, thì danh sách sẽ chứa một đối tượng chuỗi cho từng giá trị mà người dùng nhập hoặc chọn.
dateTimeInput

object (DateTimeInput)

Nhập giá trị ngày và giờ qua tiện ích DateTimePicker chấp nhận cả ngày và giờ.
dateInput

object (DateInput)

Nhập các giá trị ngày qua tiện ích DateTimePicker chỉ chấp nhận các giá trị ngày.
timeInput

object (TimeInput)

Giá trị nhập vào thời gian qua tiện ích DateTimePicker chỉ chấp nhận các giá trị thời gian.

StringInputs

Tham số nhập cho các tiện ích thông thường. Đối với các tiện ích có một giá trị, đây là danh sách giá trị duy nhất. Đối với các tiện ích có nhiều giá trị, chẳng hạn như hộp đánh dấu, tất cả giá trị đều được trình bày.

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

string

Danh sách các chuỗi do người dùng nhập.

DateTimeInput

Giá trị nhập ngày và giờ.

Biểu diễn dưới dạng JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Trường
msSinceEpoch

string (int64 format)

Thời gian kể từ thời gian bắt đầu của hệ thống, tính bằng mili giây.
hasDate

boolean

Liệu mục nhập datetime có bao gồm ngày theo lịch hay không.
hasTime

boolean

Liệu đầu vào datetime có bao gồm dấu thời gian hay không.

DateInput

Giá trị nhập ngày.

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

string (int64 format)

Thời gian kể từ thời gian bắt đầu của hệ thống, tính bằng mili giây.

TimeInput

Giá trị nhập vào theo thời gian.

Biểu diễn dưới dạng JSON 
{
  "hours": integer,
  "minutes": integer
}
Trường
hours

integer

Giờ trên đồng hồ 24 giờ.
minutes

integer

Số phút quá giờ. Các giá trị hợp lệ là từ 0 đến 59.