Class PropertiesService

PropertiesService

Permet aux scripts de stocker des données simples dans des paires clé-valeur limitées à un script, un utilisateur d'un ou un document dans lequel un module complémentaire est utilisé. Les propriétés ne peuvent pas être partagées entre les scripts. Pour en savoir plus sur l'utilisation de chaque type de propriété, consultez le guide du service Propriétés.

// Sets three properties of different types.
var documentProperties = PropertiesService.getDocumentProperties();
var scriptProperties = PropertiesService.getScriptProperties();
var userProperties = PropertiesService.getUserProperties();

documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
userProperties.setProperty('DISPLAY_UNITS', 'metric');

Méthodes

MéthodeType renvoyéBrève description
getDocumentProperties()PropertiesPermet d'obtenir un magasin de propriétés (pour ce script uniquement) auquel tous les utilisateurs peuvent accéder dans l'environnement document, feuille de calcul ou formulaire.
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.

Documentation détaillée

getDocumentProperties()

Permet d'obtenir un magasin de propriétés (pour ce script uniquement) auquel tous les utilisateurs peuvent accéder dans l'environnement document, feuille de calcul ou formulaire. Il n'est disponible que si le script est publié et en cours d'exécution en tant que module complémentaire ou s'il est lié à un fichier Google ; de mots clés. Lorsque les propriétés du document ne sont pas disponibles, cette méthode renvoie null. Document Les propriétés créées par un script ne sont pas accessibles en dehors de ce script, même par d'autres scripts qui accèdent au même document.

Renvois

Properties : magasin de propriétés réservé à ce script, que tous les utilisateurs du document actuel peuvent ou null si le script n'est pas un module complémentaire ni lié à un Fichier de l'espace de travail


getScriptProperties()

Récupère un magasin de propriétés auquel tous les utilisateurs peuvent accéder, mais uniquement dans ce script.

Renvois

Properties : magasin de propriétés auquel tous les utilisateurs du script peuvent accéder


getUserProperties()

Récupère un magasin de propriétés auquel seul l'utilisateur actuel peut accéder, et uniquement dans ce script.

Renvois

Properties : magasin de propriétés auquel seul l'utilisateur actuel du script peut accéder.