Thêm thuộc tính tệp tùy chỉnh

Thuộc tính tệp tuỳ chỉnh là các cặp khoá-giá trị dùng để lưu trữ siêu dữ liệu tuỳ chỉnh cho một tệp trên Google Drive (chẳng hạn như thẻ), mã nhận dạng từ các kho dữ liệu khác, thông tin được chia sẻ giữa các ứng dụng quy trình công việc, v.v. Ví dụ: bạn có thể thêm thuộc tính tệp vào tất cả các tài liệu do bộ phận bán hàng tạo trong Quý 1.

Để thêm các thuộc tính hiển thị cho tất cả ứng dụng, hãy sử dụng trường properties của tài nguyên files. Để thêm các thuộc tính bị hạn chế cho ứng dụng, hãy sử dụng trường appProperties của tài nguyên files.

Bạn cũng có thể sử dụng các thuộc tính trong biểu thức tìm kiếm.

Đây là cấu trúc của một thuộc tính thông thường có thể được dùng để lưu trữ mã nhận dạng cơ sở dữ liệu của tệp trên Drive.

API Drive phiên bản 3

"appProperties": {
  "additionalID": "ID",
}

Drive API phiên bản 2

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

Làm việc với thuộc tính tệp tuỳ chỉnh

Phần này giải thích cách thực hiện một số tác vụ liên quan đến thuộc tính tệp tuỳ chỉnh ảnh hưởng đến tất cả ứng dụng.

Thêm hoặc cập nhật thuộc tính tệp tuỳ chỉnh

Để thêm hoặc cập nhật các thuộc tính hiển thị cho mọi ứng dụng, hãy sử dụng phương thức files.update để đặt trường properties của tài nguyên files.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
 
{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Bạn cũng có thể thêm thuộc tính tuỳ chỉnh vào tệp bằng cách sử dụng dịch vụ Drive nâng cao trong Google Apps Script. Để biết thêm thông tin, hãy xem phần Thêm thuộc tính tuỳ chỉnh.

Nhận hoặc liệt kê thuộc tính tệp tuỳ chỉnh

Để xem các thuộc tính hiển thị cho tất cả ứng dụng, hãy sử dụng phương thức files.get để truy xuất các thuộc tính tệp tuỳ chỉnh cho tệp.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

Phản hồi bao gồm một đối tượng properties chứa một tập hợp các cặp khoá-giá trị.

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

Xoá thuộc tính tệp tuỳ chỉnh

Để xoá các giá trị thuộc tính hiển thị cho tất cả ứng dụng, hãy sử dụng phương thức files.update để đặt trường properties của tài nguyên files thành rỗng.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
 
{
  "name": null
}

Để xem thay đổi, hãy gọi phương thức files.get để truy xuất đối tượng properties cho tệp.

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

Giới hạn của thuộc tính tệp tuỳ chỉnh

Thuộc tính tuỳ chỉnh có các giới hạn sau:

  • Tối đa 100 thuộc tính tuỳ chỉnh cho mỗi tệp, tổng cộng từ tất cả các nguồn.
  • Tối đa 30 tài sản công khai trên mỗi tệp, tổng cộng từ tất cả các nguồn.
  • Tối đa 30 thuộc tính riêng tư trên mỗi tệp của một ứng dụng bất kỳ.
  • Tối đa 124 byte cho mỗi chuỗi thuộc tính (bao gồm cả khoá và giá trị) ở dạng mã hoá UTF-8. Ví dụ: một thuộc tính có khoá dài 10 ký tự chỉ có thể có 114 ký tự trong giá trị. Tương tự, một thuộc tính yêu cầu 100 ký tự cho giá trị có thể sử dụng tối đa 24 ký tự cho khoá.

Để biết thêm thông tin, hãy xem tài nguyên files. Đối với Drive API phiên bản 2, hãy xem tài nguyên properties.

Truy cập vào các thuộc tính tệp tuỳ chỉnh riêng tư

Bạn chỉ có thể truy xuất các thuộc tính riêng tư bằng cách sử dụng trường appProperties thông qua một yêu cầu đã xác thực sử dụng mã truy cập thu được bằng mã ứng dụng OAuth 2.0. Bạn không thể sử dụng khoá API để truy xuất các tài sản riêng tư.