कस्टम फ़ाइल प्रॉपर्टी की-वैल्यू पेयर होती हैं, जिनका इस्तेमाल किसी Google Drive फ़ाइल (जैसे कि टैग), दूसरे डेटा स्टोर के आईडी, वर्कफ़्लो ऐप्लिकेशन के बीच शेयर की गई जानकारी वगैरह के लिए कस्टम मेटाडेटा को स्टोर करने के लिए किया जाता है. उदाहरण के लिए, पहली तिमाही में सेल्स डिपार्टमेंट के जनरेट किए गए सभी दस्तावेज़ों में फ़ाइल प्रॉपर्टी जोड़ी जा सकती हैं.
सभी ऐप्लिकेशन में दिखने वाली प्रॉपर्टी जोड़ने के लिए, files संसाधन के properties फ़ील्ड का इस्तेमाल करें. अपने ऐप्लिकेशन में सिर्फ़ प्रॉपर्टी जोड़ने के लिए, files संसाधन के appProperties फ़ील्ड का इस्तेमाल करें.
प्रॉपर्टी का इस्तेमाल सर्च एक्सप्रेशन में भी किया जा सकता है.
यह किसी सामान्य प्रॉपर्टी का स्ट्रक्चर है. इसका इस्तेमाल फ़ाइल में Drive की फ़ाइल का डेटाबेस आईडी सेव करने के लिए किया जा सकता है.
डिस्क API v3
"appProperties": {
"additionalID": "ID",
}
डिस्क API v2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
कस्टम फ़ाइल प्रॉपर्टी के साथ काम करना
इस सेक्शन में, ऐसी कस्टम फ़ाइल प्रॉपर्टी से जुड़े ऐसे काम करने का तरीका बताया गया है जो सभी ऐप्लिकेशन पर असर डालते हैं.
कस्टम फ़ाइल प्रॉपर्टी जोड़ना या अपडेट करना
सभी ऐप्लिकेशन में दिखने वाली प्रॉपर्टी जोड़ने या अपडेट करने के लिए, files.update तरीके का इस्तेमाल करके files संसाधन के properties फ़ील्ड को सेट करें.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
आप Google Apps स्क्रिप्ट में बेहतर डिस्क सेवा का उपयोग करके किसी फ़ाइल में कस्टम प्रॉपर्टी भी जोड़ सकते हैं. ज़्यादा जानकारी के लिए, कस्टम प्रॉपर्टी जोड़ना लेख देखें.
कस्टम फ़ाइल प्रॉपर्टी पाना या उनकी सूची बनाना
सभी ऐप्लिकेशन को दिखने वाली प्रॉपर्टी देखने के लिए, 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 तरीके का इस्तेमाल करके files संसाधन के properties फ़ील्ड को शून्य पर सेट करें.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
बदलाव देखने के लिए, files.get तरीके को कॉल करके फ़ाइल के लिए properties ऑब्जेक्ट को वापस पाएं.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}
कस्टम फ़ाइल प्रॉपर्टी की सीमाएं
कस्टम प्रॉपर्टी की सीमाएं नीचे दी गई हैं:
- हर फ़ाइल में ज़्यादा से ज़्यादा 100 कस्टम प्रॉपर्टी. इन्हें सभी सोर्स से जोड़ा जा सकता है.
- हर फ़ाइल में ज़्यादा से ज़्यादा 30 सार्वजनिक प्रॉपर्टी होनी चाहिए. इन्हें सभी सोर्स से शामिल किया जाता है.
- किसी भी एक ऐप्लिकेशन की हर फ़ाइल में ज़्यादा से ज़्यादा 30 निजी प्रॉपर्टी होनी चाहिए.
- UTF-8 एन्कोडिंग में, हर प्रॉपर्टी स्ट्रिंग के लिए ज़्यादा से ज़्यादा 124 बाइट (कुंजी और वैल्यू, दोनों शामिल हों). उदाहरण के लिए, 10 वर्णों वाली कुंजी वाली प्रॉपर्टी की वैल्यू में सिर्फ़ 114 वर्ण हो सकते हैं. इसी तरह, जिस प्रॉपर्टी में वैल्यू के लिए 100 वर्णों की ज़रूरत होती है उसमें कुंजी के लिए ज़्यादा से ज़्यादा 24 वर्णों का इस्तेमाल किया जा सकता है.
ज़्यादा जानकारी के लिए, files के संसाधन देखें. Drive API v2 के लिए properties संसाधन देखें.
निजी कस्टम फ़ाइल प्रॉपर्टी ऐक्सेस करें
appProperties फ़ील्ड का इस्तेमाल करके ही निजी प्रॉपर्टी को वापस लाया जा सकता है. इसके लिए, पुष्टि करने वाला ऐसा अनुरोध करना होगा जिसमें OAuth 2.0 क्लाइंट आईडी से मिले ऐक्सेस टोकन का इस्तेमाल किया गया हो. निजी प्रॉपर्टी वापस पाने के लिए, एपीआई पासकोड का इस्तेमाल नहीं किया जा सकता.