कस्टम फ़ाइल प्रॉपर्टी, कीवर्ड और वैल्यू के पेयर होते हैं. इनका इस्तेमाल, Google Drive फ़ाइल के लिए कस्टम मेटाडेटा (जैसे, टैग), दूसरे डेटा स्टोर के आईडी, वर्कफ़्लो ऐप्लिकेशन के बीच शेयर की गई जानकारी वगैरह को सेव करने के लिए किया जाता है. उदाहरण के लिए, पहली तिमाही में सेल्स डिपार्टमेंट से जनरेट किए गए सभी दस्तावेज़ों में फ़ाइल प्रॉपर्टी जोड़ी जा सकती हैं.
सभी ऐप्लिकेशन को दिखने वाली प्रॉपर्टी जोड़ने के लिए, files संसाधन के properties फ़ील्ड का इस्तेमाल करें. अपने ऐप्लिकेशन के लिए सीमित प्रॉपर्टी जोड़ने के लिए, files संसाधन के appProperties फ़ील्ड का इस्तेमाल करें.
प्रॉपर्टी का इस्तेमाल सर्च एक्सप्रेशन में भी किया जा सकता है.
यह किसी सामान्य प्रॉपर्टी का स्ट्रक्चर है. इसका इस्तेमाल, Drive फ़ाइल के डेटाबेस आईडी को फ़ाइल में स्टोर करने के लिए किया जा सकता है.
Drive API v3
"appProperties": {
"additionalID": "ID",
}
Drive 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 Script में Drive की ऐडवांस सेवा का इस्तेमाल करके, किसी फ़ाइल में कस्टम प्रॉपर्टी भी जोड़ी जा सकती है. ज़्यादा जानकारी के लिए, कस्टम प्रॉपर्टी जोड़ना लेख पढ़ें.
कस्टम फ़ाइल प्रॉपर्टी पाना या उनकी सूची बनाना
सभी ऐप्लिकेशन को दिखने वाली प्रॉपर्टी देखने के लिए, फ़ाइल के लिए कस्टम फ़ाइल प्रॉपर्टी पाने के लिए, 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
}
बदलाव देखने के लिए, फ़ाइल के लिए properties ऑब्जेक्ट को वापस पाने के लिए, files.get तरीके को कॉल करें.
{
"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 क्लाइंट आईडी से मिले ऐक्सेस टोकन का इस्तेमाल किया जाता है. निजी प्रॉपर्टी वापस पाने के लिए, एपीआई पासकोड का इस्तेमाल नहीं किया जा सकता.