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

Trang này trình bày cấu trúc của đối tượng sự kiện trong tiện ích bổ sung của Google Workspace.

Đối tượng sự kiện là các cấu trúc JSON được tự động tạo và truyền dưới dạng tham số để kích hoạt hoặc gọi các hàm callback khi người dùng tương tác với một tiện ích bổ sung. Đối tượng sự kiện mang thông tin phía máy khách về ứng dụng lưu trữ và bối cảnh hiện tại đến hàm callback phía máy chủ của tiện ích bổ sung.

Tiện ích bổ sung của Google Workspace sử dụng đối tượng sự kiện ở những nơi sau:

  • Trình kích hoạt trang chủ. Mỗi hàm homepageTrigger mà bạn xác định sẽ tự động được truyền một đối tượng sự kiện khi hàm kích hoạt trang chủ kích hoạt. Bạn có thể sử dụng đối tượng này trong hàm kích hoạt trang chủ để xác định ứng dụng lưu trữ đang hoạt động, nền tảng của ứng dụng khách, ngôn ngữ của người dùng và các thông tin khác.

    Các đối tượng sự kiện được tạo khi trình kích hoạt trang chủ kích hoạt không chứa tất cả các trường có trong các trường hợp khác; các trường liên quan đến tiện ích và thông tin theo bối cảnh sẽ bị bỏ qua.

  • Điều kiện kích hoạt theo bối cảnh. Mỗi ứng dụng lưu trữ cung cấp một tập hợp các điều kiện kích hoạt theo bối cảnh khác nhau, kích hoạt khi người dùng nhập một bối cảnh cụ thể:

    Khi một điều kiện kích hoạt theo bối cảnh kích hoạt, ứng dụng lưu trữ sẽ gọi runFunction tương ứng được liệt kê trong tệp kê khai tiện ích bổ sung, truyền cho tiện ích bổ sung một đối tượng sự kiện dưới dạng tham số. Các đối tượng sự kiện được tạo khi trình kích hoạt theo bối cảnh kích hoạt chứa tất cả các trường có trong đối tượng sự kiện kích hoạt trang chủ, cộng với các trường chứa thông tin theo bối cảnh.

  • Thao tác với tiện ích. Đối tượng sự kiện cung cấp khả năng tương tác của tiện ích, sử dụng cùng một mô hình hành động mà tiện ích bổ sung dành cho Gmail sử dụng. Tiện ích bổ sung của Google Workspace sử dụng cùng một hàm trình xử lý tiện ích, đối tượng Action và phản hồi hành động. Trong các tiện ích bổ sung của Google Workspace, đối tượng sự kiện hành động bao gồm nhiều thông tin hơn mà hàm callback có thể xử lý.

    Các đối tượng sự kiện được tạo từ hành động của tiện ích chứa tất cả các trường có trong đối tượng sự kiện của điều kiện kích hoạt theo bối cảnh, cộng với các trường chứa thông tin về tiện ích.

  • Trình kích hoạt đường liên kết xem trước. Trong Google Tài liệu, Trang tính và Trang trình bày, bạn có thể định cấu hình bản xem trước đường liên kết cho các dịch vụ bên thứ ba dựa trên các mẫu URL cụ thể. Khi người dùng tương tác với một đường liên kết khớp với mẫu, linkPreviewTriggers sẽ kích hoạt và một đối tượng sự kiện chứa đường liên kết sẽ được truyền đến hàm callback của trình kích hoạt. Tiện ích bổ sung của bạn có thể sử dụng đối tượng sự kiện này để tạo một khối thông minh và thẻ hiển thị thông tin về đường liên kết trong ứng dụng lưu trữ. Bạn cũng có thể tạo các hành động cho tiện ích để người dùng có thể tương tác với thẻ xem trước và nội dung của thẻ.

  • Trình kích hoạt ứng dụng Google Chat. Trong Google Chat, tiện ích bổ sung của bạn xuất hiện dưới dạng một ứng dụng Chat và người dùng có thể tương tác với tiện ích đó bằng cách thêm tiện ích vào không gian, gửi tin nhắn, sử dụng lệnh dấu gạch chéo và nhiều thao tác khác. Để xây dựng các tính năng tương tác, bạn thiết lập và sử dụng nhiều Trình kích hoạt ứng dụng Chat. Mỗi điều kiện kích hoạt sẽ gửi một trọng tải đối tượng sự kiện khác nhau để giúp bạn xử lý hoặc phản hồi từng loại tương tác.

Cấu trúc đối tượng sự kiện

