Tiện ích bổ sung Google Workspace có thể cung cấp các giao diện tuỳ chỉnh khi người dùng đang xem hoặc chỉnh sửa lịch và sự kiện trên Lịch. Nhờ đó, bạn có thể cung cấp cho người dùng thông tin bổ sung có liên quan, tự động hoá các tác vụ và kết nối các hệ thống bên thứ ba với Lịch Google.
Khi tạo giao diện tiện ích bổ sung cho Lịch Google, bạn có thể cung cấp một trang chủ. Bạn có thể dùng cùng một trang chủ cho nhiều máy chủ lưu trữ hoặc thiết kế một trang chủ cụ thể cho Lịch Google.
Tiện ích bổ sung của bạn cũng có thể xác định một giao diện xuất hiện khi người dùng mở một sự kiện trên Lịch.
Truy cập vào giao diện người dùng của tiện ích bổ sung
Tuỳ thuộc vào cách mở, một tiện ích bổ sung của Google Workspace có thể xác định giao diện trang chủ, giao diện sự kiện trên Lịch Google, giao diện chọn tệp đính kèm hoặc cả ba:
- Nếu người dùng nhấp vào biểu tượng tiện ích bổ sung trong chế độ xem lịch, tiện ích bổ sung sẽ thực thi hàm
calendar.homepageTriggertương ứng (nếu có). Hàm này tạo và trả về một thẻ trang chủ cho Lịch để hiển thị. Nếu không có hàmcalendar.homepageTriggernào được xác định, thì một thẻ trang chủ chung sẽ xuất hiện. - Nếu người dùng mở một sự kiện trên Lịch rồi nhấp vào biểu tượng tiện ích bổ sung, hoặc tiện ích bổ sung đang mở khi người dùng mở một sự kiện, thì tiện ích bổ sung sẽ thực thi hàm
eventOpenTriggertương ứng (nếu có). Hàm này tạo giao diện sự kiện trên Lịch của tiện ích bổ sung và trả về Lịch Google để hiển thị. - Nếu tiện ích bổ sung xác định hàm
eventAttachmentTrigger, thì tiện ích bổ sung sẽ xuất hiện dưới dạng nhà cung cấp tệp đính kèm khi người dùng nhấp vào Thêm tệp đính kèm trong khi chỉnh sửa một sự kiện trên Lịch. Khi tiện ích bổ sung được chọn, hàmeventAttachmentTriggersẽ tạo giao diện chọn tệp đính kèm của tiện ích bổ sung và trả về giao diện đó cho Lịch Google để hiển thị.
Tạo giao diện Lịch của tiện ích bổ sung
Bạn có thể mở rộng Google Lịch bằng một tiện ích bổ sung Google Workspace bằng cách làm theo các bước sau:
- Quyết định xem bạn có muốn tiện ích bổ sung của mình có một trang chủ dành riêng cho Lịch hay không. Ngoài ra, hãy quyết định xem bạn có muốn cung cấp giao diện tuỳ chỉnh trong khi người dùng đang chỉnh sửa sự kiện trên Lịch hay không.
- Thêm các trường
addOns.commonvàaddOns.calendarthích hợp vào tệp kê khai của dự án tập lệnh tiện ích bổ sung, bao gồm cả mọi phạm vi bắt buộc. - Nếu bạn đang cung cấp một trang chủ dành riêng cho Lịch, hãy triển khai hàm
calendar.homepageTriggerđể tạo giao diện này. Bạn cũng có thể chọn sử dụng giao diệncommon.homepageTriggercho nhiều máy chủ lưu trữ Google Workspace. - Nếu đang cung cấp một giao diện sự kiện trên Lịch, bạn phải triển khai một hàm
calendar.eventOpenTriggerđể tạo giao diện này. Hãy xem phần Mở rộng giao diện sự kiện trên Lịch để biết thông tin chi tiết. - Triển khai các hàm gọi lại được liên kết cần thiết để phản hồi các hoạt động tương tác của người dùng với giao diện người dùng, chẳng hạn như lượt nhấp vào nút.
Trang chủ của Lịch
Lịch Google hỗ trợ việc hiển thị trang chủ của tiện ích bổ sung Google Workspace.
Để hiện trang chủ chung của tiện ích bổ sung trong Lịch Google, bạn chỉ cần đảm bảo rằng có một trường addOns.calendar trong tệp kê khai của tiện ích bổ sung.
Ngoài ra, hãy thêm calendar.homepageTrigger vào tệp kê khai tiện ích bổ sung để cung cấp một trang chủ dành riêng cho Lịch.
Trong cả hai trường hợp, bạn phải cung cấp tên của một hàm kích hoạt trang chủ trong dự án tập lệnh của tiện ích bổ sung. Hàm này sẽ tự động được gọi để tạo trang chủ Google Lịch khi cần. Bạn phải triển khai hàm này để tạo và trả về một Card duy nhất hoặc một mảng các đối tượng Card tạo nên trang chủ. Hàm kích hoạt trang chủ được truyền một đối tượng sự kiện làm tham số chứa một số thông tin chung, chẳng hạn như nền tảng của ứng dụng. Bạn có thể sử dụng dữ liệu đối tượng sự kiện để điều chỉnh cấu trúc của trang chủ.
Mở rộng giao diện sự kiện trên Lịch
Lịch Google dựa vào một điều kiện kích hoạt theo ngữ cảnh để xác định giao diện (nếu có) cần hiển thị khi người dùng chỉnh sửa một sự kiện trên Lịch. Khi điều kiện kích hoạt hoạt động, điều kiện này sẽ thực thi hàm điều kiện kích hoạt theo bối cảnh do trường calendar.eventOpenTrigger chỉ định trong tệp kê khai của tiện ích bổ sung.
Bạn phải triển khai hàm được đặt tên trong trường calendar.eventOpenTrigger. Hàm này chấp nhận một đối tượng sự kiện làm đối số và phải trả về một đối tượng Card duy nhất hoặc một mảng các đối tượng Card để Lịch hiển thị trong khi người dùng mở sự kiện.
Đối tượng sự kiện
Một đối tượng sự kiện được tạo và truyền đến hàm kích hoạt theo bối cảnh calendar.eventOpenTrigger khi người dùng mở một sự kiện trên Lịch. Hàm kích hoạt có thể dùng thông tin trong đối tượng sự kiện này để xác định cách tạo thẻ bổ sung hoặc kiểm soát hành vi của tiện ích bổ sung. Các đối tượng sự kiện cũng được tạo và truyền đến các hàm homepageTrigger khi người dùng mở tiện ích bổ sung lần đầu tiên và khi người dùng nhấp hoặc chọn các tiện ích tương tác.
Cấu trúc đầy đủ của các đối tượng sự kiện được mô tả trong phần Đối tượng sự kiện. Khi Lịch là ứng dụng lưu trữ đang hoạt động của tiện ích bổ sung, các đối tượng sự kiện tương tác với tiện ích và điều kiện kích hoạt theo bối cảnh sẽ bao gồm trường đối tượng sự kiện trên Lịch mang thông tin cụ thể về ứng dụng Lịch.
Cập nhật sự kiện trên Lịch
Ngoài calendar.eventOpenTrigger theo bối cảnh kích hoạt khi người dùng mở một sự kiện trên Lịch để chỉnh sửa, bạn cũng có thể xác định calendar.eventUpdateTrigger kích hoạt khi người dùng cập nhật và lưu một sự kiện trên Lịch. Điều kiện kích hoạt này chỉ kích hoạt nếu người dùng thực hiện một hoặc nhiều thao tác chỉnh sửa sau đây:
- Thêm một hoặc nhiều người tham dự.
- Xoá một hoặc nhiều người tham dự.
- Thêm hoặc chuyển sang một giải pháp hội nghị truyền hình khác.
Khi trình kích hoạt này kích hoạt, nó sẽ thực thi hàm kích hoạt do trường tệp kê khai calendar.eventUpdateTrigger chỉ định. Hàm này sẽ được thực thi trước khi nội dung chỉnh sửa sự kiện trên Lịch được lưu.
calendar.eventUpdateTrigger thường được dùng để thực hiện một hoặc nhiều thao tác sau:
- Cập nhật giao diện sự kiện trên Lịch của tiện ích bổ sung để phản hồi những thay đổi của người dùng đối với sự kiện trên Lịch.
- Đồng bộ hoá dữ liệu sự kiện trên Lịch với một hệ thống bên thứ ba, chẳng hạn như một hệ thống hội nghị truyền hình được kết nối với Lịch Google.
Nếu cần tiện ích bổ sung điều chỉnh dữ liệu của một sự kiện trên Lịch (chẳng hạn như danh sách người tham dự), bạn phải đặt trường tệp kê khai calendar.currentEventAccess của tiện ích bổ sung thành WRITE hoặc READ_WRITE. Điều này cũng yêu cầu tiện ích bổ sung phải có https://www.googleapis.com/auth/calendar.addons.current.event.write
phạm vi.
Thêm giải pháp hội nghị truyền hình
Giải pháp hội nghị truyền hình là các lựa chọn hội nghị truyền hình của bên thứ ba mà người dùng có thể đính kèm vào sự kiện trên Lịch Google. Tài liệu Tổng quan về hội nghị truyền hình của bên thứ ba cung cấp thông tin chi tiết về cách tạo một tiện ích bổ sung để thêm các giải pháp hội nghị truyền hình mới. Bạn không cần phải tạo giao diện người dùng cho loại tiện ích này; các giải pháp được thêm chỉ xuất hiện dưới dạng lựa chọn trong trình đơn thả xuống của giao diện người dùng sự kiện trên Lịch Google.