Class Properties

प्रॉपर्टी

प्रॉपर्टी ऑब्जेक्ट, उपयोगकर्ता, दस्तावेज़ या स्क्रिप्ट प्रॉपर्टी को ऐक्सेस करने के लिए इंटरफ़ेस के तौर पर काम करता है. प्रॉपर्टी का टाइप इस बात पर निर्भर करता है कि स्क्रिप्ट ने PropertiesService के इन तीन तरीकों में से किस तरीके का इस्तेमाल किया है: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() या PropertiesService.getScriptProperties(). प्रॉपर्टी को स्क्रिप्ट के बीच शेयर नहीं किया जा सकता. प्रॉपर्टी टाइप के बारे में ज़्यादा जानने के लिए, Properties सेवा की गाइड देखें.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
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.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

वापसी का टिकट

Properties — यह Properties स्टोर, चेनिंग के लिए


deleteProperty(key)

यह फ़ंक्शन, मौजूदा Properties स्टोर में दी गई कुंजी वाली प्रॉपर्टी को मिटाता है.

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

पैरामीटर

नामटाइपब्यौरा
keyStringमिटाई जाने वाली प्रॉपर्टी का कुंजी

वापसी का टिकट

Properties — यह Properties स्टोर, चेनिंग के लिए


getKeys()

मौजूदा Properties स्टोर में मौजूद सभी कुंजियां मिलती हैं.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

वापसी का टिकट

String[] — मौजूदा Properties स्टोर में मौजूद सभी कुंजियों की एक ऐरे


getProperties()

मौजूदा Properties स्टोर में मौजूद सभी कुंजी-वैल्यू पेयर की कॉपी मिलती है. ध्यान दें कि लौटाया गया ऑब्जेक्ट, स्टोर का लाइव व्यू नहीं होता. इसलिए, लौटाए गए ऑब्जेक्ट की प्रॉपर्टी बदलने से, वे स्टोरेज में अपने-आप अपडेट नहीं होंगी. इसके उलट, स्टोरेज में प्रॉपर्टी बदलने से, वे लौटाए गए ऑब्जेक्ट में अपने-आप अपडेट नहीं होंगी.

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

वापसी का टिकट

Object — मौजूदा Properties स्टोर में मौजूद सभी मुख्य-वैल्यू पेयर की कॉपी


getProperty(key)

यह फ़ंक्शन, मौजूदा Properties स्टोर में दी गई कुंजी से जुड़ी वैल्यू को दिखाता है. अगर ऐसी कोई कुंजी मौजूद नहीं है, तो यह null दिखाता है.

// Gets the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
const nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

पैरामीटर

नामटाइपब्यौरा
keyStringप्रॉपर्टी वैल्यू को वापस पाने के लिए कुंजी

वापसी का टिकट

String — मौजूदा Properties स्टोर में, दी गई कुंजी से जुड़ी वैल्यू


setProperties(properties)

यह फ़ंक्शन, दिए गए ऑब्जेक्ट से सभी कुंजी-वैल्यू पेयर को मौजूदा Properties स्टोर में सेट करता है.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

पैरामीटर

नामटाइपब्यौरा
propertiesObjectसेट करने के लिए की-वैल्यू पेयर वाला ऑब्जेक्ट

वापसी का टिकट

Properties — यह Properties स्टोर, चेनिंग के लिए


setProperties(properties, deleteAllOthers)

यह फ़ंक्शन, दिए गए ऑब्जेक्ट से सभी कुंजी-वैल्यू पेयर को मौजूदा Properties स्टोर में सेट करता है. इसके अलावा, यह स्टोर में मौजूद अन्य सभी प्रॉपर्टी को मिटाने का विकल्प भी देता है.

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

पैरामीटर

नामटाइपब्यौरा
propertiesObjectसेट करने के लिए की-वैल्यू पेयर वाला ऑब्जेक्ट
deleteAllOthersBooleantrue का इस्तेमाल, properties ऑब्जेक्ट में मौजूद अन्य सभी की-वैल्यू पेयर को मिटाने के लिए किया जाता है; false का इस्तेमाल, ऐसा न करने के लिए किया जाता है

वापसी का टिकट

Properties — यह Properties स्टोर, चेनिंग के लिए


setProperty(key, value)

यह मौजूदा Properties स्टोर में, दिए गए की-वैल्यू पेयर को सेट करता है.

// Sets the user property 'nickname' to 'Bobby'.
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

पैरामीटर

नामटाइपब्यौरा
keyStringप्रॉपर्टी के लिए कुंजी
valueStringकुंजी से जोड़ने के लिए वैल्यू

वापसी का टिकट

Properties — यह Properties स्टोर, चेनिंग के लिए