Bảng sau đây mô tả cấu trúc cấp cao nhất của đối tượng sự kiện trong tiện ích bổ sung của Google Workspace. Cấu trúc này bao gồm một trường cấp cao nhất commonEventObject cho thông tin độc lập với máy chủ. Mỗi đối tượng sự kiện cũng có thể có một trong các trường cấp cao nhất dành riêng cho máy chủ lưu trữ sau đây, do ứng dụng lưu trữ đang hoạt động xác định: gmailEventObject, calendarEventObject hoặc driveEventObject.

Để có khả năng tương thích ngược, các đối tượng sự kiện của tiện ích bổ sung Google Workspace sẽ bao gồm các trường ban đầu được dùng trong đối tượng sự kiện hành động của tiện ích bổ sung dành cho Gmail. Các trường này nằm trong mục "Original Gmail add-on fields" (Trường tiện ích bổ sung ban đầu của Gmail) và không thuộc commonEventObject.

Các trường tiện ích bổ sung dành cho Gmail ban đầu không còn được dùng nữa. Khi phát triển hoặc di chuyển tiện ích bổ sung Google Workspace, hãy sử dụng cấu trúc đối tượng sự kiện mới hơn. Các trường này có thể bị xoá trong bản cập nhật sau này.

Đối tượng sự kiện
eventObject.commonEventObject Common fields object
Một đối tượng chứa thông tin chung cho tất cả đối tượng sự kiện, bất kể ứng dụng lưu trữ.
eventObject.calendar Calendar event object
Chỉ xuất hiện nếu máy chủ gọi là Lịch Google. Một đối tượng chứa thông tin về lịch và sự kiện.
eventObject.chat Chat event object
Chỉ xuất hiện nếu máy chủ lưu trữ cuộc gọi là Google Chat. Một đối tượng chứa thông tin về cuộc trò chuyện.
eventObject.drive Drive event object
Chỉ xuất hiện nếu máy chủ gọi là Google Drive. Một đối tượng chứa thông tin về Drive.
eventObject.gmail Gmail event object
Chỉ xuất hiện nếu máy chủ gọi là Gmail. Một đối tượng chứa thông tin về Gmail.
eventObject.docs Docs event object
Chỉ xuất hiện nếu máy chủ gọi là Google Tài liệu. Một đối tượng chứa thông tin về Tài liệu.
eventObject.sheets Sheets event object
Chỉ xuất hiện nếu máy chủ gọi là Google Trang tính. Một đối tượng chứa thông tin về Trang tính.
eventObject.slides Slides event object
Chỉ xuất hiện nếu máy chủ gọi là Google Trang trình bày. Một đối tượng chứa thông tin về Trang trình bày.
Các trường ban đầu của tiện ích bổ sung cho Gmail
eventObject.messageMetadata.accessToken string
Không dùng nữa. Mã truy cập. Bạn có thể sử dụng tính năng này để bật quyền truy cập vào dữ liệu người dùng bằng cách sử dụng phạm vi tiện ích bổ sung tạm thời của Gmail.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Không dùng nữa. Mã thư của chuỗi thư mở trong giao diện người dùng Gmail.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.gmail.messageId.

eventObject.clientPlatform string
Không dùng nữa. Cho biết nguồn gốc của sự kiện (web, iOS hoặc Android).

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.platform.

eventObject.formInput object
Không dùng nữa. Bản đồ các giá trị hiện tại của tất cả tiện ích biểu mẫu trong thẻ, được giới hạn ở một giá trị cho mỗi tiện ích. Khoá là mã nhận dạng chuỗi liên kết với tiện ích và giá trị là chuỗi. Đối tượng sự kiện cung cấp formInput để thuận tiện khi bạn cần đọc dữ liệu từ nhiều tiện ích có giá trị đơn lẻ dự kiến, chẳng hạn như dữ liệu đầu vào dạng văn bản và nút chuyển. Đối với các tiện ích có nhiều giá trị như hộp đánh dấu, hãy đọc từng giá trị từ formInputs.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.formInputs; các tiện ích có giá trị đơn được biểu thị dưới dạng mảng có một phần tử.

eventObject.formInputs object
Không dùng nữa. Bản đồ các giá trị hiện tại của tiện ích trong thẻ, được trình bày dưới dạng danh sách chuỗi. Khoá là mã nhận dạng chuỗi liên kết với tiện ích. Đối với các tiện ích có một giá trị, giá trị này sẽ được trình bày trong một mảng có một phần tử. Đối với các tiện ích có nhiều giá trị, chẳng hạn như nhóm hộp đánh dấu, tất cả giá trị đều được trình bày trong một danh sách.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.formInputs.

