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

Tiện ích bổ sung của Google Workspace có thể giúp 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 cho người dùng cung cấp thông tin liên quan bổ sung, tự động hoá công việc và kết nối với bên thứ ba hệ thống lên 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 tiện ích bổ sung của Google Workspace trong Google Drive nếu biểu tượng của ứng dụng xuất hiện trong biểu tượng ở bên phải giao diện người dùng Drive. Đáp Tiện ích bổ sung của Google 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 trong khi đang ở trong Google Drive, tiện ích bổ sung sẽ thực thi drive.homepageTrigger tương ứng (nếu có). Hàm này tạo và trả về thẻ trang chủ vào Google Drive để hiển thị. Nếu không drive.homepageTrigger được xác định thì thẻ trang chủ chung sẽ được hiển thị thay thế.
  • Nếu người dùng chọn một hoặc nhiều mục trong Google Drive, rồi nhấp vào tiện ích bổ sung biểu tượng 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 lệnh drive.onItemsSelectedTrigger hàm theo ngữ cảnh (nếu có). Hàm này tạo Google Drive của tiện ích bổ sung "các mục đã chọn" theo ngữ cảnh giao diện rồi trả về Google Drive để hiển thị.

Xây dựng giao diện tiện ích bổ sung trong Drive

Bạn có thể xây dựng giao diện mở rộng Google Drive bằng cách làm theo các bước:

  1. Quyết định xem bạn có muốn tiện ích bổ sung của mình có phiên bản dành riêng cho Drive hay không trang chủ. Bạn cũng nên quyết định xem có muốn cung cấp giao diện theo ngữ cảnh cho thời điểm người dùng chọn các mục trên Drive.
  2. Thêm thông tin thích hợp addOns.commonaddOns.drive trường đến dự án tập lệnh tiện ích bổ sung tệp kê khai, bao gồm bất kỳ phạm vi Drive nào cần thiết.
  3. Nếu bạn đang cung cấp trang chủ dành riêng cho Drive, triển khai drive.homepageTrigger để tạo giao diện này. Bạn cũng có thể chọn sử dụng common.homepageTrigger cho nhiều máy chủ Google Workspace.
  4. Nếu đang cung cấp giao diện chọn mục theo ngữ cảnh của Drive, bạn phải triển khai drive.onItemsSelectedTrigger hàm kích hoạt theo ngữ cảnh để tạo giao diện này. Xem Giao diện theo ngữ cảnh của Drive cho các mục đã chọn) để biết thông tin chi tiết.
  5. Triển khai các hàm callback được liên kết để phản hồi các lệnh gọi lại của người dùng Lượt tương tác trên giao diện người dùng, chẳng hạn như lượt nhấp vào nút.

Trang chủ của Drive

Google Drive hỗ trợ hiển thị tiện ích bổ sung của Google Workspace trang chủ. Để hiển thị trang chủ chung của tiện ích bổ sung trong Google Drive, bạn chỉ cần đảm bảo ở đó là trường addOns.drive trong tệp kê khai của 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 của tiện ích bổ sung. Hàm này tự động được gọi để tạo Trang chủ của Drive khi cần thiết. Bạn phải triển khai hàm này để tạo và trả về một giá trị duy nhất Card hoặc một mảng Card tạo nên trang chủ. Hàm kích hoạt trang chủ được truyền đối tượng sự kiện dưới dạng tham số chứa một số thông tin chung như thông tin 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 của trang chủ.

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

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

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

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

  3. Triển khai hàm được đặt tên trong 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 giá trị duy nhất Card hoặc một mảng Card.

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

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

Một đối tượng sự kiện được tạo và truyền vào drive.homepageTrigger hoặc drive.onItemsSelectedTrigger hàm kích hoạt 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 hoạt động của tiện ích bổ sung.

Toàn bộ cấu trúc của đối tượng sự kiện được mô tả trong Đối tượng sự kiện. Khi Drive là ứng dụng lưu trữ hoạt động của tiện ích bổ sung, đối tượng sự kiện theo ngữ cảnh bao gồm Đối tượng sự kiện Drive chứa thông tin ứng dụng khách dành riêng cho Drive.

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

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

    {
      "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"
          },
          ...
        ]
      },
      ...
    }