Tiện ích bổ sung cho Google Workspace có thể cung cấp giao diện được tuỳ chỉnh khi người dùng xem hoặc chỉnh sửa lịch và sự kiện trên Lịch. Điều này cho phép bạn cung cấp thêm thông tin liên quan cho người dùng, tự động hoá tác vụ và kết nối các hệ thống của bên thứ ba với Lịch Google.
Khi xây dựng giao diện tiện ích bổ sung cho Lịch Google, bạn có thể cung cấp trang chủ. Bạn có thể sử dụng cùng một trang chủ cho nhiều máy chủ 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 giao diện sẽ xuất hiện khi người dùng đang 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ở, 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 của Lịch Google, giao diện lựa 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 khi đang ở chế độ xem lịch, thì 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ủ về Lịch để hiển thị. Nếu bạn không xác định hàmcalendar.homepageTriggernào, thì 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 Lịch của tiện ích bổ sung và quay lại 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 sự kiện trên Lịch. Khi bạn chọn tiện ích bổ sung, hàmeventAttachmentTriggersẽ tạo giao diện lựa chọn tệp đính kèm của tiện ích bổ sung và đưa giao diện đó về Lịch Google để hiển thị.
Xây dựng giao diện tiện ích bổ sung cho Lịch
Bạn có thể mở rộng Lịch Google bằng tiện ích bổ sung của 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ó 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 bổ sung, bao gồm mọi phạm vi bắt buộc. - Nếu bạn cung cấp 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ủ Google Workspace. - Nếu đang cung cấp giao diện sự kiện trên Lịch, bạn phải triển khai hàm
calendar.eventOpenTriggerđể tạo giao diện nà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 callback được liên kết cần thiết để phản hồi các hoạt động tương tác trên giao diện người dùng của người dùng, chẳng hạn như lượt nhấp vào nút.
Trang chủ lịch
Lịch Google hỗ trợ hiển thị trang chủ của Tiện ích bổ sung Google Workspace.
Để hiển thị trang chủ chung của tiện ích bổ sung của bạn trong Lịch Google, bạn chỉ cần đảm bảo có trường addOns.calendar trong tệp kê khai của tiện ích bổ sung.
Ngoài ra, bạn có thể thêm calendar.homepageTrigger vào tệp kê khai tiện ích bổ sung để cung cấp 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 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 tự động được gọi để tạo trang chủ của Lịch Google 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 dưới dạng thông 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 trình kích hoạt theo ngữ cảnh để xác định giao diện (nếu có) sẽ hiển thị khi người dùng chỉnh sửa một sự kiện trên Lịch. Khi kích hoạt, trình kích hoạt sẽ thực thi hàm của trình kích hoạt theo ngữ 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ê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 đang 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 ngữ 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ể sử dụng thông tin trong đối tượng sự kiện này để xác định cách tạo thẻ tiện ích 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 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ữ hoạt động của tiện ích bổ sung, các đối tượng sự kiện tương tác theo ngữ cảnh và tiện ích sẽ bao gồm trường đối tượng sự kiện Lịch chứa thông tin ứng dụng dành riêng cho Lịch.
Cập nhật sự kiện trên Lịch
Ngoài calendar.eventOpenTrigger theo ngữ cảnh sẽ 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 sẽ 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. Trình 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 của trình kích hoạt do trường tệp kê khai calendar.eventUpdateTrigger chỉ định. Hàm này được thực thi trước khi lưu nội dung chỉnh sửa sự kiện Lịch.
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 Lịch của tiện ích bổ sung để phản hồi các 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 hệ thống của bên thứ ba, chẳng hạn như 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 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 đòi hỏi tiện ích bổ sung phải có phạm vi https://www.googleapis.com/auth/calendar.addons.current.event.write.
Thêm giải pháp hội nghị truyền hình
Giải pháp hội nghị đại diện cho các tuỳ chọn hội nghị của bên thứ ba mà người dùng có thể đính kèm vào các sự kiện trên Lịch Google. Tài liệu Tổng quan về tính năng 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 tiện ích bổ sung bổ sung các giải pháp hội nghị mới. Bạn không cần xây dựng giao diện người dùng cho loại tiện ích này; các giải pháp thêm vào chỉ xuất hiện dưới dạng tuỳ 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.