eventObject.parameters object
Không dùng nữa. Bản đồ của mọi tham số bổ sung mà bạn cung cấp cho Action bằng Action.setParameters. Khoá và giá trị của bản đồ là các chuỗi.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.parameters.

eventObject.userCountry string
Không dùng nữa và tắt theo mặc định. Mã gồm hai chữ cái cho biết quốc gia hoặc khu vực của người dùng. Đây cũng có thể là mã quốc gia dạng số theo tiêu chuẩn UN M49.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Không dùng nữa và tắt theo mặc định. Mã ISO 639 gồm hai chữ cái cho biết ngôn ngữ của người dùng. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Không dùng nữa và tắt theo mặc định. Mã nhận dạng múi giờ của múi giờ của người dùng. Ví dụ: America/New_York, Europe/Vienna và Asia/Seoul. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Không dùng nữa và tắt theo mặc định. Độ lệch thời gian so với Giờ phối hợp quốc tế (UTC) của múi giờ của người dùng, tính bằng mili giây. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.timeZone.offset.

Đối tượng sự kiện phổ biến

Đối tượng sự kiện chung là một phần của đối tượng sự kiện tổng thể, mang thông tin chung, độc lập với máy chủ lưu trữ đến tiện ích bổ sung từ ứng dụng của người dùng. Thông tin này bao gồm các thông tin chi tiết như ngôn ngữ, ứng dụng lưu trữ và nền tảng của người dùng.

Ngoài trình kích hoạt trang chủ và trình kích hoạt theo bối cảnh, tiện ích bổ sung còn tạo và truyền các đối tượng sự kiện đến hàm callback hành động khi người dùng tương tác với tiện ích. Hàm callback của tiện ích bổ sung có thể truy vấn đối tượng sự kiện phổ biến để xác định nội dung của các tiện ích đang mở trong ứng dụng của người dùng. Ví dụ: tiện ích bổ sung của bạn có thể tìm thấy văn bản mà người dùng đã nhập vào tiện ích TextInput trong đối tượng eventObject.commentEventObject.formInputs.

Các trường đối tượng sự kiện phổ biến
commonEventObject.platform string
Cho biết nguồn gốc của sự kiện (`WEB`, `IOS` hoặc `ANDROID`).
commonEventObject.formInputs object
Một bản đồ chứa các giá trị hiện tại của các tiện ích trong thẻ hiển thị. Khoá bản đồ là mã nhận dạng chuỗi được chỉ định cho mỗi tiện ích.

Cấu trúc của đối tượng giá trị bản đồ phụ thuộc vào loại tiện ích:

  • Tiện ích có một giá trị (ví dụ: hộp văn bản): danh sách chuỗi (chỉ có một phần tử).

    Ví dụ: đối với tiện ích nhập văn bản có mã nhận dạng là employeeName, hãy truy cập vào giá trị nhập văn bản bằng: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Tiện ích nhiều giá trị (ví dụ: nhóm hộp đánh dấu): danh sách chuỗi.

    Ví dụ: đối với một tiện ích nhiều giá trị có participants làm mã nhận dạng, hãy truy cập vào mảng giá trị bằng: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myDTPicker, hãy truy cập vào đối tượng DateTimeInput bằng e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: một DateInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myDatePicker, hãy truy cập vào đối tượng DateInput bằng e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myTimePicker, hãy truy cập vào đối tượng TimeInput bằng e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Cho biết ứng dụng lưu trữ mà tiện ích bổ sung đang hoạt động khi đối tượng sự kiện được tạo. Các giá trị có thể có bao gồm:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Mọi tham số bổ sung mà bạn cung cấp cho một hành động bằng cách sử dụng actionParameters hoặc Action.setParameters.

Bản dùng trước cho nhà phát triển: Đối với ứng dụng Google Chat, để đề xuất các mục dựa trên nội dung người dùng nhập trong trình đơn nhiều lựa chọn, hãy sử dụng giá trị của khoá "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Bạn có thể sử dụng giá trị này để truy vấn cơ sở dữ liệu và đề xuất các mục có thể chọn cho người dùng khi họ nhập. Để biết thông tin chi tiết, hãy xem bài viết Thu thập và xử lý thông tin của người dùng Google Chat.
commonEventObject.userLocale string
Tắt theo mặc định. Mã nhận dạng ngôn ngữ và quốc gia/khu vực của người dùng theo định dạng mã ngôn ngữ ISO 639-mã quốc gia/khu vực ISO 3166. Ví dụ: en-US.

Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

