El objeto de propiedades actúa como la interfaz para acceder a las propiedades del usuario, el documento o la secuencia de comandos. El tipo de propiedad específico depende de cuál de los tres métodos de PropertiesService
llamó a la secuencia de comandos: PropertiesService.getDocumentProperties()
, PropertiesService.getUserProperties()
o PropertiesService.getScriptProperties()
.
No se pueden compartir propiedades entre secuencias de comandos. Para obtener más información sobre los tipos de propiedad, consulta la guía del servicio de propiedades.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
deleteAllProperties() | Properties | Borra todas las propiedades del almacén Properties actual. |
deleteProperty(key) | Properties | Borra la propiedad con la clave proporcionada en el almacén Properties actual. |
getKeys() | String[] | Obtiene todas las claves en el almacén Properties actual. |
getProperties() | Object | Obtiene una copia de todos los pares clave-valor en el almacén Properties actual. |
getProperty(key) | String | Obtiene el valor asociado con la clave dada en el almacén Properties actual o null si no existe esa clave. |
setProperties(properties) | Properties | Configura todos los pares clave-valor del objeto dado en el almacén Properties actual. |
setProperties(properties, deleteAllOthers) | Properties | Configura 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 del almacén Properties
actual.
// Deletes all user properties. var userProperties = PropertiesService.getUserProperties(); userProperties.deleteAllProperties();
Devolvedor
Properties
: Esta tienda de Properties
para encadenamiento
deleteProperty(key)
Borra la propiedad con la clave proporcionada 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 de la propiedad para borrar |
Devolvedor
Properties
: Esta tienda de Properties
para encadenamiento
getKeys()
Obtiene todas las claves en el 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]); }
Devolvedor
String[]
: Es un array de todas las claves en el almacén de Properties
actual.
getProperties()
Obtiene una copia de todos los pares clave-valor en el almacén Properties
actual. Ten en cuenta que el objeto que se muestra no es una visualización en vivo de la tienda. En consecuencia, cambiar las propiedades en el objeto que se muestra no las actualizará automáticamente en el almacenamiento, o 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]); }
Devolvedor
Object
: Es una copia de todos los pares clave-valor en el almacén Properties
actual.
getProperty(key)
Obtiene el valor asociado con la clave dada en el almacén Properties
actual o null
si no existe esa 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 propiedad para recuperar |
Devolvedor
String
: Es el valor asociado con la clave dada en el almacén de Properties
actual.
setProperties(properties)
Configura 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 |
Devolvedor
Properties
: Esta tienda de Properties
para encadenamiento
setProperties(properties, deleteAllOthers)
Configura 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. 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 en el objeto de propiedades; false para no borrar |
Devolvedor
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 |
Devolvedor
Properties
: Esta tienda de Properties
para encadenamiento