Class Properties

Propriétés

L'objet properties sert d'interface pour accéder aux propriétés utilisateur, de document ou de script. Le type de propriété spécifique dépend de la méthode PropertiesService appelée par le script : PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() ou PropertiesService.getScriptProperties(). Les propriétés ne peuvent pas être partagées entre les scripts. Pour en savoir plus sur les types de propriétés, consultez le guide du service Propriétés.

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é donnée dans le magasin Properties actuel.
getKeys()	String[]	Récupère toutes les clés du magasin Properties actuel.
getProperties()	Object	Obtient une copie de toutes les paires clé-valeur du 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é de ce type 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.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Renvois

Properties : ce magasin Properties, pour le chaînage

---

deleteProperty(key)

Supprime la propriété avec la clé donnée dans le magasin Properties actuel.

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

Paramètres

Nom	Type	Description
key	String	Clé de la propriété à supprimer.

Renvois

Properties : ce magasin Properties, pour le chaînage

---

getKeys()

Récupère toutes les clés du magasin Properties actuel.

// 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]);
}

Renvois

String[] : tableau de toutes les clés du magasin Properties actuel

---

getProperties()

Obtient une copie de toutes les paires clé-valeur du 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, et inversement.

// 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]);
}

Renvois

Object : copie de toutes les paires clé-valeur du 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é de ce type n'existe.

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

Paramètres

Nom	Type	Description
key	String	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.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

Paramètres

Nom	Type	Description
properties	Object	Objet contenant les paires clé/valeur à définir

Renvois

Properties : ce magasin Properties, pour le chaînage

---

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.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

Paramètres

Nom	Type	Description
properties	Object	Objet contenant les paires clé/valeur à définir
deleteAllOthers	Boolean	true pour supprimer toutes les autres paires clé/valeur dans l'objet properties ; false pour ne pas le faire.

Renvois

Properties : ce magasin Properties, pour le chaînage

---

setProperty(key, value)

Définit la paire clé-valeur donnée dans le magasin Properties actuel.

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

Paramètres

Nom	Type	Description
key	String	clé de la propriété
value	String	la valeur à associer à la clé.

Renvois

Properties : ce magasin Properties, pour le chaînage