commonEventObject.timeZone string
Tắt theo mặc định. Mã múi giờ và độ lệch. Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.
commonEventObject.timeZone.id string
Mã nhận dạng múi giờ của múi giờ của người dùng. Ví dụ: America/New_York, Europe/Vienna và Asia/Seoul. Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.
commonEventObject.timeZone.offset string
Độ lệch thời gian so với Giờ phối hợp quốc tế (UTC) của múi giờ của người dùng, tính bằng mili giây. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Thông tin đầu vào của biểu mẫu bộ chọn ngày giờ

Hàm callback hành động có thể nhận các giá trị tiện ích hiện tại trong trường commonEventObject.formInputs. Dữ liệu này bao gồm các giá trị ngày hoặc giờ mà người dùng đã chọn trong các tiện ích chọn ngày hoặc giờ. Cấu trúc thông tin sẽ khác nhau tuỳ thuộc vào việc tiện ích được định cấu hình làm bộ chọn ngày giờ, bộ chọn chỉ ngày hay bộ chọn chỉ giờ. Sự khác biệt về cấu trúc được mô tả trong bảng sau:

Đối tượng DateTimeInput
dateTimeInput.hasDate boolean
true nếu ngày giờ đầu vào bao gồm ngày; nếu false chỉ bao gồm giờ.
dateTimeInput.hasTime boolean
true nếu ngày giờ đầu vào bao gồm cả giờ; nếu false thì chỉ bao gồm ngày.
dateTimeInput.msSinceEpoch string
Thời gian do người dùng chọn, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống (00:00:00 giờ UTC ngày 1 tháng 1 năm 1970).
Đối tượng DateInput
dateInput.msSinceEpoch string
Thời gian do người dùng chọn, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống (00:00:00 giờ UTC ngày 1 tháng 1 năm 1970).
Đối tượng TimeInput
timeInput.hours number
Số giờ mà người dùng chọn.
timeInput.minutes number
Số phút mà người dùng chọn.

Đối tượng sự kiện trò chuyện

Đối tượng sự kiện Chat là một phần của đối tượng sự kiện tổng thể mang thông tin về hoạt động tương tác của người dùng với một Ứng dụng Chat. Đối tượng này chỉ xuất hiện trong một đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Chat.

Trò chuyện
chat.user object (User)
Người dùng Chat đã tương tác với ứng dụng Chat.
chat.space object (Space)
Không gian trong Chat nơi người dùng tương tác với ứng dụng Chat.
chat.eventTime

string (Timestamp format)

Thời điểm xảy ra lượt tương tác.

Trường nhóm payload. Đối với điều kiện kích hoạt Trang chủ ứng dụng (khi người dùng mở thẻ Trang chủ), payload không được đặt và chat chứa chat.user và chat.eventTime.

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

object (MessagePayload)

Trọng tải mà ứng dụng Chat nhận được từ một trình kích hoạt Tin nhắn.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Tải trọng mà ứng dụng Chat nhận được từ một điều kiện kích hoạt Đã thêm vào không gian.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Trọng tải mà ứng dụng Chat nhận được từ một trình kích hoạt Đã xoá khỏi không gian.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Trọng tải mà ứng dụng Chat nhận được khi người dùng nhấp vào một nút trong tin nhắn hoặc thẻ. Nếu người dùng nhấp vào một nút để gửi thông tin, thì đối tượng commonEventObject.formInputs sẽ chứa các giá trị thu thập được từ người dùng. Để biết thông tin chi tiết, hãy xem bài viết Thu thập thông tin từ người dùng Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Trọng tải mà ứng dụng Chat nhận được khi người dùng nhập văn bản vào trình đơn chọn nhiều mục của một tiện ích selectionInput . Ứng dụng Chat có thể sử dụng đối tượng sự kiện này để điền sẵn các mục được đề xuất từ một nguồn dữ liệu động. Ví dụ: để điền sẵn các trường hợp hỗ trợ từ một nguồn dữ liệu bên ngoài, ứng dụng Chat có thể truy vấn nguồn dữ liệu dựa trên nội dung người dùng nhập vào trình đơn, sau đó trả về các trường hợp hỗ trợ phù hợp dưới dạng các mục có thể chọn.

Đối tượng CommonEventObject.parameters['autocomplete_widget_query'] chứa giá trị chuỗi mà người dùng nhập vào trình đơn.

chat.appCommandPayload

object (AppCommandPayload)

Trọng tải mà ứng dụng Chat nhận được khi người dùng sử dụng một lệnh trong ứng dụng Chat.

Phần tải

Tuỳ thuộc vào loại hoạt động tương tác với ứng dụng Chat, sự kiện sẽ chứa một tải trọng có một hoặc nhiều tài nguyên API Chat.

