Se usó la API de Cloud Translation para traducir esta página.

Class Properties

El objeto de propiedades actúa como la interfaz para acceder a las propiedades de usuarios, documentos o secuencias de comandos. El depende de cuál de los tres métodos de PropertiesService de comandos llamada: 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 sobre el servicio Propiedades.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`deleteAllProperties()`	`Properties`	Borra todas las propiedades del almacén de `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 del almacén `Properties` actual.
`getProperty(key)`	`String`	Obtiene el valor asociado con la clave determinada en el almacén actual de `Properties`, o `null` si no existe tal clave.
`setProperties(properties)`	`Properties`	Establece todos los pares clave-valor del objeto dado en el almacén `Properties` actual.
`setProperties(properties, deleteAllOthers)`	`Properties`	Establece todos los pares clave-valor del objeto dado en el almacén `Properties` actual. opcionalmente borrar todas las demás propiedades de la tienda.
`setProperty(key, value)`	`Properties`	Establece el par clave-valor determinado en el almacén `Properties` actual.

Documentación detallada

`deleteAllProperties()`

Borra todas las propiedades del almacén de Properties actual.

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

Volver

Properties: Esta tienda de Properties, para encadenamiento

`deleteProperty(key)`

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

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

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	la clave para que la propiedad borre

Volver

Properties: Esta tienda de Properties, para encadenamiento

`getKeys()`

Obtiene todas las claves del almacén Properties actual.

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

Volver

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

`getProperties()`

Obtiene una copia de todos los pares clave-valor del almacén Properties actual. Ten en cuenta que que se muestra no es una visualización en vivo de la tienda. Por lo tanto, si modificamos las propiedades el objeto que se devuelve no los actualizará automáticamente en el almacenamiento, ni viceversa.

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

var animalSounds = scriptProperties.getProperties();

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

Volver

Object: Es una copia de todos los pares clave-valor del almacén de Properties actual.

`getProperty(key)`

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

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

Parámetros

Nombre	Tipo	Descripción
`key`	`String`	la clave del valor de la propiedad para recuperar

Volver

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

`setProperties(properties)`

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

// Sets multiple user properties at once.
var userProperties = PropertiesService.getUserProperties();
var 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 establecer

Volver

Properties: Esta tienda de Properties, para encadenamiento

`setProperties(properties, deleteAllOthers)`

Establece todos los pares clave-valor del objeto dado en el almacén Properties actual. opcionalmente borrar todas las demás propiedades de la tienda.

// Sets multiple user properties at once while deleting all other user properties.
var userProperties = PropertiesService.getUserProperties();
var 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 establecer
`deleteAllOthers`	`Boolean`	`true` para borrar todos los demás pares clave-valor de las propiedades object; `false` para no enviar

Volver

Properties: Esta tienda de Properties, para encadenamiento

`setProperty(key, value)`

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

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

Parámetros

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

Volver

Properties: Esta tienda de Properties, para encadenamiento