Event

Sự kiện tương tác với ứng dụng Google Chat đại diện và chứa dữ liệu về hoạt động tương tác của người dùng với ứng dụng Chat. Để định cấu hình ứng dụng Chat nhằm nhận sự kiện tương tác, hãy xem phần Nhận và phản hồi hoạt động tương tác của người dùng.

Ngoài việc nhận sự kiện từ các hoạt động tương tác của người dùng, ứng dụng Chat có thể nhận 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 trong 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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Trường
type

enum (EventType)

Loại tương tác của người dùng với ứng dụng Chat, chẳng hạn như MESSAGE hoặc ADDED_TO_SPACE.
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

Một 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ã thông báo này vẫn giữ nguyên. 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 Chat API trong Google Cloud Console.

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

string

Khoá do ứng dụng Chat xác định cho chuỗi tin nhắn 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)

Đối với sự kiện tương tác ADDED_TO_SPACE, CARD_CLICKED và 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 đã tương tác với ứng dụng Chat.
space

object (Space)

Không gian mà người dùng tương tác với ứng dụng Chat.
action

object (FormAction)

Đối với các 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 phần Đọc dữ liệu biểu mẫu do người dùng nhập trên thẻ.
configCompleteRedirectUrl

string

Đối với các sự kiện tương tác MESSAGE, URL mà người dùng phải được chuyển hướ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 ứng dụng 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 và MESSAGE, liệu người dùng đang tương tác với hoặc sắp tương tác với một hộp thoại.
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 khách 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 ứng dụng Chat, CommonEventObject bao gồm thông tin do người dùng gửi khi tương tác với hộp thoại, chẳng hạn như dữ liệu được nhập trên thẻ.
appCommandMetadata

object (AppCommandMetadata)

Được điền sẵn cho các lệnh ứng dụng, bao gồm cả lệnh dấu gạch chéo và lệnh nhanh.

CommonEventObject

Biểu thị thông tin về ứng dụng khách 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 ứng dụng 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 trong 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 ISO 3166], chẳng hạn như "en-US".
hostApp

enum (HostApp)

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

enum (Platform)

Enum nền tảng cho biết nền tảng nơi sự kiện bắt nguồn (WEB, IOS hoặc ANDROID). Ứng dụng Chat không hỗ trợ enum này.
timeZone

object (TimeZone)

Mã nhận dạng múi giờ và độ lệch so vớ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))

Một bản đồ chứa các giá trị mà người dùng nhập vào một 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à giá trị đạ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 phần Xử lý thông tin do người dùng nhập.
parameters

map (key: string, value: string)

Tham 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ỉ đặt cho các ứng dụng Chat.

TimeZone

Mã nhận dạng múi giờ và độ lệch so vớ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ư "Hoa Kỳ/Toronto".
offset

integer

Độ lệch múi giờ của người dùng, tính bằng mili giây, so vớ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 hợp nhất inputs.

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

object (StringInputs)

Danh sách các chuỗi đại diện cho các giá trị mà người dùng nhập vào 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 hộp đánh dấu, thì danh sách sẽ chứa một đối tượng chuỗi cho mỗi giá trị mà người dùng nhập hoặc chọn.
dateTimeInput

object (DateTimeInput)

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

object (DateInput)

Giá trị nhập ngày từ tiện ích DateTimePicker chỉ chấp nhận giá trị ngày.
timeInput

object (TimeInput)

Giá trị nhập thời gian từ tiện ích DateTimePicker chỉ chấp nhận giá trị thời gian.

StringInputs

Tham số đầu vào cho các tiện ích thông thường. Đối với các tiện ích có giá trị đơn, đó là danh sách giá trị đơn. Đố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ả cá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ị đầu vào 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 dữ liệu đầu vào datetime có bao gồm ngày theo lịch hay không.
hasTime

boolean

Liệu dữ liệu đầu vào datetime có chứa 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 thời gian.

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

integer

Giờ theo đồng hồ 24 giờ.
minutes

integer

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

AppCommandMetadata

Siêu dữ liệu liên kết với các lệnh của ứng dụng. Lệnh ứng dụng là một cách để người dùng gọi và tương tác với ứng dụng Chat. Đây có thể là các lệnh dấu gạch chéo được nhập vào hộp soạn thư hoặc các mục được chọn trực tiếp trong trình đơn tích hợp.

Biểu diễn dưới dạng JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Trường
appCommandId

integer

Mã lệnh cho lượt tương tác với ứng dụng nhất định.
appCommandType

enum (AppCommandType)

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