Nội dung thông báo
MessagePayload
chat.messagePayload.message object (Message)
Tin nhắn trò chuyện đã kích hoạt sự kiện.
chat.messagePayload.space object (Space)
Phòng Chat nơi người dùng gửi tin nhắn gọi ứng dụng Chat.
chat.messagePayload.configCompleteRedirectUri string
URL mà ứng dụng Chat sẽ 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 tiện ích bổ sung của Google Workspace với một dịch vụ bên thứ ba.
Đã thêm vào tải trọng không gian
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Không gian trong Chat mà người dùng đã thêm hoặc cài đặt ứng dụng Chat.

Khi quản trị viên cài đặt ứng dụng Chat, trường space.adminInstalled sẽ được đặt thành true.

chat.addedToSpacePayload.interactionAdd boolean
Liệu người dùng có thêm ứng dụng Chat vào không gian bằng tin nhắn hay không. Ví dụ: @đề cập đến ứng dụng Chat hoặc sử dụng một lệnh. Nếu true, Chat sẽ gửi một đối tượng sự kiện khác có messagePayload chứa thông tin về tin nhắn.
chat.addedToSpacePayload.configCompleteRedirectUri string
URL mà ứng dụng Chat sẽ 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 tiện ích bổ sung của Google Workspace với một dịch vụ bên thứ ba.
Đã xoá khỏi tải trọng không gian
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Không gian trò chuyện mà người dùng đã xoá hoặc gỡ cài đặt ứng dụng Chat.

Khi quản trị viên gỡ cài đặt ứng dụng Chat, trường space.adminInstalled sẽ được đặt thành false.

Trọng tải khi nhấp vào nút
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Tin nhắn trò chuyện chứa nút mà người dùng đã nhấp vào.
chat.buttonClickedPayload.space object (Space)
Không gian trò chuyện nơi người dùng nhấp vào một nút trong tin nhắn của ứng dụng Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Liệu người dùng có nhấp vào nút để tương tác với một hộp thoại hay không.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Nếu isDialogEvent là true, thì đây là loại tương tác trong hộp thoại.

Enum DialogEventType.

Giá trị của dialogEventType chỉ có thể là một trong những giá trị sau:
TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
REQUEST_DIALOG Người dùng yêu cầu một hộp thoại. Ví dụ: họ sử dụng một lệnh hoặc nhấp vào một nút trong tin nhắn.
SUBMIT_DIALOG Người dùng nhấp vào một thành phần tương tác trong hộp thoại. Ví dụ: người dùng điền thông tin vào hộp thoại rồi nhấp vào một nút để gửi thông tin.
Phần tải trọng đã cập nhật của tiện ích
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Không gian trò chuyện nơi diễn ra hoạt động tương tác.
Trọng tải lệnh của ứng dụng
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Siêu dữ liệu về lệnh mà người dùng đã sử dụng và cách họ kích hoạt lệnh đó.
chat.appCommandPayload.space object (Space)
Không gian trong Chat nơi người dùng sử dụng lệnh.
chat.appCommandPayload.thread object (Thread)
Nếu lượt tương tác xảy ra trong một chuỗi, thì đây là chuỗi cuộc trò chuyện nơi người dùng sử dụng lệnh.
chat.appCommandPayload.message object (Message)
Đối với lệnh dấu gạch chéo, tin nhắn có lệnh dấu gạch chéo.
chat.appCommandPayload.configCompleteRedirectUri string
Nếu lệnh cần được uỷ quyền hoặc định cấu hình, thì đây là URL để chuyển hướng người dùng sau khi họ hoàn tất quy trình bên ngoài Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Liệu lệnh có mở một hộp thoại hay không.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Loại tương tác với hộp thoại.

Enum DialogEventType.

Giá trị của dialogEventType chỉ có thể là một trong những giá trị sau:
TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
REQUEST_DIALOG Người dùng yêu cầu một hộp thoại. Ví dụ: họ sử dụng một lệnh hoặc nhấp vào một nút trong tin nhắn.
SUBMIT_DIALOG Người dùng nhấp vào một thành phần tương tác trong hộp thoại. Ví dụ: người dùng điền thông tin vào hộp thoại rồi nhấp vào một nút để gửi thông tin.
Siêu dữ liệu lệnh của ứng dụng
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Mã lệnh.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Loại lệnh.

Enum AppCommandType.

Giá trị của AppCommandType chỉ có thể là một trong những giá trị sau:
APP_COMMAND_TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
SLASH_COMMAND Người dùng sử dụng lệnh bằng cách gửi tin nhắn bắt đầu bằng dấu gạch chéo /.
QUICK_COMMAND Người dùng chọn lệnh trong trình đơn Chat trong phần trả lời tin nhắn.

