El servicio de propiedades te permite almacenar datos simples en pares clave-valor que se limitan a una secuencia de comandos, un usuario de una secuencia de comandos o un documento en el que se use un complemento. Por lo general, se usa para almacenar la configuración del desarrollador o las preferencias del usuario. Las propiedades nunca se comparten entre secuencias de comandos.
Si quieres ver las cuotas diarias y los límites de almacenamiento del servicio Properties, consulta Cuotas para los servicios de Google.
Comparación de tiendas de propiedades
El objeto global PropertiesService
ofrece tres métodos, cada uno de los cuales muestra un objeto Properties
similar, pero con derechos de acceso diferentes, como se muestra en la siguiente tabla:
Propiedades de secuencia de comandos | Propiedades del usuario | Propiedades del documento | |
---|---|---|---|
Método de acceso | getScriptProperties() |
getUserProperties() |
getDocumentProperties() |
Datos compartidos entre | Todos los usuarios de una secuencia de comandos, un complemento o una aplicación web | El usuario actual de una secuencia de comandos, un complemento o una aplicación web | Todos los usuarios de un complemento en el documento abierto |
Por lo general, se usa para | Datos de configuración de toda la app, como el nombre de usuario y la contraseña de la base de datos externa del desarrollador | Configuración específica del usuario, como unidades métricas o imperiales | Datos específicos del documento, como la URL de origen de un gráfico incorporado |
Formato de los datos
El servicio de propiedades almacena todos los datos como strings en pares clave-valor. Los tipos de datos que aún no son strings se convierten automáticamente en strings, incluidos los métodos contenidos en los objetos guardados.
Cómo guardar datos
Para guardar un solo valor, llama al método Properties.setProperty(key,
value)
del almacén correspondiente, como se muestra en el siguiente ejemplo:
Para guardar datos de forma masiva, pasa un mapa de pares clave-valor a
Properties.setProperties(properties)
.
Cada par clave-valor del objeto en el parámetro se almacena como una propiedad separada:
Leer datos
Para recuperar un solo valor que hayas guardado, llama a Properties.getProperty(key)
:
Para recuperar todos los valores del almacén de propiedades actual, llama a Properties.getProperties()
:
Modificar datos
Los métodos getProperty()
y getProperties()
muestran una copia de los datos almacenados, no una vista en vivo, por lo que cambiar el objeto que se muestra no actualizará el valor en el almacén de propiedades. Para actualizar los datos en la tienda, vuelve a guardarlos:
Cómo borrar datos
Para borrar un solo valor, llama a Properties.deleteProperty(key)
:
Para borrar todas las propiedades del almacén actual, llama a Properties.deleteAllProperties()
:
Administrar manualmente las propiedades de las secuencias de comandos
Puedes agregar manualmente hasta cincuenta propiedades personalizadas, como strings en pares clave-valor, desde la página de configuración del proyecto. Para agregar más de cincuenta propiedades, debes agregarlas de manera programática mediante los métodos descritos anteriormente en Cómo guardar datos. Cuando configuras las propiedades de las secuencias de comandos desde la página de configuración del proyecto, no puedes hacer referencia a las variables de la secuencia de comandos.
Cómo agregar propiedades de secuencias de comandos
- Abre tu proyecto de Apps Script.
- A la izquierda, haz clic en Configuración del proyecto
.
- Para agregar la primera propiedad, en Propiedades de la secuencia de comandos, haz clic en Agregar propiedad de la secuencia de comandos.
- Para agregar la segunda propiedad y las subsiguientes, en Propiedades de la secuencia de comandos, haz clic en Editar propiedades de la secuencia de comandos > Agregar propiedad de la secuencia de comandos.
- En Propiedad (Property), ingresa el nombre de la clave.
- En Valor, ingresa el valor de la clave.
- (Opcional) Para agregar más propiedades, haz clic en Agregar propiedad de secuencia de comandos.
- Haga clic en Guardar propiedades de la secuencia de comandos.
Editar propiedades de las secuencias de comandos
- Abre tu proyecto de Apps Script.
- A la izquierda, haz clic en Configuración del proyecto
.
- En Propiedades de la secuencia de comandos, haz clic en Editar propiedades de la secuencia de comandos.
- Modifica el nombre y el valor de la clave de cada propiedad que desees cambiar.
- Haga clic en Guardar propiedades de la secuencia de comandos.
Borrar propiedades de la secuencia de comandos
- Abre tu proyecto de Apps Script.
- A la izquierda, haz clic en Configuración del proyecto
.
- En Propiedades de la secuencia de comandos, haz clic en Editar propiedades de la secuencia de comandos.
- Junto a la propiedad que deseas borrar, haz clic en Quitar .
- Haga clic en Guardar propiedades de la secuencia de comandos.