Class PropertiesService

ServiceProperties

Permet 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é. Les propriétés ne peuvent pas être partagées entre les scripts. Pour savoir quand utiliser chaque type de propriété, consultez le guide du service Properties.

// Sets three properties of different types.
const documentProperties = PropertiesService.getDocumentProperties();
const scriptProperties = PropertiesService.getScriptProperties();
const 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 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.

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 ouvert. Il n'est disponible que si le script est publié et exécuté en tant que module complémentaire, ou s'il est lié à un type de fichier Google. Lorsque les propriétés de 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 ce script, même par d'autres scripts accédant au même document.

Renvois

Properties : un magasin de propriétés pour ce script uniquement, auquel tous les utilisateurs du document actuel peuvent accéder, ou null si le script n'est pas un module complémentaire ni 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.

Renvois

Properties : un 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 : un magasin de propriétés auquel seul l'utilisateur actuel du script peut accéder