L'objet des propriétés sert d'interface pour accéder aux propriétés de l'utilisateur, du document ou du script. Le type de propriété spécifique dépend de la méthode de PropertiesService
appelée par le script: PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
ou PropertiesService.getScriptProperties()
.
Les propriétés ne peuvent pas être partagées entre plusieurs scripts. Pour en savoir plus sur les types de propriétés, consultez le guide du service Properties.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
deleteAllProperties() | Properties | Supprime toutes les propriétés du magasin Properties actuel. |
deleteProperty(key) | Properties | Supprime la propriété avec la clé indiquée dans le magasin Properties actuel. |
getKeys() | String[] | Récupère toutes les clés du magasin Properties actuel. |
getProperties() | Object | Récupère une copie de toutes les paires clé-valeur dans le magasin Properties actuel. |
getProperty(key) | String | Récupère la valeur associée à la clé donnée dans le magasin Properties actuel ou null si aucune clé n'existe. |
setProperties(properties) | Properties | Définit toutes les paires clé/valeur de l'objet donné dans le magasin Properties actuel. |
setProperties(properties, deleteAllOthers) | Properties | Définit toutes les paires clé/valeur de l'objet donné dans le magasin Properties actuel, en supprimant éventuellement toutes les autres propriétés du magasin. |
setProperty(key, value) | Properties | Définit la paire clé-valeur donnée dans le magasin Properties actuel. |
Documentation détaillée
deleteAllProperties()
Supprime toutes les propriétés du magasin Properties
actuel.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
Renvois
Properties
— ce magasin Properties
, pour la chaîne
deleteProperty(key)
Supprime la propriété avec la clé indiquée dans le magasin Properties
actuel.
// Deletes the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteProperty('nickname');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé de la propriété à supprimer. |
Renvois
Properties
— ce magasin Properties
, pour la chaîne
getKeys()
Récupère toutes les clés du magasin Properties
actuel.
// 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]); }
Renvois
String[]
: tableau de toutes les clés du magasin Properties
actuel
getProperties()
Récupère une copie de toutes les paires clé-valeur dans le magasin Properties
actuel. Notez que l'objet renvoyé n'est pas une vue en direct du magasin. Par conséquent, la modification des propriétés de l'objet renvoyé ne les met pas automatiquement à jour dans le stockage, ou inversement.
// 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]); }
Renvois
Object
: copie de toutes les paires clé-valeur dans le magasin Properties
actuel
getProperty(key)
Récupère la valeur associée à la clé donnée dans le magasin Properties
actuel ou null
si aucune clé n'existe.
// Gets the user property 'nickname'. var userProperties = PropertiesService.getUserProperties(); var nickname = userProperties.getProperty('nickname'); Logger.log(nickname);
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé de la valeur de propriété à récupérer. |
Renvois
String
: valeur associée à la clé donnée dans le magasin Properties
actuel
setProperties(properties)
Définit toutes les paires clé/valeur de l'objet donné dans le magasin Properties
actuel.
// Sets multiple user properties at once. var userProperties = PropertiesService.getUserProperties(); var newProperties = {nickname: 'Bob', region: 'US', language: 'EN'}; userProperties.setProperties(newProperties);
Paramètres
Nom | Type | Description |
---|---|---|
properties | Object | objet contenant des paires clé-valeur à définir |
Renvois
Properties
— ce magasin Properties
, pour la chaîne
setProperties(properties, deleteAllOthers)
Définit toutes les paires clé/valeur de l'objet donné dans le magasin Properties
actuel, en supprimant éventuellement toutes les autres propriétés du magasin.
// 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);
Paramètres
Nom | Type | Description |
---|---|---|
properties | Object | objet contenant des paires clé-valeur à définir |
deleteAllOthers | Boolean | true pour supprimer toutes les autres paires clé/valeur de l'objet "properties" ; false pour ne pas |
Renvois
Properties
— ce magasin Properties
, pour la chaîne
setProperty(key, value)
Définit la paire clé-valeur donnée dans le magasin Properties
actuel.
// Sets the user property 'nickname' to 'Bobby'. var userProperties = PropertiesService.getUserProperties(); userProperties.setProperty('nickname', 'Bobby');
Paramètres
Nom | Type | Description |
---|---|---|
key | String | la clé de la propriété |
value | String | la valeur à associer à la clé ; |
Renvois
Properties
— ce magasin Properties
, pour la chaîne