Class PropertiesService
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Servicio de propiedades
Permite que las secuencias de comandos almacenen datos simples en pares clave-valor limitados a una secuencia de comandos, un usuario de una secuencia de comandos o un documento en el que se usa un complemento. Las propiedades no se pueden compartir entre secuencias de comandos.
Para obtener más información sobre cuándo usar cada tipo de propiedad, consulta la guía del servicio de propiedades.
// 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étodos
| Método | Tipo de datos que se muestra | Descripción breve |
getDocumentProperties() | Properties | Obtiene un almacén de propiedades (solo para esta secuencia de comandos) al que todos los usuarios pueden acceder dentro del documento, la hoja de cálculo o el formulario abiertos. |
getScriptProperties() | Properties | Obtiene un almacén de propiedades al que todos los usuarios pueden acceder, pero solo dentro de esta secuencia de comandos. |
getUserProperties() | Properties | Obtiene un almacén de propiedades al que solo puede acceder el usuario actual y solo dentro de esta secuencia de comandos. |
Documentación detallada
getDocumentProperties()
Obtiene un almacén de propiedades (solo para esta secuencia de comandos) al que todos los usuarios pueden acceder dentro del documento, la hoja de cálculo o el formulario abiertos. Solo está disponible si la secuencia de comandos se publica y ejecuta como complemento, o si está vinculada a un tipo de archivo de Google. Cuando las propiedades del documento no están disponibles, este método muestra null. No se puede acceder a las propiedades del documento que crea una secuencia de comandos fuera de ella, ni siquiera a través de otras secuencias de comandos que accedan al mismo documento.
Volver
Properties: Es un almacén de propiedades solo para esta secuencia de comandos al que pueden acceder todos los usuarios del documento actual, o null si la secuencia de comandos no es un complemento ni está vinculada a un archivo de Google Workspace.
getScriptProperties()
Obtiene un almacén de propiedades al que todos los usuarios pueden acceder, pero solo dentro de esta secuencia de comandos.
Volver
Properties: Es un almacén de propiedades al que pueden acceder todos los usuarios de la secuencia de comandos.
getUserProperties()
Obtiene un almacén de propiedades al que solo puede acceder el usuario actual y solo dentro de esta secuencia de comandos.
Volver
Properties: Es un almacén de propiedades al que solo puede acceder el usuario actual de la secuencia de comandos.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 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"]]
