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 complément d'éditeur est utilisé. Pour en savoir plus sur les cas d'utilisation de 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 utilisateur, de document ou de 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 store 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é associée à la clé donné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 du 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é 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()PropertiesRécupère 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()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