प्रॉपर्टी ऑब्जेक्ट, उपयोगकर्ता, दस्तावेज़ या स्क्रिप्ट की प्रॉपर्टी को ऐक्सेस करने के लिए, इंटरफ़ेस के तौर पर काम करता है. प्रॉपर्टी का कोई खास टाइप, इस बात पर निर्भर करता है कि स्क्रिप्ट के PropertiesService
में मौजूद तीन तरीकों में से किस को कहा जाता है: PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
या PropertiesService.getScriptProperties()
.
प्रॉपर्टी को स्क्रिप्ट के बीच शेयर नहीं किया जा सकता. प्रॉपर्टी के टाइप के बारे में ज़्यादा जानने के लिए, प्रॉपर्टी सेवा से जुड़ी गाइड देखें.
तरीके
तरीका | रिटर्न टाइप | संक्षिप्त विवरण |
---|---|---|
deleteAllProperties() | Properties | मौजूदा Properties स्टोर से सभी प्रॉपर्टी मिटा देता है. |
deleteProperty(key) | Properties | मौजूदा Properties स्टोर में, दी गई कुंजी वाली प्रॉपर्टी को मिटा देता है. |
getKeys() | String[] | यहां Properties के मौजूदा स्टोर की सभी कुंजियां मिलती हैं. |
getProperties() | Object | मौजूदा Properties स्टोर में मौजूद सभी की-वैल्यू पेयर की कॉपी मिलती है. |
getProperty(key) | String | मौजूदा Properties स्टोर में दी गई कुंजी से जुड़ी वैल्यू दिखाता है. इसके अलावा, अगर ऐसी कोई कुंजी मौजूद नहीं है, तो null का इस्तेमाल किया जाता है. |
setProperties(properties) | Properties | मौजूदा Properties स्टोर में दिए गए ऑब्जेक्ट के सभी की-वैल्यू पेयर को सेट करता है. |
setProperties(properties, deleteAllOthers) | Properties | मौजूदा Properties स्टोर में दिए गए ऑब्जेक्ट के सभी की-वैल्यू पेयर को सेट करता है. हालांकि, स्टोर की अन्य सभी प्रॉपर्टी को मिटा दिया जाता है. हालांकि, ऐसा करना ज़रूरी नहीं है. |
setProperty(key, value) | Properties | मौजूदा Properties स्टोर में दिए गए की-वैल्यू पेयर को सेट करता है. |
ज़्यादा जानकारी के साथ दस्तावेज़
deleteAllProperties()
मौजूदा Properties
स्टोर से सभी प्रॉपर्टी मिटा देता है.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
रिटर्न
Properties
— यह Properties
स्टोर, चेन किए जाने के लिए है
deleteProperty(key)
मौजूदा Properties
स्टोर में, दी गई कुंजी वाली प्रॉपर्टी को मिटा देता है.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
key | String | प्रॉपर्टी मिटाने के लिए कुंजी |
रिटर्न
Properties
— यह Properties
स्टोर, चेन किए जाने के लिए है
getKeys()
यहां Properties
के मौजूदा स्टोर की सभी कुंजियां मिलती हैं.
// Sets several properties, then logs the value of each key. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var keys = scriptProperties.getKeys(); Logger.log('Animals known:'); for (var i = 0; i < keys.length; i++) { Logger.log(keys[i]); }
रिटर्न
String[]
— Properties
के मौजूदा स्टोर की सभी कुंजियों का कलेक्शन
getProperties()
मौजूदा Properties
स्टोर में मौजूद सभी की-वैल्यू पेयर की कॉपी मिलती है. ध्यान दें कि दिखाया गया ऑब्जेक्ट, स्टोर का लाइव व्यू नहीं है. ऐसे में, लौटाए गए ऑब्जेक्ट की प्रॉपर्टी बदलने से
वे स्टोरेज में अपने-आप अपडेट नहीं होंगी. इसी तरह, अगर लौटाए गए ऑब्जेक्ट की प्रॉपर्टी बदलने पर,
डेटा अपने-आप अपडेट नहीं होगा.
// Sets several script properties, then retrieves them and logs them. var scriptProperties = PropertiesService.getScriptProperties(); scriptProperties.setProperties({ 'cow': 'moo', 'sheep': 'baa', 'chicken': 'cluck' }); var animalSounds = scriptProperties.getProperties(); // Logs: // A chicken goes cluck! // A cow goes moo! // A sheep goes baa! for (var kind in animalSounds) { Logger.log('A %s goes %s!', kind, animalSounds[kind]); }
रिटर्न
Object
— मौजूदा Properties
स्टोर में मौजूद सभी की-वैल्यू पेयर की कॉपी
getProperty(key)
मौजूदा Properties
स्टोर में दी गई कुंजी से जुड़ी वैल्यू दिखाता है. इसके अलावा, अगर ऐसी कोई कुंजी मौजूद नहीं है, तो null
का इस्तेमाल किया जाता है.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
key | String | प्रॉपर्टी की वैल्यू को वापस पाने के लिए कुंजी |
रिटर्न
String
— मौजूदा Properties
स्टोर में, दी गई कुंजी से जुड़ी वैल्यू
setProperties(properties)
मौजूदा Properties
स्टोर में दिए गए ऑब्जेक्ट के सभी की-वैल्यू पेयर को सेट करता है.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
properties | Object | वह ऑब्जेक्ट जिसमें सेट किए जाने वाले कुंजी-मान जोड़े होते हैं |
रिटर्न
Properties
— यह Properties
स्टोर, चेन किए जाने के लिए है
setProperties(properties, deleteAllOthers)
मौजूदा Properties
स्टोर में दिए गए ऑब्जेक्ट के सभी की-वैल्यू पेयर को सेट करता है. हालांकि, स्टोर की अन्य सभी प्रॉपर्टी को मिटा दिया जाता है. हालांकि, ऐसा करना ज़रूरी नहीं है.
// Sets multiple user properties at once while deleting all other user properties. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties, true);
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
properties | Object | वह ऑब्जेक्ट जिसमें सेट किए जाने वाले कुंजी-मान जोड़े होते हैं |
deleteAllOthers | Boolean | प्रॉपर्टी ऑब्जेक्ट में मौजूद दूसरे सभी की-वैल्यू पेयर को मिटाने के लिए true ;
false से नहीं |
रिटर्न
Properties
— यह Properties
स्टोर, चेन किए जाने के लिए है
setProperty(key, value)
मौजूदा Properties
स्टोर में दिए गए की-वैल्यू पेयर को सेट करता है.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
पैरामीटर
नाम | Type | ब्यौरा |
---|---|---|
key | String | प्रॉपर्टी की कुंजी |
value | String | कुंजी से जोड़ा जाने वाला मान |
रिटर्न
Properties
— यह Properties
स्टोर, चेन किए जाने के लिए है