Cette page a été traduite par l'API Cloud Translation.

Class Properties

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 l'une des trois méthodes PropertiesService que le script a appelées : PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() ou PropertiesService.getScriptProperties(). Les propriétés ne peuvent pas être partagées entre des scripts. Pour en savoir plus sur les types de propriétés, consultez le guide du service des 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 dans le magasin `Properties` actuel.
`getProperties()`	`Object`	Récupère une copie de toutes les paires clé/valeur du datastore `Properties` actuel.
`getProperty(key)`	`String`	Récupère la valeur associée à la clé donnée dans le magasin `Properties` actuel ou `null` s'il n'existe aucune clé de ce type.
`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 datastore `Properties` actuel, et éventuellement toutes les autres propriétés du magasin.
`setProperty(key, value)`	`Properties`	Définit la paire clé-valeur indiqué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();

Aller-retour

Properties — ce magasin Properties, pour chaînage

`deleteProperty(key)`

Supprime la propriété avec la clé donné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

Aller-retour

Properties — ce magasin Properties, pour chaînage

`getKeys()`

Récupère toutes les clés dans le 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]);
}

Aller-retour

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

`getProperties()`

Récupère une copie de toutes les paires clé/valeur du datastore 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 à jour automatiquement dans le stockage, et 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]);
}

Aller-retour

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 s'il n'existe aucune clé de ce type.

// 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 la propriété à récupérer

Aller-retour

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`	un objet contenant des paires clé-valeur

Aller-retour

Properties — ce magasin Properties, pour chaînage

`setProperties(properties, deleteAllOthers)`

Définit toutes les paires clé/valeur de l'objet donné dans le datastore Properties actuel, et é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`	un objet contenant des paires clé-valeur
`deleteAllOthers`	`Boolean`	`true` pour supprimer toutes les autres paires clé/valeur de l'objet propriétés. `false` pour ne pas

Aller-retour

Properties — ce magasin Properties, pour chaînage

`setProperty(key, value)`

Définit la paire clé-valeur indiqué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`	Valeur à associer à la clé

Aller-retour

Properties — ce magasin Properties, pour chaînage