Properties Service

Propriétés

Ce service permet aux scripts de stocker des chaînes sous forme de paires clé/valeur dont la portée est limitée à un script, à un utilisateur d'un script ou à un document dans lequel un module complémentaire d'éditeur est utilisé. Pour en savoir plus sur le moment où utiliser chaque type de propriété, consultez le guide du service Properties.

Classes

NomBrève description
PropertiesL'objet properties 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 dans des paires clé/valeur dont la portée est limitée à un script, à un 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 magasin 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é donnée dans le magasin Properties actuel.
getKeys()String[]Obtient toutes les clés du magasin Properties actuel.
getProperties()ObjectObtient une copie de toutes les paires clé/valeur du magasin Properties actuel.
getProperty(key)StringObtient 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)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()PropertiesObtient un magasin de propriétés (pour ce script uniquement) auquel tous les utilisateurs peuvent accéder dans le document, la feuille de calcul ou le formulaire ouvert.
getScriptProperties()PropertiesObtient un magasin de propriétés auquel tous les utilisateurs peuvent accéder, mais uniquement dans ce script.
getUserProperties()PropertiesObtient un magasin de propriétés auquel seul l'utilisateur actuel ou effectif peut accéder, et uniquement dans ce script.

ScriptProperties

UserProperties