Class Properties

Propiedades

El objeto properties actúa como interfaz para acceder a las propiedades del usuario, del documento o de la secuencia de comandos. El tipo de propiedad específico depende de cuál de los tres métodos de PropertiesService llamó la secuencia de comandos: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() o PropertiesService.getScriptProperties(). Las propiedades no se pueden compartir entre secuencias de comandos. Para obtener más información sobre los tipos de propiedades, consulta la guía del servicio de Properties.

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
deleteAllProperties()	Properties	Borra todas las propiedades de la tienda Properties actual.
deleteProperty(key)	Properties	Borra la propiedad con la clave determinada en el almacén Properties actual.
getKeys()	String[]	Obtiene todas las claves del almacén Properties actual.
getProperties()	Object	Obtiene una copia de todos los pares clave-valor en el almacén de Properties actual.
getProperty(key)	String	Obtiene el valor asociado a la clave determinada en el almacén Properties actual o null si no existe tal clave.
setProperties(properties)	Properties	Establece todos los pares clave-valor del objeto determinado en el almacén Properties actual.
setProperties(properties, deleteAllOthers)	Properties	Establece todos los pares clave-valor del objeto determinado en el almacén Properties actual y, de manera opcional, borra todas las demás propiedades del almacén.
setProperty(key, value)	Properties	Establece el par clave-valor determinado en el almacén Properties actual.

Documentación detallada

deleteAllProperties()

Borra todas las propiedades de la tienda Properties actual.

// Deletes all user properties.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteAllProperties();

Volver

Properties: Esta tienda de Properties, para encadenar

---

deleteProperty(key)

Borra la propiedad con la clave determinada en el almacén Properties actual.

// Deletes the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
userProperties.deleteProperty('nickname');

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave de la propiedad que se borrará.

Volver

Properties: Esta tienda de Properties, para encadenar

---

getKeys()

Obtiene todas las claves del almacén Properties actual.

// Sets several properties, then logs the value of each key.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});
const keys = scriptProperties.getKeys();
Logger.log('Animals known:');
for (let i = 0; i < keys.length; i++) {
  Logger.log(keys[i]);
}

Volver

String[]: Es un array de todas las claves del almacén Properties actual.

---

getProperties()

Obtiene una copia de todos los pares clave-valor en el almacén de Properties actual. Ten en cuenta que el objeto devuelto no es una vista en tiempo real de la tienda. Por lo tanto, cambiar las propiedades en el objeto devuelto no las actualizará automáticamente en el almacenamiento, y viceversa.

// Sets several script properties, then retrieves them and logs them.
const scriptProperties = PropertiesService.getScriptProperties();
scriptProperties.setProperties({
  cow: 'moo',
  sheep: 'baa',
  chicken: 'cluck',
});

const animalSounds = scriptProperties.getProperties();

// Logs:
// A chicken goes cluck!
// A cow goes moo!
// A sheep goes baa!
for (const kind in animalSounds) {
  Logger.log('A %s goes %s!', kind, animalSounds[kind]);
}

Volver

Object: Una copia de todos los pares clave-valor en el almacén Properties actual

---

getProperty(key)

Obtiene el valor asociado a la clave determinada en el almacén Properties actual o null si no existe tal clave.

// Gets the user property 'nickname'.
const userProperties = PropertiesService.getUserProperties();
const nickname = userProperties.getProperty('nickname');
Logger.log(nickname);

Parámetros

Nombre	Tipo	Descripción
key	String	Es la clave del valor de la propiedad que se recuperará.

Volver

String: Es el valor asociado a la clave determinada en el almacén Properties actual.

---

setProperties(properties)

Establece todos los pares clave-valor del objeto determinado en el almacén Properties actual.

// Sets multiple user properties at once.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties);

Parámetros

Nombre	Tipo	Descripción
properties	Object	Un objeto que contiene pares clave-valor para configurar

Volver

Properties: Esta tienda de Properties, para encadenar

---

setProperties(properties, deleteAllOthers)

Establece todos los pares clave-valor del objeto determinado en el almacén Properties actual y, de manera opcional, borra todas las demás propiedades del almacén.

// Sets multiple user properties at once while deleting all other user
// properties.
const userProperties = PropertiesService.getUserProperties();
const newProperties = {
  nickname: 'Bob',
  region: 'US',
  language: 'EN'
};
userProperties.setProperties(newProperties, true);

Parámetros

Nombre	Tipo	Descripción
properties	Object	Un objeto que contiene pares clave-valor para configurar
deleteAllOthers	Boolean	true para borrar todos los demás pares clave-valor del objeto properties; false para no hacerlo

Volver

Properties: Esta tienda de Properties, para encadenar

---

setProperty(key, value)

Establece el par clave-valor determinado en el almacén Properties actual.

// Sets the user property 'nickname' to 'Bobby'.
const userProperties = PropertiesService.getUserProperties();
userProperties.setProperty('nickname', 'Bobby');

Parámetros

Nombre	Tipo	Descripción
key	String	clave de la propiedad
value	String	El valor que se asociará con la clave

Volver

Properties: Esta tienda de Properties, para encadenar