Properties Service

Propriétés

Ce service permet aux scripts de stocker des chaînes en tant que paires clé/valeur limitées à un script, à un utilisateur d'un script ou à un document dans lequel un module complémentaire d'éditeur est utilisé. Pour savoir quand utiliser chaque type de propriété, consultez le guide du service Properties.

Classes

NomBrève description
PropertiesL'objet des propriétés sert d'interface pour accéder aux propriétés de l'utilisateur, du document ou du script.
PropertiesServicePermet aux scripts de stocker des données simples sous forme de paires clé/valeur limitées à un script, à l'utilisateur d'un script ou à un document dans lequel un module complémentaire est utilisé.
ScriptPropertiesLes propriétés de script sont des paires clé/valeur stockées par un script dans un stockage persistant.
UserPropertiesLes propriétés utilisateur sont des paires clé/valeur propres à un utilisateur.

Properties

Méthodes

MéthodeType renvoyéBrève description
deleteAllProperties()PropertiesSupprime toutes les propriétés du magasin Properties actuel.
deleteProperty(key)PropertiesSupprime 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()ObjectRécupère une copie de toutes les paires clé-valeur dans le magasin Properties actuel.
getProperty(key)StringRécupère la valeur associée à la clé donnée dans le magasin Properties actuel ou null si aucune clé n'existe.
setProperties(properties)PropertiesDéfinit toutes les paires clé/valeur de l'objet donné dans le magasin Properties actuel.
setProperties(properties, deleteAllOthers)PropertiesDé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)PropertiesDéfinit la paire clé-valeur donnée dans le magasin Properties actuel.

PropertiesService

Méthodes

MéthodeType renvoyéBrève description
getDocumentProperties()PropertiesRécupère un magasin de propriétés (pour ce script uniquement) auquel tous les utilisateurs peuvent accéder depuis le document, la feuille de calcul ou le formulaire ouverts.
getScriptProperties()PropertiesRécupère un magasin de propriétés auquel tous les utilisateurs peuvent accéder, mais uniquement dans ce script.
getUserProperties()PropertiesRécupère un magasin de propriétés auquel seul l'utilisateur actuel peut accéder, et uniquement dans ce script.

ScriptProperties

UserProperties