Class PropertiesService

PropertiesService

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 plusieurs scripts. Pour en savoir plus sur le moment où 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()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.

Documentation détaillée

getDocumentProperties()

Obtient 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 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 ce script, même par d'autres scripts accédant au même document.

Renvois

Properties : 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 ou n'est pas lié à un fichier Google Workspace.

getScriptProperties()

Obtient 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()

Obtient un magasin de propriétés auquel seul l'utilisateur actuel ou effectif peut accéder, et uniquement dans ce script.

Renvois

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