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 script ou un document dans lequel un module complémentaire est utilisé. Les propriétés ne peuvent pas être partagées entre des scripts. Pour savoir quand utiliser chaque type de propriété, consultez le guide du service des 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()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 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.

Documentation détaillée

getDocumentProperties()

Ré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 ouverts. Il n'est disponible que si le script est publié et s'exécute en tant que module complémentaire, ou s'il est lié à un type de fichier Google. Lorsque les propriétés du document ne sont pas disponibles, cette méthode renvoie null. Les propriétés de document créées par un script ne sont pas accessibles en dehors de celui-ci, même si d'autres scripts accèdent au même document.

Aller-retour

Properties : magasin de propriétés pour ce script uniquement accessible à tous les utilisateurs du document actuel, ou null si le script n'est pas un module complémentaire ou lié à un fichier Google Workspace


getScriptProperties()

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

Aller-retour

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.

Aller-retour

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