El servicio Propiedades te permite almacenar Datos simples en pares clave-valor centrados en una secuencia de comandos, un usuario de una secuencia de comandos o un documento en el que se usa un complemento. Sí normalmente se usan para almacenar la configuración del desarrollador o las preferencias del usuario. Propiedades nunca se comparten entre secuencias de comandos.
Para ver las cuotas diarias y los límites de almacenamiento del servicio de propiedades, consulta Cuotas para los servicios de Google
Comparación de tiendas de propiedades
El
PropertiesService
El objeto global ofrece tres métodos, cada uno de los cuales muestra un valor similar
Properties
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 del documento abierto |
Se suele usar para | datos de configuración de toda la app, como el nombre de usuario y la contraseña del base de datos externa del desarrollador | Configuración específica del usuario, como métricas o unidades 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 cadenas en pares clave-valor. Tipos de datos que aún no son cadenas se convierten automáticamente en cadenas, lo que incluye métodos contenidos en los objetos guardados.
Cómo guardar datos
Para guardar un solo valor, llama al método Properties.setProperty(key,
value)
.
de la tienda 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 un
propiedad:
Lee datos
Para recuperar un solo valor que guardaste previamente, llama
Properties.getProperty(key)
:
Para recuperar todos los valores del almacén de la propiedad actual, llama a
Properties.getProperties()
:
Modificar datos
Los métodos getProperty()
y getProperties()
devuelven una copia del almacenamiento
no una visualización en vivo, por lo que cambiar el objeto que se muestra no actualizará el valor
en la tienda de la propiedad. Para actualizar los datos en el almacén, simplemente guárdalos nuevamente:
Cómo borrar datos
Para borrar un solo valor, llama a
Properties.deleteProperty(key)
:
Para borrar todas las propiedades de la tienda actual, llama a
Properties.deleteAllProperties()
:
Administrar manualmente las propiedades de las secuencias de comandos
Puedes agregar hasta cincuenta propiedades personalizadas de forma manual, como cadenas en pares clave-valor. en la página de configuración del proyecto. Para agregar más de cincuenta propiedades, debes agregarlas de forma programática con los métodos descritos anteriormente en Ahorro de datos. Cuando estableces propiedades de secuencias de comandos desde la página de configuración del proyecto, no puedes variables de secuencia de comandos de referencia.
Agrega 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 Agrega una propiedad de secuencia de comandos.
- Para agregar una segunda y posterior propiedad, en Propiedades de la secuencia de comandos, haz clic en Edita las propiedades de la secuencia de comandos > Agregar propiedad de la secuencia de comandos.
- En Propiedad, 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.
- Haz clic en Guardar propiedades de la secuencia de comandos.
Editar las 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.
- Realiza cambios en el nombre y el valor de la clave de cada propiedad que quieras cambiar.
- Haz 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 .
- Haz clic en Guardar propiedades de la secuencia de comandos.