ویژگی‌های سفارشی فایل جفت‌های کلید-مقدار هستند که برای ذخیره فراداده سفارشی برای فایل Google Drive (مانند برچسب‌ها)، شناسه‌های سایر ذخیره‌سازی‌های داده، اطلاعات هم‌رسانی‌شده بین برنامه‌های گردش کار، و غیره استفاده می‌شوند. برای مثال، می‌توانید ویژگی‌های فایل را به همه اسناد تولیدشده توسط بخش فروش در سه‌ماهه اول اضافه کنید.
برای افزودن ویژگی‌های قابل‌مشاهده برای همه برنامه‌ها، از فیلد properties
منبع files استفاده کنید. برای افزودن ویژگی‌های
محدودشده به برنامه‌تان، از فیلد appProperties منبع files استفاده کنید.
از ویژگی‌ها می‌توان در عبارت‌های جستجو نیز استفاده کرد.
این ساختار یک ویژگی معمول است که ممکن است برای ذخیره کردن شناسه پایگاه داده فایل Drive در فایل استفاده شود.
Drive API v3
"appProperties": {
"additionalID": "ID",
}
Drive API v2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
کار با ویژگی‌های سفارشی فایل
این بخش نحوه انجام برخی‌از تکالیف مربوط به ویژگی فایل سفارشی را که بر همه برنامه‌ها تأثیر می‌گذارد توضیح می‌دهد.
افزودن یا به‌روزرسانی ویژگی‌های سفارشی فایل
برای افزودن یا به‌روزرسانی ویژگی‌های قابل‌مشاهده برای همه برنامه‌ها، از روش
files.update برای تنظیم فیلد
properties از منبع files
استفاده کنید.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}همچنین می‌توانید بااستفاده از سرویس پیشرفته Drive در Google Apps Script، ویژگی سفارشی به فایل اضافه کنید. برای اطلاعات بیشتر، به افزودن ویژگی‌های سفارشی مراجعه کنید.
دریافت یا فهرست کردن ویژگی‌های فایل سفارشی
برای مشاهده ویژگی‌های قابل‌مشاهده برای همه برنامه‌ها، از روش
files.get برای بازیابی
ویژگی‌های سفارشی فایل برای فایل استفاده کنید.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=propertiesپاسخ شامل یک شیء properties است که حاوی مجموعه‌ای از
جفت‌های کلید-مقدار است.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}حذف ویژگی‌های سفارشی فایل
برای حذف مقادیر ویژگی قابل‌مشاهده برای همه برنامه‌ها، از روش
files.update استفاده کنید تا فیلد
properties منبع files
را روی null تنظیم کنید.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID{
"name": null
}برای مشاهده تغییر، روش files.get را فراخوانی کنید تا شیء properties برای فایل بازیابی شود.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}محدودیت‌های ویژگی‌های فایل سفارشی
ویژگی‌های سفارشی محدودیت‌های زیر را دارند:
- حداکثر ۱۰۰ ویژگی سفارشی برای هر فایل، مجموعاً از همه منابع.
- حداکثر ۳۰ ملک عمومی در هر فایل، مجموعاً از همه منابع.
- حداکثر ۳۰ ویژگی خصوصی برای هر فایل از هر برنامه.
- حداکثر ۱۲۴ بایت برای هر رشته ویژگی (شامل کلید و مقدار) در کدبندی UTF-8. برای مثال، ویژگی‌ای با کلیدی که ۱۰ نویسه طول دارد فقط می‌تواند ۱۱۴ نویسه در مقدار داشته باشد. به‌طور مشابه، ویژگی‌ای که به ۱۰۰ نویسه برای مقدار نیاز دارد می‌تواند تا ۲۴ نویسه برای کلید استفاده کند.
برای اطلاعات بیشتر، به منبع files مراجعه کنید. برای Drive API v2، منبع
properties را ببینید.
دسترسی به ویژگی‌های فایل سفارشی خصوصی
فقط بااستفاده از فیلد appProperties ازطریق درخواست اصالت‌سنجی‌شده‌ای که از کد دسترسی به‌دست‌آمده با شناسه کارخواه OAuth 2.0 استفاده می‌کند می‌توانید ویژگی‌های خصوصی را بازیابی کنید. نمی‌توانید از کلید میانای برنامه‌سازی کاربردی برای بازیابی ویژگی‌های خصوصی استفاده کنید.