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

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

Đối tượng sự kiện là cấu trúc JSON được tạo và truyền tự động dưới dạng tham số để kích hoạt hoặc gọi lại các hàm khi người dùng tương tác với một tiện ích bổ sung. Các đố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 gọi lại phía máy chủ của tiện ích bổ sung.

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

• Điều kiện kích hoạt trang chủ. Mỗi hàm homepageTrigger mà bạn xác định sẽ tự động được chuyển một 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 điều kiện 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 hai trường hợp khác; các trường liên quan đến tiện ích và thông tin theo ngữ cảnh bị bỏ qua.

• Trình kích hoạt theo bối cảnh. Mỗi ứng dụng lưu trữ cung cấp một nhóm trình kích hoạt theo ngữ cảnh khác nhau kích hoạt khi người dùng vào một ngữ cảnh cụ thể. Ví dụ:

  • Gmail cung cấp điều kiện kích hoạt theo ngữ cảnh khi người dùng mở một thông báo và một lựa chọn khác khi người dùng soạn thư.
  • Lịch Google cung cấp một điều kiện kích hoạt theo ngữ cảnh cho thời điểm người dùng mở một sự kiện.
  • Google Drive cung cấp điều kiện kích hoạt theo ngữ cảnh khi người dùng chọn tệp trên Drive.

  Khi điều kiện kích hoạt theo ngữ 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 vào đó đối tượng sự kiện dưới dạng thông số. Các đối tượng sự kiện được tạo khi trình kích hoạt theo ngữ cảnh kích hoạt chứa tất cả các trường có trong đối tượng sự kiện trình kích hoạt trang chủ, cùng với các trường chứa thông tin theo ngữ cảnh.

• Thao tác của tiện ích. Các đối tượng sự kiện cũng được dùng để cung cấp tính tương tác của tiện ích, sử dụng cùng một mô hình hành động mà các tiện ích bổ sung của Gmail sử dụng. Tiện ích bổ sung của Google Workspace sử dụng tất cả các hàm trình xử lý tiện ích, đối tượng Action và phản hồi hành động giống nhau. Tuy nhiên, trong Tiện ích bổ sung của Google Workspace, đối tượng sự kiện hành động đưa vào nhiều thông tin hơn nữa mà một hàm callback có thể hoạt động.

  Các đối tượng sự kiện được tạo do các 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 trình 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.

• Xem trước điều kiện kích hoạt đường liên kết. 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ụ của 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 đáp ứng mẫu, linkPreviewTriggers sẽ được kích hoạt và một đối tượng sự kiện có chứa đường liên kết được chuyển đến hàm callback. 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 và thẻ thông minh 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 hành động tiện ích để cho phép người dùng tương tác với thẻ xem trước và nội dung của thẻ đó.

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 các đối tượng sự kiện trong Tiện ích của Google Workspace. Sự kiện cấu trúc đối tượng bao gồm commonEventObject trường cấp cao nhất dành cho thông tin độc lập với máy chủ lưu trữ. 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ủ sau đây, do ứng dụng lưu trữ đang hoạt động xác định: gmailEventObject, calendarEventObject hoặc driveEventObject.

Để tương thích ngược, đối tượng sự kiện của Tiện ích bổ sung Google Workspace cũng bao gồm tất cả các trường ban đầu được sử dụng trong đối tượng sự kiện hành động của tiện ích bổ sung Gmail. Các trường này được liệt kê trong bảng bên dưới trong phần "Trường tiện ích bổ sung gốc dành cho Gmail"; thông tin trong các trường này được tái tạo trong cấu trúc đối tượng mới.

Đố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ủ đế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 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 trang chủ và trình kích hoạt theo ngữ cảnh, tiện ích bổ sung còn tạo và truyền đối tượng sự kiện thành hàm gọi lại 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 tiện ích của người dùng khách hàng. Ví dụ: tiện ích bổ sung của bạn có thể tìm văn bản mà người dùng đã nhập vào Tiện ích TextInput trong Đối tượng eventObject.commentEventObject.formInputs.

Dữ liệu đầu vào của biểu mẫu bộ chọn ngày giờ

Hàm gọi lại thao tác có thể nhận giá trị tiện ích hiện tại trong trường commonEventObject.formInputs. Giá trị này bao gồm cả những giá trị ngày hoặc giờ mà người dùng đã chọn trong bộ chọn ngày hoặc giờ các tiện ích khác nhau. Tuy nhiên, cấu trúc của thông tin sẽ khác nhau tuỳ thuộc vào việc tiện ích được định cấu hình dưới dạng bộ chọn ngày-giờ, bộ chọn chỉ ngày hoặc 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 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. Chỉ hiển thị trong đối tượng sự kiện nếu ứng dụng lưu trữ là Lịch Google.

Bảng sau đây liệt kê các trường có trong 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 xuất hiện trong đối tượng sự kiện khi và chỉ khi dữ liệu có trong Lịch sự kiện và tiện ích bổ sung sẽ đặt addOns.calendar.currentEventAccess tệp kê khai đến READ hoặc READ_WRITE.

Người tham dự

Đối tượng người tham dự mang thông tin về từng người tham dự vào Lịch Google sự kiện. Thông tin này xuất hiện trong đối tượng sự kiện khi và chỉ khi dữ liệu hiện diện trong sự kiện trên Lịch và tiện ích bổ sung sẽ thiết lập addOns.calendar.currentEventAccess tệp kê khai đến READ hoặc READ_WRITE.

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

Đối tượng dữ liệu hội nghị truyền hình mang thông tin về các hội nghị đượ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ị của Google, chẳng hạn như Google Meet hoặc hội nghị của bên thứ ba. 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 Lịch và tiện ích bổ sung đặt trường tệp kê khai addOns.calendar.currentEventAccess thành READ hoặc READ_WRITE.

Đ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 truy cập thiết lập một hội nghị truyền hình cụ thể, 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 Lịch và tiện ích bổ sung này đặt addOns.calendar.currentEventAccess tệp kê khai đến READ hoặc READ_WRITE.

Đối tượng sự kiệ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 của Google Drive đó. Chỉ hiện diện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Google 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 sự kiện trên Gmail

Đối tượng sự kiện của 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. Phương diện này chỉ xuất hiện trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Gmail.

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

Đối tượng sự kiện của Docs là một phần của đối tượng sự kiện tổng thể, chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Thuộc tính này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Google Tài liệu.

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

Đối tượng sự kiện trên 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ể, chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Mã này chỉ có trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Google Trang tính.

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

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

Đối tượng sự kiện trên 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 trong đó. Mã này chỉ có trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Google Trang trình bày.

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