Event

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)
  }
}
Các trường
type

enum (EventType)

Loại sự kiện.

eventTime

string (Timestamp format)

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

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 ngẫu nhiên mã thông báo và giá trị của nó sẽ không thay đổi. Bạn có thể lấy, thu hồi hoặc tạo lại mã thông báo từ 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. Dữ liệu 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 liên quan đến sự kiện. 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, nếu có.

user

object (User)

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

space

object (Space)

Không gian diễn ra sự kiện.

action

object (FormAction)

Dữ liệu về hành động trên biểu mẫu được liên kết với một thẻ tương tác đã được nhấp vào. Chỉ được điền sẵn cho CARD_CLICKED sự kiện. Xem hướng dẫn về Thẻ tương tác để biết thêm thông tin.

configCompleteRedirectUrl

string

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

isDialogEvent

boolean

Đúng khi sự kiện liên quan đến hộp thoại.

dialogEventType

enum (DialogEventType)

Loại sự kiện 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 ứng dụng nhắn tin, CommonEventObject bao gồm thông tin do người dùng gửi và tương tác với hộp thoại, như dữ liệu đã nhập vào thẻ.

Đối tượng sự kiện chung

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 ứng dụng nhắn tin, CommonEventObject bao gồm dữ liệu do người dùng gửi và tương tác với thẻ, như dữ liệu đã 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
}
Các 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". Không được ứng dụng Chat hỗ trợ.

hostApp

enum (HostApp)

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

platform

enum (Platform)

Enum của 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). Không được ứng dụng Chat hỗ trợ.

timeZone

object (TimeZone)

Mã múi giờ và độ lệch so với Giờ phối hợp quốc tế (UTC).

formInputs

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

Một bản đồ chứa các giá trị hiện tại của tiện ích trong thẻ. Khoá bản đồ là các ID chuỗi được gán cho mỗi tiện ích và các giá trị thể hiện thông tin đầu vào cho tiện ích đó. Tuỳ thuộc vào loại dữ liệu đầu vào, một đối tượng khác nhau đại diện cho từng đầu vào: Đối với các tiện ích đơn giá trị, StringInput. Đối với các tiện ích nhiều giá trị, một mảng các đối tượng StringInput. Đối với bộ chọn ngày, DateTimeInput. Đối với bộ chọn chỉ ngày, DateInput. Đối với bộ chọn chỉ thời gian, TimeInput. Tương ứng với dữ liệu mà người dùng nhập vào thẻ trong một hộp thoại.

parameters

map (key: string, value: string)

Thông số tùy chỉnh được chuyển đến hàm được gọi. Cả khóa 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 ứng dụng nhắn tin.

TimeZone

Mã múi giờ và độ lệch so với Giờ phối hợp quốc tế (UTC). Không được ứng dụng Chat hỗ trợ.

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

string

Mã cơ sở dữ liệu về 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ừ Giờ phối hợp quốc tế (UTC).

Thông tin đầu vào

Các loại dữ liệu đầu vào cho tiện ích. Người dùng nhập dữ liệu bằng những dữ liệu đầu vào này.

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.
}
Các trường

Trường liên kết inputs.

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

stringInputs

object (StringInputs)

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

dateTimeInput

object (DateTimeInput)

Giá trị nhập ngày và giờ. Không được ứng dụng Chat hỗ trợ.

dateInput

object (DateInput)

Giá trị nhập ngày. Không được ứng dụng Chat hỗ trợ.

timeInput

object (TimeInput)

Giá trị nhập vào theo thời gian. Không được ứng dụng Chat hỗ trợ.

Chuỗi đầu vào

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

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

string

Một mảng chuỗi do người dùng nhập.

Ngày giờ nhập

Giá trị nhập ngày và giờ. Không được ứng dụng Chat hỗ trợ.

Biểu diễn dưới dạng JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Các 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

Thông tin đầu vào datetime có chứa ngày (theo lịch) hay không.

hasTime

boolean

Dữ liệu đầu vào datetime có chứa dấu thời gian hay không.

Ngày nhập

Giá trị nhập ngày. Không được ứng dụng Chat hỗ trợ.

Biểu diễn dưới dạng JSON
{
  "msSinceEpoch": string
}
Các 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.

Giờ nhập

Giá trị nhập vào theo thời gian. Không được ứng dụng Chat hỗ trợ.

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

integer

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

minutes

integer

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