Class PropertiesService
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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éthode | Type renvoyé | Brève description |
getDocumentProperties() | Properties | 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. |
getScriptProperties() | Properties | Récupère un magasin de propriétés auquel tous les utilisateurs peuvent accéder, mais uniquement dans ce script. |
getUserProperties() | Properties | Ré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
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003eThe Properties Service lets Apps Script store simple data as key-value pairs, with different scopes for scripts, users, and documents.\u003c/p\u003e\n"],["\u003cp\u003eIt offers three methods to access properties: \u003ccode\u003egetDocumentProperties()\u003c/code\u003e, \u003ccode\u003egetScriptProperties()\u003c/code\u003e, and \u003ccode\u003egetUserProperties()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetDocumentProperties()\u003c/code\u003e provides property storage accessible to all users within a specific document, spreadsheet, or form where the script is running.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetScriptProperties()\u003c/code\u003e allows storing properties accessible to all users, but only within the context of the current script.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetUserProperties()\u003c/code\u003e provides a property store specific to the current user and accessible only within the current script.\u003c/p\u003e\n"]]],["The `PropertiesService` stores data in key-value pairs, accessible via `getDocumentProperties`, `getScriptProperties`, and `getUserProperties`. `getDocumentProperties` stores data within a specific document, accessible to all users. `getScriptProperties` stores data within a script, accessible to all users. `getUserProperties` stores data for a single user within a script. The example code demonstrates setting properties using each method: `setProperty`. Each method returns a `Properties` object, which is a property store.\n"],null,["# Class PropertiesService\n\nPropertiesService\n\nAllows scripts to store simple data in key-value pairs scoped to one script, one user of a\nscript, or one document in which an add-on is used. Properties cannot be shared between scripts.\nFor more information about when to use each type of property, see the [guide to the Properties service](/apps-script/guides/properties).\n\n```javascript\n// Sets three properties of different types.\nconst documentProperties = PropertiesService.getDocumentProperties();\nconst scriptProperties = PropertiesService.getScriptProperties();\nconst userProperties = PropertiesService.getUserProperties();\n\ndocumentProperties.setProperty('DAYS_TO_FETCH', '5');\nscriptProperties.setProperty(\n 'SERVER_URL',\n 'http://www.example.com/MyWeatherService/',\n);\nuserProperties.setProperty('DISPLAY_UNITS', 'metric');\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|\n| [getDocumentProperties()](#getDocumentProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store (for this script only) that all users can access within the open document, spreadsheet, or form. |\n| [getScriptProperties()](#getScriptProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store that all users can access, but only within this script. |\n| [getUserProperties()](#getUserProperties()) | [Properties](/apps-script/reference/properties/properties) | Gets a property store that only the current user can access, and only within this script. |\n\nDetailed documentation\n----------------------\n\n### `get``Document``Properties()`\n\nGets a property store (for this script only) that all users can access within the open\ndocument, spreadsheet, or form. It is only available if the script is published and executing\nas an add-on or if it is [bound](https://developers.google.com/apps-script/scripts_containers) to a Google file\ntype. When document properties are not available this method returns `null`. Document\nproperties created by a script are not accessible outside that script, even by other scripts\naccessing the same document.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store for this script only that all users of the current document can\naccess, or `null` if the script is not either an add-on or bound to a Google\nWorkspace file\n\n*** ** * ** ***\n\n### `get``Script``Properties()`\n\nGets a property store that all users can access, but only within this script.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store that all users of the script can access\n\n*** ** * ** ***\n\n### `get``User``Properties()`\n\nGets a property store that only the current user can access, and only within this script.\n\n#### Return\n\n\n[Properties](/apps-script/reference/properties/properties) --- a property store that only the current user of the script can access"]]
