Xây dựng giao diện Lịch Google

Google Workspace tiện ích bổ sung có thể cung cấp 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. Điều này cho phép bạn cung cấp thêm cho người dùng thông tin liên quan, tự động hoá việc cần làm và kết nối 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 một 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 một giao diện 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 tiện ích bổ sung

Tuỳ thuộc vào cách mở phần mở rộng đó, Google Workspace tiện ích bổ sung có thể xác định giao diện trang chủ, giao diện sự kiện trên Lịch, 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 trong chế độ xem lịch, thì tiện ích bổ sung sẽ thực thi hàm calendar.homepageTrigger tương ứng (nếu có). Hàm này tạo và trả về một thẻ trang chủ cho Lịch Google để hiển thị. Nếu không xác định hàm calendar.homepageTrigger nào, 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, sau đó 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 eventOpenTrigger tươ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 một hàm eventAttachmentTrigger, thì tiện ích bổ sung đó sẽ xuất hiện dưới dạng một trì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àm eventAttachmentTrigger sẽ tạo giao diện lựa chọn tệp đính kèm của tiện ích bổ sung và trả về Lịch Google để hiển thị.

Xây dựng giao diện Lịch bổ sung

Bạn có thể mở rộng Lịch Google bằng một Tiện ích bổ sungGoogle Workspace bằng cách làm theo các bước sau:

  1. 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. Đồng thời, quyết định xem bạn có muốn cung cấp một giao diện tuỳ chỉnh trong khi người dùng chỉnh sửa các sự kiện trên Lịch hay không.
  2. Thêm các trường addOns.commonaddOns.calendar phù hợp vào dự án tập lệnh tiện ích bổ sung tệp kê khai, bao gồm mọi phạm vi bắt buộc.
  3. 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.homepageTrigger cho nhiều máy chủ Google Workspace .
  4. 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. Hãy xem bài viết Mở rộng giao diện sự kiện trên Lịch để biết thông tin chi tiết.
  5. Triển khai các hàm gọi lại liên quan cần thiết để phản hồi các lượt 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ị Google Workspace trang chủ cho tiện ích bổ sung. Để hiển thị trang chủ chung của tiện ích bổ sung trong Lịch Google, bạn chỉ cần đảm bảo 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 của 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 tiện ích bổ sung. Hàm này được tự động gọi để tạo trang chủ Lịch khi cần. Bạn phải triển khai hàm này để tạo và trả về một Card hoặc một mảng đối tượng Card tạo nên trang chủ. Hàm kích hoạt trang chủ được chuyể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 như nền tảng của ứng dụng khách. Bạn có thể sử dụng dữ liệu đối tượng sự kiện để điều chỉnh cấu trúc trang chủ.

Mở rộng giao diện sự kiện trên Lịch

Lịch Google sử dụng 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 sự kiện trên Lịch. Khi kích hoạt, trình kích hoạt sẽ thực thi hàm kích hoạt theo ngữ cảnh được 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 hoặc một mảng đối tượng Card để Lịch hiển thị 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à chuyể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. Đối tượng sự kiện cũng được tạo và truyền đến các hàm homepageTrigger khi một tiện ích bổ sung được mở lần đầu 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 nội dung Đối tượng sự kiện. Khi Lịch là ứng dụng lưu trữ hành động của tiện ích bổ sung, trình kích hoạt theo ngữ cảnh và sự kiện tương tác với tiện ích sẽ bao gồm trường đối tượng Sự kiện trên lịch mang thông tin ứng dụng lịch dành riêng.

Cập nhật sự kiện trên Lịch

Ngoài ngữ cảnh calendar.eventOpenTrigger được kích hoạt khi người dùng mở 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 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:

  • Thêm một hoặc nhiều người tham dự.
  • Loại bỏ 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 kích hoạt, trình kích hoạt này sẽ thực thi chức năng 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 chỉnh sửa sự kiện trên Lịch.

calendar.eventUpdateTrigger thường dùng để thực hiện một hoặc nhiều việ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 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 một hệ thống của 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 có 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 của tiện ích bổ sung đó calendar.currentEventAccess thành WRITE hoặc READ_WRITE. Việc này cũng yêu cầu 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ị trình bày 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ề 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 xây dựng một tiện ích bổ sung giúp thêm các giải pháp hội nghị mới. 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 chỉ đơn giản 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.