Đị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, trước tiên, bạ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 phải định cấu hình để đăng ứ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 những API đó trong một dự án Google Cloud. Bạn có thể bật một hoặc nhiều API trong một dự án Google Cloud.

Để 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à các tính năng tích hợp giao diện người dùng.

  • 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à dịch vụ đã bật.

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

  2. Ở cuối trang tổng quan API và dịch vụ, hãy nhấp vào API Google Drive. 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ười dùng sẽ nhìn thấy tên ứng dụng trong thẻ Quản lý ứng dụng trong phần cài đặt Drive.
  5. (Không bắt buộc) Nhập nội dung mô tả ngắn gọn một dòng trong trường Mô tả ngắn. Người dùng sẽ thấy nội dung mô tả ngắn trong thẻ Quản lý ứng dụng trong phần cài đặt Drive.
  6. (Không bắt buộc) Nhập nội dung mô tả đầy đủ vào trường Mô tả dài.
  7. Tải một hoặc nhiều Biểu tượng ứng dụng lên để hiển thị trong danh sách ứng dụng Drive đã kết nối của người dùng và trong trình đơn theo bối cảnh "Mở bằng". 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 24 giờ mới xuất hiện trong Drive.

  8. Để sử dụng mục trong trình đơn "Mở bằng" của giao diện người dùng Drive, hãy nhập URL vào ứng dụng của bạn trong trường Open URL (Mở URL). URL này được trình đơn theo bối cảnh "Mở bằng" sử dụng.

    • URL này phải chứa tên miền đủ điều kiện; localhost không hoạt động.
    • Người dùng ứng dụng của bạn phải truy cập được vào 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 bản phát hành công khai và một phiên bản cho bản phát hành hạn chế cho một số người dùng, thì mỗi phiên bản phải sử dụng một URL riêng biệt. Sau đó, bạn có thể tạo các cấu hình ứ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 sẽ được thêm vào URL này để truyền dữ liệu từ giao diện người dùng Drive đến ứng dụng của bạn. Để biết thông tin về nội dung của tham số state, hãy xem Tham số state.
  9. (Không bắt buộc) Nhập các loại MIME mặc định và đuôi tệp vào các trường Loại MIME mặc địnhĐuôi tệp mặc định. Các loại MIME và đuôi tệp mặc định biểu thị các tệp mà ứng dụng của bạn được tạo riêng để mở. Ví dụ: ứng dụng của bạn có thể mở một định dạng tích hợp sẵn để xếp lớp và chỉnh sửa hình ảnh. Chỉ đưa vào các loại nội dung nghe nhìn chuẩn và đảm bảo các nội dung đó 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 hoặc 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 các loại MIME phụ và đuôi tệp trong các trường Loại MIME phụĐuôi tệp phụ. Các loại MIME phụ và đuôi tệp đại diện cho các tệp mà ứng dụng có thể mở nhưng không dành riêng cho ứng dụng đó. Ví dụ: có thể ứng dụng của bạn là một ứng dụng chỉnh sửa hình ảnh mở hình ảnh PNG và JPG. Chỉ đưa vào các loại nội dung nghe nhìn chuẩn và đảm bảo các nội dung đó 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 hoặc tệp lối tắt của bên thứ ba, bạn có thể để trống loại MIME.

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

    • URL này phải chứa tên miền đủ điều kiện; localhost không hoạt động.
    • Bạn phải xác minh quyền sở hữu URL này trước khi có thể đăng ứng dụng của mình trong Google Workspace Marketplace.
    • Theo mặc định, tham số truy vấn state sẽ được thêm vào URL này để truyền dữ liệu từ giao diện người dùng Drive đến ứng dụng của bạn. Để biết thông tin về nội dung của tham số state, hãy xem Tham số state.
  12. Nhập một URL vào trường URL mới. Nút "Mới" sẽ sử dụng URL này để 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 được Google Workspace hỗ trợ, hãy đánh dấu vào hộp Import (Nhập).

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

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

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

Để cho phép các ứng dụng xuất hiện dưới dạng tuỳ chọn trong trình đơn "Mở bằng" hoặc trình đơn "Mới", hãy yêu cầu phạm vi https://www.googleapis.com/auth/drive.install để tích hợp với 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 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 cũng như cách yêu cầu các phạm vi đó, hãy xem phần Thông tin xác thực và uỷ quyền dành riêng cho API.

Thông số state

Theo mặc định, tham số state sẽ được thêm vào cả URL mở và URL mới để chuyển dữ liệu từ giao diện người dùng Drive sang ứng dụng của bạn. Tham 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ề yêu cầu cho ứng dụng của bạn. Các biến được thêm phụ thuộc vào loại URL được sử dụng (URL mở hoặc URL mới):

Biến mẫu Nội dung mô tả Ứng dụng URL
{ids} Một danh sách mã tệp được phân tách bằng dấu phẩy đang được mở. Mở URL
{exportIds} Danh sách mã tệp được phân tách bằng dấu phẩy đang được xuất (chỉ được sử dụng khi mở tài liệu tích hợp của Google). Mở URL
{resourceKeys} Từ điển JSON gồm các mã tệp được liên kết với các khoá tài nguyên tương ứng. 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ị sẽ là open khi dùng URL đang mở hoặc create khi dùng 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ý các ký tự thoát và phân tích cú pháp mã đó dưới dạng JSON. Các ứ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 về state của một URL đang mở là:

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

Mã nhận dạng và khoá tài nguyên được dùng để tìm nạp siêu dữ liệu tệp và tải nội dung tệp xuống. Sau khi có mã tệp và mã truy cập, ứng dụng của bạn có thể kiểm tra các quyền, tìm nạp siêu dữ liệu tệp và tải nội dung tệp xuống như 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 khởi chạy từ giao diện người dùng Drive. Để tìm hiểu thêm, hãy xem phần Tích hợp với nút "Mới" trên giao diện người dùng Drive hoặc Tích hợp với trình đơn theo bối cảnh "Mở bằng" của giao diện người dùng Drive.