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

Thuộc tính tuỳ chỉnh của tệp 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 lưu trữ dữ liệu khác, thông tin được chia sẻ giữa các ứng dụng quy trình làm 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 mà mọi ứng dụng đều có thể nhìn thấy, hãy sử dụng trường properties của tài nguyên files. Để thêm các thuộc tính chỉ dành riêng cho ứng dụng của bạn, 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 điển hình có thể được dùng để lưu trữ mã nhận dạng cơ sở dữ liệu của tệp Drive trên tệp.

API Drive phiên bản 3

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

API Drive phiên bản 2

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

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

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 tuỳ chỉnh của tệp ảnh hưởng đến tất cả các ứng dụng.

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

Để thêm hoặc cập nhật các thuộc tính mà mọi ứng dụng đều có thể nhìn thấy, 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 một thuộc tính tuỳ chỉnh vào tệp bằng dịch vụ Drive nâng cao trong Google Apps Script. Để biết thêm thông tin, hãy xem bài viết Thêm thuộc tính tuỳ chỉnh.

Xem hoặc liệt kê thuộc tính tuỳ chỉnh của tệp

Để xem các thuộc tính mà mọi ứng dụng đều có thể nhìn thấy, hãy sử dụng phương thức files.get để truy xuất các thuộc tính tuỳ chỉnh của 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 tập hợp các cặp khoá-giá trị.

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

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

Để xoá các giá trị thuộc tính mà mọi ứng dụng đều có thể nhìn thấy, hãy sử dụng phương thức files.update để đặt trường properties của tài nguyên files thành giá trị 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 tuỳ chỉnh của tệp

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 trên mỗi tệp, được tính tổng từ tất cả các nguồn.
Tối đa 30 thuộc tính công khai trên mỗi tệp, được tính tổ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 từ bất kỳ ứng dụng nào.
Tối đa 124 byte cho mỗi chuỗi thuộc tính (bao gồm cả khoá và giá trị) trong 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 API Drive phiên bản 2, hãy xem tài nguyên properties.

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

Bạn chỉ có thể truy xuất các thuộc tính riêng tư bằ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 khách OAuth 2.0. Bạn không thể sử dụng khoá API để truy xuất các thuộc tính riêng tư.