Xây dựng giao diện Google Drive

Google Workspace tiện ích bổ sung có thể cung cấp giao diện tuỳ chỉnh khi người dùng đang sử dụng Google Drive. Đ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 hóa các nhiệm vụ và kết nối hệ thống của bên thứ ba với Google Drive.

Truy cập vào giao diện người dùng tiện ích bổ sung

Bạn có thể mở một Google Workspace tiện ích bổ sung trong Google Drive nếu biểu tượng của tiện ích đó xuất hiện trong cột biểu tượng ở bên phải giao diện người dùng Drive. Tiện ích bổ sungGoogle Workspace Có thể xác định giao diện trang chủ, giao diện chọn mục hoặc cả hai:

  • Nếu người dùng nhấp vào biểu tượng tiện ích bổ sung khi đang ở trong Google Drive, thì tiện ích bổ sung sẽ thực thi hàm drive.homepageTrigger tương ứng (nếu có). Hàm này tạo và trả về một thẻ trang chủ cho Google Drive để hiển thị. Nếu không có hàm drive.homepageTrigger nào được xác định, thẻ trang chủ chung sẽ xuất hiện.
  • Nếu người dùng chọn một hoặc nhiều mục trong Drive rồi nhấp vào biểu tượng tiện ích bổ sung hoặc chọn các mục trong khi tiện ích bổ sung đang mở, thì tiện ích bổ sung sẽ thực thi hàm theo ngữ cảnh drive.onItemsSelectedTrigger tương ứng (nếu có). Hàm này xây dựng giao diện của tiện ích bổ sung ngữ cảnh "các mục được chọn" trên Drive và trả về cho Google Drive để hiển thị.

Xây dựng giao diện bổ sung Drive

Bạn có thể tạo giao diện mở rộng Google Drive bằng cách làm theo các bước chung 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 Drive hay không. Ngoài ra, hãy quyết định xem bạn có muốn cung cấp giao diện theo ngữ cảnh khi người dùng chọn các mục trên Drive hay không.
  2. Thêm các trường addOns.commonaddOns.drive thích hợp vào tệp kê khai dự án tập lệnh bổ sung, bao gồm cả mọi phạm vi Drive cần thiết.
  3. Nếu bạn đang cung cấp trang chủ dành riêng cho Drive, hãy triển khai hàm drive.homepageTrigger để tạo giao diện này. Bạn cũng có thể chọn sử dụng giao diện common.homepageTrigger cho nhiều Google Workspace máy chủ.
  4. Nếu đang cung cấp giao diện lựa chọn mục theo ngữ cảnh trên Drive, bạn phải triển khai hàm kích hoạt theo ngữ cảnh drive.onItemsSelectedTrigger để tạo giao diện này. Xem Giao diện ngữ cảnh trên Drive cho các mục đã chọn) để biết chi tiết.
  5. 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 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ủ Drive

Google Drive hỗ trợ hiển thị Google Workspace tiện ích bổ sung trang chủ. Để hiển thị trang chủ tiện ích bổ sung của bạn trong Google Drive, bạn chỉ cần đảm bảo có trường addOns.drive trong tệp kê khai tiện ích bổ sung.

Ngoài ra, hãy thêm drive.homepageTrigger vào tệp kê khai tiện ích bổ sung để cung cấp trang chủ dành riêng cho Drive.

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 bổ sung của bạn. Hàm này tự động được gọi để xây dựng trang chủ của Drive 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 các đố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 khách hàng. Bạn có thể sử dụng dữ liệu đối tượng sự kiện để điều chỉnh việc tạo trang chủ.

Giao diện ngữ cảnh trên Drive cho các mục đã chọn

Google Drive 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ọn một hoặc nhiều mục trên Drive. Khi kích hoạt, trình kích hoạt sẽ thực thi hàm trình kích hoạt theo ngữ cảnh được chỉ định bởi trường drive.onItemsSelectedTrigger.runFunction trong tệp kê khai bổ sung.

Để tạo giao diện lựa chọn mục theo ngữ cảnh cho Drive, bạn phải làm như sau:

  1. Đảm bảo tệp kê khai tiện ích bổ sung bao gồm phạm vi https://www.googleapis.com/auth/drive.addons.metadata.readonly

  2. Đảm bảo tệp kê khai bao gồm mục drive.onItemsSelectedTrigger.

  3. Triển khai hàm có tên trong trường drive.onItemsSelectedTrigger. 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.

  4. Cũng như với mọi thẻ, bạn phải triển khai mọi hàm gọi lại được dùng để cung cấp khả năng tương tác với tiện ích cho giao diện. Ví dụ: nếu bạn thêm một nút vào giao diện, nút đó phải có một Thao tác đính kèm và một hàm gọi lại được triển khai để chạy khi người dùng nhấp vào nút.

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

Một đối tượng sự kiện được tạo và chuyển vào hàm kích hoạt drive.homepageTrigger hoặc drive.onItemsSelectedTrigger khi các hàm đó được gọi. 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ấ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 Drive là ứng dụng máy chủ lưu trữ của tiện ích bổ sung, các đối tượng sự kiện theo ngữ cảnh sẽ bao gồm trường Đối tượng sự kiện Drive mang theo thông tin ứng dụng khách dành riêng cho Drive.

Các đối tượng sự kiện trên Drive theo ngữ cảnh cho trình kích hoạt lựa chọn mục bao gồm thông tin về các mục mà người dùng đã chọn khi trình kích hoạt kích hoạt. Khi người dùng chọn nhiều mục trong Drive, một trong những mục này được coi là một trong những mối quan tâm chính; mục này được gọi là mục con trỏ đang hoạt động.

Đừng cố suy ra mục nào cần sử dụng trong mảng drive.selectedItems.

Ví dụ sau đây cho thấy một đối tượng sự kiện Drive được chuyển đến một hàm drive.onItemsSelectedTrigger:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }