Định cấu hình tính năng tích hợp giao diện người dùng trong Drive

Để hiển thị ứng dụng của bạn trong Google Drive khi người dùng tạo hoặc mở một tệp, bạn trước tiên phải thiết lập chế độ tích hợp giao diện người dùng (UI) Drive. Bạn cũng cần phải định cấu hình để liệt kê ứng dụng của mình trong Google Workspace Marketplace.

Bật API Drive

Trước khi sử dụng các API của Google, bạn phải bật các API này trong Google Cloud dự án. Bạn có thể bật một hoặc nhiều API trong một Google Cloud dự án.

Để bắt đầu tích hợp với giao diện người dùng Google Drive, bạn phải bật API Drive. Điều này cho phép bạn truy cập vào API và tích hợp giao diện người dùng các tính năng AI mới.

  • Trong bảng điều khiển Google Cloud, hãy bật API Google Drive.

    Bật API

Thiết lập tính năng tích hợp giao diện người dùng Drive

  1. Trong Bảng điều khiển API của Google, hãy chuyển đến Trình đơn > API và Dịch vụ > API và API đã bật các dịch vụ của Google.

    Chuyển đến phần API đã bật và các dịch vụ

  2. Ở cuối các API và Trang tổng quan dịch vụ, nhấp vào API Google Drive. Chiến lược phát hành đĩa đơn Trang cấu hình API Google Drive sẽ xuất hiện.
  3. Chọn thẻ Tích hợp giao diện người dùng Drive.
  4. (Không bắt buộc) Nhập tên vào trường Tên ứng dụng. Ứng dụng tên được hiển thị với người dùng trong thẻ Quản lý ứng dụng trong Drive phần cài đặt.
  5. (Không bắt buộc) Nhập nội dung mô tả ngắn chỉ gồm một dòng vào phần Mô tả ngắn . Mô tả ngắn được hiển thị với người dùng trong thẻ Quản lý ứng dụng trong Cài đặt Drive.
  6. (Không bắt buộc) Nhập nội dung mô tả đầy đủ vào trường Nội dung mô tả dài.
  7. Tải lên một hoặc nhiều Biểu tượng ứng dụng để hiển thị trong danh sách của người dùng ứng dụng Drive đã kết nối và trong mục "Mở bằng" trình đơn theo bối cảnh. Biểu tượng phải ở định dạng PNG với nền trong suốt. Các biểu tượng có thể mất tối đa 24 giờ mới xuất hiện trong Drive.

  8. Cách sử dụng "Mở bằng" trong giao diện người dùng Drive trình đơn mục, hãy nhập URL tới ứng dụng của bạn trong Trường Mở URL. URL này được sử dụng bởi lệnh "Mở bằng" trình đơn theo bối cảnh.

    • URL này phải chứa tên miền đủ điều kiện; localhost không cơ quan.
    • Người dùng ứng dụng của bạn phải truy cập được URL này. Nếu bạn có nhiều phiên bản ứng dụng, chẳng hạn như một phiên bản cho công khai và một bản phát hành dành cho một số người dùng chọn lọc, từng phiên bản nên sử dụng một URL duy nhất. Sau đó, bạn có thể tạo các ứng dụng khác nhau cho từng phiên bản.
    • Bạn phải xác minh quyền sở hữu URL này trước khi có thể đăng ứng dụng lên Google Workspace Marketplace.
    • Theo mặc định, tham số truy vấn state được nối thêm vào URL này để chuyển từ giao diện người dùng Drive vào ứng dụng của bạn. Để biết thông tin về nội dung của tham số state, hãy xem state tham số.
  9. (Không bắt buộc) Nhập loại MIME mặc định và đuôi tệp vào Loại MIME mặc định và trường Đuôi tệp mặc định. MIME mặc định loại tệp và đuôi tệp đại diện cho các tệp được tạo riêng cho ứng dụng của bạn mở. Ví dụ: ứng dụng của bạn có thể mở một định dạng tích hợp sẵn để phân lớp và chỉnh sửa hình ảnh. Chỉ bao gồm nội dung nghe nhìn chuẩn các loại và đảm bảo không có lỗi chính tả. Nếu ứng dụng của bạn chỉ mở tệp lối tắt của bên thứ ba, bạn có thể để trống loại MIME.

  10. (Không bắt buộc) Nhập loại MIME phụ và đuôi tệp trong phần Phụ Loại MIME và trường Đuôi tệp phụ. Loại MIME phụ và đuôi tệp thể hiện các tệp mà ứng dụng của bạn có thể mở, nhưng không cụ thể cho ứng dụng của bạn. Ví dụ: ứng dụng của bạn có thể là một ứng dụng chỉnh sửa hình ảnh mở ra Hình ảnh PNG và JPG. Chỉ bao gồm nội dung nghe nhìn chuẩn các loại và đảm bảo không có lỗi chính tả. Nếu ứng dụng của bạn chỉ mở tệp lối tắt của bên thứ ba, bạn có thể để trống loại MIME.

  11. Cách sử dụng "Mới" trong giao diện người dùng Drive và yêu cầu người dùng tạo một tệp bằng ứng dụng của bạn, hãy chọn hộp Tạo tệp. URL mới và không bắt buộc Trường Tên tài liệu xuất hiện.

    • URL này phải chứa tên miền đủ điều kiện; localhost không cơ quan.
    • Bạn phải xác minh quyền sở hữu đối tượng này URL trước khi có thể đăng ứng dụng lên Google Workspace Marketplace.
    • Theo mặc định, tham số truy vấn state được nối thêm vào URL này để chuyển từ giao diện người dùng Drive vào ứng dụng của bạn. Để biết thông tin về nội dung của tham số state, hãy xem state tham số.
  12. Nhập URL vào trường URL mới. URL này được sử dụng bởi giao diện người dùng "Mới" nút để chuyển hướng người dùng đến ứng dụng của bạn.

  13. (Không bắt buộc) Nếu bạn muốn ứng dụng của mình mở các tệp mà Google Workspace hỗ trợ, chọn hộp Đang nhập.

  14. (Không bắt buộc) Nếu ứng dụng của bạn phải quản lý tệp trên bộ nhớ dùng chung, hãy kiểm tra Hộp Hỗ trợ bộ nhớ dùng chung. Để biết thêm thông tin về cách hỗ trợ trong ứng dụng của bạn, hãy xem bài viết Triển khai bộ nhớ dùng chung .

  15. Nhấp vào Gửi.

Yêu cầu phạm vi drive.install

Để cho phép ứng dụng xuất hiện dưới dạng tuỳ chọn trong phần "Mở bằng" hoặc "Mới" thực đơn yêu cầu phạm vi https://www.googleapis.com/auth/drive.install để tích hợp thông qua giao diện người dùng Drive. Khi yêu cầu phạm vi này, người dùng sẽ nhận được một hộp thoại tương tự như sau:

Hộp thoại cài đặt của giao diện người dùng Google Drive.
Hình 1. Hộp thoại cài đặt khi sử dụng phạm vi cho giao diện người dùng Drive.

Để biết thêm thông tin về phạm vi mà bạn có thể yêu cầu cho các ứng dụng Drive, và cách yêu cầu chúng, hãy xem phần uỷ quyền và xác thực theo API cụ thể .

Tham số state

Theo mặc định, tham số state được thêm vào cả URL mở và URL mới để truyền dữ liệu từ giao diện người dùng Drive vào ứng dụng của bạn. Thông số này chứa một chuỗi được mã hoá JSON với các biến mẫu và dữ liệu về cho ứng dụng của bạn. Các biến được thêm vào phụ thuộc vào loại URL được sử dụng (Mở URL hoặc URL mới):

Biến mẫu Mô tả Ứng dụng URL
{ids} Đang mở danh sách mã tệp được phân tách bằng dấu phẩy. Mở URL
{exportIds} Xuất danh sách mã tệp được phân tách bằng dấu phẩy (chỉ sử dụng) khi mở tài liệu Google tích hợp sẵn). Mở URL
{resourceKeys} Từ điển JSON gồm các mã tệp được liên kết với tài nguyên tương ứng khoá. Mở URL
{folderId} Mã của thư mục mẹ. URL mới
{folderResourceKey} Khoá tài nguyên của thư mục mẹ. URL mới
{userId} Mã hồ sơ xác định người dùng. Mở URL và URL mới
{action} Hành động đang được thực hiện. Giá trị là open khi sử dụng URL Mở hoặc create khi sử dụng một URL mới. Mở URL và URL mới

Tham số state được mã hoá URL, vì vậy ứng dụng của bạn phải xử lý ký tự thoát và phân tích cú pháp tệp đó dưới dạng JSON. Ứng dụng có thể phát hiện giá trị create trong Tham số state để xác minh yêu cầu tạo tệp.

Ví dụ về thông tin trạng thái trong JSON cho một URL mới

Thông tin state cho một URL mới là:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Ví dụ về thông tin trạng thái trong JSON cho một URL mở

Thông tin state cho một URL đang mở là:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Các mã nhận dạng và khoá tài nguyên được dùng để tìm nạp siêu dữ liệu của tệp và tệp tải xuống nội dung. Sau khi có mã nhận dạng tệp và mã truy cập, ứng dụng có thể kiểm tra quyền, tìm nạp siêu dữ liệu tệp và tải nội dung tệp xuống như được mô tả trong phương thức files.get.

Ứng dụng đã cài đặt phải có khả năng tạo, quản lý và mở các thao tác được khởi chạy từ giao diện người dùng Drive. Để tìm hiểu thêm, hãy xem bài viết Tích hợp với "Mới" của giao diện người dùng Drive nút hoặc Tích hợp với tính năng "Mở bằng" của giao diện người dùng Drive bối cảnh .