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 tệp thuộc tính vào tất cả chứng từ 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 nhìn thấy, hãy dùng trường properties
của
Tài nguyên files
. Cách thêm cơ sở lưu trú
bị hạn chế đối với ứng dụng của bạn, hãy sử dụng trường appProperties
của tài nguyên files
.
Các thuộc tính cũng có thể được sử dụng trong công cụ tìm kiếm biểu thức.
Đây là cấu trúc của một tài sản thông thường có thể dùng để lưu trữ Mã 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 tệp tuỳ chỉnh
Phần này giải thích cách thực hiện một số thao tác liên quan đến thuộc tính tệp tuỳ chỉnh ảnh hưởng đến tất cả cá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 tất cả ứng dụng, hãy sử dụng
files.update
để đặt giá trị
Trường properties
trong files
nguồn.
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 tùy chỉnh vào một tệp bằng cách sử dụng thuộc tính nâng cao Dịch vụ Drive trong Google Apps Script. Để biết thêm thông tin, hãy xem Thêm hình thức tuỳ chỉnh thuộc tính.
Nhận hoặc liệt kê thuộc tính tệp tuỳ chỉnh
Để xem các thuộc tính mà tất cả ứng dụng đều nhìn thấy, hãy dùng phương thức
files.get
để truy xuất
thuộc tính tệp tùy 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 tập hợp
cặp khoá-giá trị.
{ "properties": { "name": "wrench", "mass": "1.3kg", "count": "3" } }
Xoá thuộc tính tệp tuỳ chỉnh
Để xóa các giá trị thuộc tính mà tất cả ứng dụng có thể nhìn thấy, hãy sử dụng
files.update
để đặt giá trị
Trường properties
trong files
thành giá trị rỗng.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{ "name": null }
Để xem thay đổi này, hãy gọi phương thức
files.get
để truy xuất
Đối tượng properties
cho tệp này.
{ "properties": { "mass": "1.3kg", "count": "3" } }
Giới hạn của thuộc tính tệp tuỳ chỉnh
Tài sản tuỳ chỉnh có các hạn mức 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 thuộc tính công khai cho 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ư cho mỗi tệp trong 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ị) trong Mã hoá UTF-8. Ví dụ: tài sản có khoá dài 10 ký tự chỉ có thể chứa 114 ký tự trong giá trị. Tương tự, một tài sản yêu cầu 100 ký tự cho giá trị có thể sử dụng tối đa 24 ký tự cho .
Để biết thêm thông tin, hãy xem files
nguồn. Đố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 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 trường appProperties
thông qua
yêu cầu đã xác thực mà dùng mã truy cập có được thông qua OAuth 2.0
mã ứng dụng khách. Bạn không thể sử dụng khoá API để truy xuất các thuộc tính riêng tư.