Đối tượng sự kiện trên lịch

Đối tượng sự kiện trên Lịch là một phần của đối tượng sự kiện tổng thể, mang thông tin về lịch và sự kiện trên lịch của người dùng. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Lịch Google.

Bảng sau đây liệt kê các trường có trong trường calendarEventObject của một đối tượng sự kiện. Các trường được đánh dấu là Dữ liệu do người dùng tạo sẽ xuất hiện trong đối tượng sự kiện nếu và chỉ khi dữ liệu đó có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Đối với nhiều trường trong đối tượng này và các cấu trúc con của đối tượng, có một mối liên kết trực tiếp đến các trường Tài nguyên sự kiện của API Lịch có cùng tên. Nếu nội dung mô tả trường khác nhau, thì thông tin trong bảng sau đây là chính xác.

Đối tượng sự kiện trên lịch
calendar.attendees[] list of attendee objects
Dữ liệu do người dùng tạo. Danh sách người tham dự sự kiện trên lịch.
calendar.calendarId string
Mã lịch.
calendar.capabilities object
Dữ liệu do người dùng tạo. Một đối tượng mô tả các chức năng của tiện ích bổ sung để xem hoặc cập nhật thông tin sự kiện.
calendar.capabilities.canAddAttendees boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm người tham dự mới vào danh sách người tham dự sự kiện; false nếu không.
calendar.capabilities.canSeeAttendees boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc danh sách người tham dự sự kiện; false nếu không.
calendar.capabilities.canSeeConferenceData boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc dữ liệu hội nghị của sự kiện; false nếu không.
calendar.capabilities.canSetConferenceData boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể cập nhật dữ liệu hội nghị của sự kiện; false nếu không.
calendar.capabilities.canAddAttachments boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm tệp đính kèm mới vào sự kiện; false nếu không.
calendar.conferenceData Conference data object
Dữ liệu do người dùng tạo. Một đối tượng đại diện cho mọi dữ liệu hội nghị liên quan đến sự kiện này, chẳng hạn như thông tin chi tiết về hội nghị trên Google Meet.
calendar.id string
Mã sự kiện.
calendar.organizer object
Một đối tượng đại diện cho người tổ chức sự kiện.
calendar.organizer.email string
Địa chỉ email của người tổ chức sự kiện.
calendar.recurringEventId string
Mã của một sự kiện định kỳ.

Người tham dự

Đối tượng người tham dự chứa thông tin về từng người tham dự sự kiện trên Lịch Google. Thông tin này có trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Đối tượng người tham dự
attendee.additionalGuests number
Số lượng khách bổ sung mà người tham dự cho biết họ sẽ mời đến. Giá trị mặc định là 0.
attendee.comment string
Bình luận phản hồi của người tham dự (nếu có).
attendee.displayName string
Tên hiển thị của người tham dự.
attendee.email string
Địa chỉ email của người tham dự.
attendee.optional boolean
true nếu người tham dự này được đánh dấu là không bắt buộc phải tham dự; nếu không thì là false.
attendee.organizer boolean
true nếu người tham dự là người tổ chức sự kiện này.
attendee.resource boolean
true nếu người tham dự đại diện cho một tài nguyên, chẳng hạn như phòng hoặc thiết bị; nếu không thì false.
attendee.responseStatus string
Trạng thái phản hồi của người tham dự. Các giá trị có thể có bao gồm:
  • accepted: Người tham dự đã chấp nhận lời mời tham gia sự kiện.
  • declined: Người tham dự đã từ chối lời mời tham gia sự kiện.
  • needsAction: Người tham dự chưa phản hồi lời mời tham gia sự kiện.
  • tentative: Người tham dự đã tạm thời chấp nhận lời mời tham gia sự kiện.
attendee.self boolean
true nếu người tham dự này đại diện cho lịch mà sự kiện này xuất hiện; false nếu không.

Dữ liệu hội nghị truyền hình

