Servicio de propiedades

El servicio de propiedades te permite almacenar 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. 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.

Para ver las cuotas diarias y los límites de almacenamiento del servicio de Propiedades, consulta Cuotas de los servicios de Google.

Comparación de las tiendas de propiedades

El objeto global PropertiesService ofrece tres métodos, cada uno de los cuales muestra un objeto Properties similar, pero con diferentes derechos de acceso, 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 app web Todos los usuarios de un complemento en el documento abierto
Usos típicos 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 cadenas en pares clave-valor. Los tipos de datos que aún no son cadenas se convierten automáticamente en cadenas, incluidos los métodos contenidos en 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:

service/propertyService.gs
try {
  // Set a property in each of the three property stores.
  const scriptProperties = PropertiesService.getScriptProperties();
  const userProperties = PropertiesService.getUserProperties();
  const documentProperties = PropertiesService.getDocumentProperties();

  scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/');
  userProperties.setProperty('DISPLAY_UNITS', 'metric');
  documentProperties.setProperty('SOURCE_DATA_ID',
      '1j3GgabZvXUF177W0Zs_2v--H6SPCQb4pmZ6HsTZYT5k');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

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 independiente:

service/propertyService.gs
try {
  // Set multiple script properties in one call.
  const scriptProperties = PropertiesService.getScriptProperties();
  scriptProperties.setProperties({
    'cow': 'moo',
    'sheep': 'baa',
    'chicken': 'cluck'
  });
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Lee datos

Para recuperar un solo valor que hayas guardado anteriormente, llama a Properties.getProperty(key):

service/propertyService.gs
try {
  // Get the value for the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  const units = userProperties.getProperty('DISPLAY_UNITS');
  console.log('values of units %s', units);
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Para recuperar todos los valores del almacén de propiedades actual, llama a Properties.getProperties():

service/propertyService.gs
try {
  // Get multiple script properties in one call, then log them all.
  const scriptProperties = PropertiesService.getScriptProperties();
  const data = scriptProperties.getProperties();
  for (const key in data) {
    console.log('Key: %s, Value: %s', key, data[key]);
  }
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

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 de la tienda, vuelve a guardarlos:

service/propertyService.gs
try {
  // Change the unit type in the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  let units = userProperties.getProperty('DISPLAY_UNITS');
  units = 'imperial'; // Only changes local value, not stored value.
  userProperties.setProperty('DISPLAY_UNITS', units); // Updates stored value.
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Cómo borrar datos

Para borrar un solo valor, llama a Properties.deleteProperty(key):

service/propertyService.gs
try {
  // Delete the user property 'DISPLAY_UNITS'.
  const userProperties = PropertiesService.getUserProperties();
  userProperties.deleteProperty('DISPLAY_UNITS');
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Para borrar todas las propiedades de la tienda actual, llama a Properties.deleteAllProperties():

service/propertyService.gs
try {
  // Get user properties in the current script.
  const userProperties = PropertiesService.getUserProperties();
  // Delete all user properties in the current script.
  userProperties.deleteAllProperties();
} catch (err) {
  // TODO (developer) - Handle exception
  console.log('Failed with error %s', err.message);
}

Cómo administrar las propiedades de la secuencia de comandos de forma manual

Puedes agregar hasta cincuenta propiedades personalizadas, como cadenas en pares clave-valor, desde 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 que se describieron anteriormente en Cómo guardar datos. Cuando configuras propiedades de secuencia de comandos desde la página de configuración del proyecto, no puedes hacer referencia a las variables de secuencia de comandos.

Agrega propiedades de secuencia de comandos

  1. Abre tu proyecto de Apps Script.
  2. A la izquierda, haz clic en Configuración del proyecto El ícono de configuración del proyecto.
  3. Para agregar la primera propiedad, en Script Properties, haz clic en Add script property.
  4. Para agregar la segunda propiedad y las siguientes, en Script Properties, haz clic en Edit script properties > Add script property.
  5. En Propiedad, ingresa el nombre de la clave.
  6. En Valor, ingresa el valor de la clave.
  7. Para agregar más propiedades, haz clic en Agregar propiedad de secuencia de comandos (opcional).
  8. Haz clic en Guardar las propiedades de la secuencia de comandos.

Edita las propiedades de la secuencia de comandos

  1. Abre tu proyecto de Apps Script.
  2. A la izquierda, haz clic en Configuración del proyecto El ícono de configuración del proyecto.
  3. En Script Properties, haz clic en Edit script properties.
  4. Realiza cambios en el nombre y el valor de la clave de cada propiedad que quieras cambiar.
  5. Haz clic en Guardar las propiedades de la secuencia de comandos.

Cómo borrar propiedades de secuencias de comandos

  1. Abre tu proyecto de Apps Script.
  2. A la izquierda, haz clic en Configuración del proyecto El ícono de configuración del proyecto.
  3. En Script Properties, haz clic en Edit script properties.
  4. Junto a la propiedad que quieres borrar, haz clic en Quitar .
  5. Haz clic en Guardar las propiedades de la secuencia de comandos.