Đối tượng dữ liệu hội nghị truyền hình chứa thông tin về các hội nghị truyền hình được đính kèm vào sự kiện trên Lịch Google. Đây có thể là các giải pháp hội nghị truyền hình của Google như Google Meet hoặc hội nghị của bên thứ ba. Thông tin này chỉ có trong đối tượng sự kiện nếu dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Đối tượng dữ liệu hội nghị
conferenceData.conferenceId string
Mã nhận dạng của hội nghị. Mã nhận dạng này nhằm cho phép các ứng dụng theo dõi hội nghị; bạn không nên hiển thị mã nhận dạng này cho người dùng.
conferenceData.conferenceSolution object
Một đối tượng đại diện cho giải pháp hội nghị, chẳng hạn như Hangouts hoặc Google Meet.
conferenceData.conferenceSolution.iconUri string
URI cho biểu tượng mà người dùng nhìn thấy, đại diện cho giải pháp hội nghị truyền hình này.
conferenceData.conferenceSolution.key object
Khoá xác định duy nhất giải pháp hội nghị truyền hình cho sự kiện này.
conferenceData.conferenceSolution.key.type string
Loại giải pháp hội nghị truyền hình. Các giá trị có thể có bao gồm:
  • eventHangout cho Hangouts dành cho người tiêu dùng (http://hangouts.google.com).
  • eventNamedHangout cho Hangouts phiên bản cũ dành cho người dùng Google Workspace (http://hangouts.google.com).
  • hangoutsMeet cho Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Tên hiển thị cho người dùng của giải pháp hội nghị này (không được bản địa hoá).
conferenceData.entryPoints[] list of entry point objects
Danh sách các điểm truy cập hội nghị, chẳng hạn như URL hoặc số điện thoại.
conferenceData.notes string
Ghi chú bổ sung (chẳng hạn như hướng dẫn của quản trị viên miền hoặc thông báo pháp lý) về hội nghị để hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2048 ký tự.
conferenceData.parameters object
Một đối tượng chứa bản đồ dữ liệu tham số đã xác định để tiện ích bổ sung sử dụng.
conferenceData.parameters.addOnParameters object
Bản đồ các khoá và giá trị chuỗi tham số. Các khoá và giá trị này do nhà phát triển tiện ích bổ sung xác định để đính kèm thông tin vào một hội nghị cụ thể cho tiện ích bổ sung sử dụng.

Điểm mục nhập

Đối tượng điểm truy cập mang thông tin về các phương tiện đã thiết lập để truy cập vào một hội nghị nhất định, chẳng hạn như qua điện thoại hoặc video. Thông tin này có trong đối tượng sự kiện khi và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Đối tượng điểm truy cập
entryPoint.accessCode string
Mã truy cập dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.
entryPoint.entryPointFeatures list
Các tính năng của điểm truy cập. Hiện tại, các tính năng này chỉ áp dụng cho các điểm truy cập phone:
  • toll: Điểm truy cập là một cuộc gọi điện thoại có tính phí.
  • toll_free: Điểm truy cập là một cuộc gọi điện thoại miễn phí.
entryPoint.entryPointType string
Loại điểm truy cập. Các giá trị có thể sử dụng là:
  • more: Hướng dẫn bổ sung về cách tham gia hội nghị, chẳng hạn như số điện thoại thay thế. Mỗi hội nghị truyền hình chỉ được có một điểm truy cập more; nếu có thì bạn cũng phải có ít nhất một loại điểm truy cập khác.
  • phone: Tham gia hội nghị qua số điện thoại. Một hội nghị có thể không có hoặc có nhiều điểm truy cập phone. Lịch Google chỉ hiển thị hai điểm truy cập điện thoại đầu tiên, sau khi định dạng và sắp xếp theo thứ tự bảng chữ cái.
  • sip: Tham gia hội nghị qua SIP. Một hội nghị truyền hình chỉ có thể có tối đa một điểm truy cập sip.
  • video: Tham gia hội nghị qua HTTP. Một hội nghị truyền hình chỉ có thể có tối đa một điểm truy cập video.
entryPoint.label string
Nhãn mà người dùng nhìn thấy cho URI điểm truy cập (không được bản địa hoá).
entryPoint.meetingCode string
Mã cuộc họp dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.
entryPoint.passcode string
Mật mã dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.
entryPoint.password string
Mật khẩu dùng để truy cập vào hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.
entryPoint.pin string
Mã PIN dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.
entryPoint.regionCode string
Mã vùng của số điện thoại. Người dùng cần có mã này nếu URI không có mã quốc gia. Giá trị dựa trên danh sách mã vùng CLDR công khai.
entryPoint.uri string
URI của điểm truy cập. Độ dài tối đa là 1.300 ký tự. Định dạng phụ thuộc vào loại điểm truy cập:
  • more: Bạn phải có giản đồ http: hoặc https:.
  • phone: Cần có giản đồ tel:. URI phải bao gồm toàn bộ trình tự quay số (ví dụ: "tel:+12345678900,,,12345678;1234").
  • sip: Bạn phải có giản đồ sip: hoặc sips:. Ví dụ: "sip:12345678@myprovider.com".
  • video: Bạn phải có giản đồ http: hoặc https:.

Đối tượng sự kiện trên Drive

Đối tượng sự kiện trên Drive là một phần của đối tượng sự kiện tổng thể, chứa thông tin về Google Drive của người dùng và nội dung trong đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Drive.

Đối tượng sự kiện trên Drive
drive.activeCursorItem Drive item object
Mục Drive hiện đang hoạt động.
drive.selectedItems[] list of Drive item objects
Danh sách các mục (tệp hoặc thư mục) được chọn trong Drive.

Mục trên Drive

Đối tượng mục trên Drive chứa thông tin về các mục cụ thể trên Drive, chẳng hạn như tệp hoặc thư mục.

Đối tượng mục trên Drive
item.addonHasFileScopePermission boolean
Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được quyền uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho mục này; nếu không, trường này là false.
item.id string
Mã nhận dạng của mục đã chọn.
item.iconUrl string
URL của biểu tượng đại diện cho mục đã chọn.
item.mimeType string
Loại MIME của mục đã chọn.
item.title string
Tiêu đề của mục đã chọn.

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

Đối tượng sự kiện Gmail là một phần của đối tượng sự kiện tổng thể mang thông tin về thư Gmail của người dùng. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Gmail.

Đối tượng sự kiện Gmail
gmail.accessToken string
Mã truy cập dành riêng cho Gmail. Sử dụng mã thông báo này với phương thức GmailApp.setCurrentMessageAccessToken để cấp cho tiện ích bổ sung của bạn quyền truy cập tạm thời vào thư Gmail hiện đang mở của người dùng hoặc cho phép tiện ích bổ sung của bạn soạn thư nháp mới.
gmail.bccRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận "BCC:" hiện có trong bản nháp mà tiện ích bổ sung đang soạn. Để bật trường này, hãy đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.
gmail.ccRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận "CC:" hiện có trong bản nháp mà tiện ích bổ sung đang soạn. Để bật trường này, hãy đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.
gmail.messageId string
Mã của thư Gmail đang mở.
gmail.threadId string
Mã của chuỗi email hiện đang mở trong Gmail.
gmail.toRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận trong trường "Đến:" hiện có trong thư nháp mà tiện ích bổ sung đang soạn. Để bật trường này, hãy đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.

Đối tượng sự kiện của Tài liệu

Đối tượng sự kiện của Tài liệu là một phần của đối tượng sự kiện tổng thể, mang thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Tài liệu.

Đối tượng sự kiện của Tài liệu
docs.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép.
Mã nhận dạng của tài liệu đang mở trong giao diện người dùng của Tài liệu.
docs.title string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng uỷ quyền.
Tiêu đề của tài liệu đang mở trong giao diện người dùng của Tài liệu.
docs.addonHasFileScopePermission boolean
Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được https://www.googleapis.com/auth/drive.file phạm vi uỷ quyền cho tài liệu đang mở trong giao diện người dùng của Tài liệu; nếu không, trường này là false.
docs.matchedUrl.url string
Chỉ hiển thị nếu đáp ứng các điều kiện sau:
  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Tài liệu. Để sử dụng trường này, bạn phải định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Đối tượng sự kiện của Trang tính

Đối tượng sự kiện của Trang tính là một phần của đối tượng sự kiện tổng thể, mang thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Trang tính.

Đối tượng sự kiện của Trang tính
sheets.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã nhận dạng của bảng tính đang mở trong giao diện người dùng của Trang tính.
sheets.title string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bảng tính đang mở trong giao diện người dùng của Trang tính.
sheets.addonHasFileScopePermission boolean
Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được quyền uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho bảng tính đang mở trong giao diện người dùng của Trang tính; nếu không, trường này là false.
sheets.matchedUrl.url string
Chỉ hiển thị nếu đáp ứng các điều kiện sau:
  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang tính. Để sử dụng trường này, hãy định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Đối tượng sự kiện trên Trang trình bày

Đối tượng sự kiện của Trang trình bày là một phần của đối tượng sự kiện tổng thể, mang thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Trang trình bày.

Đối tượng sự kiện trên Trang trình bày
slides.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã nhận dạng của bản trình bày đang mở trong giao diện người dùng của Trang trình bày.
slides.title string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bản trình bày đang mở trong giao diện người dùng của Trang trình bày.
slides.addonHasFileScopePermission boolean
Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho bản trình bày đang mở trong giao diện người dùng của Trang trình bày; nếu không, trường này là false.
slides.matchedUrl.url string
Chỉ hiển thị nếu đáp ứng các điều kiện sau:
  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang trình bày. Để sử dụng trường này, hãy định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}