Class Properties

Propriedades

O objeto de propriedades atua como a interface para acessar as propriedades do usuário, do documento ou do script. O tipo de propriedade específico depende de qual dos três métodos de PropertiesService o script chamou: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() ou PropertiesService.getScriptProperties(). As propriedades não podem ser compartilhadas entre scripts. Para mais informações sobre tipos de propriedade, consulte o guia do serviço de propriedades.

Métodos

MétodoTipo de retornoBreve descrição
deleteAllProperties()PropertiesExclui todas as propriedades no armazenamento Properties atual.
deleteProperty(key)PropertiesExclui a propriedade com a chave fornecida no armazenamento Properties atual.
getKeys()String[]Recebe todas as chaves no armazenamento Properties atual.
getProperties()ObjectRecebe uma cópia de todos os pares de chave-valor no armazenamento Properties atual.
getProperty(key)StringRecebe o valor associado à chave especificada no armazenamento Properties atual ou null se essa chave não existir.
setProperties(properties)PropertiesDefine todos os pares de chave-valor do objeto especificado no armazenamento Properties atual.
setProperties(properties, deleteAllOthers)PropertiesDefine todos os pares de chave-valor do objeto especificado no armazenamento Properties atual, excluindo opcionalmente todas as outras propriedades no armazenamento.
setProperty(key, value)PropertiesDefine o par de chave-valor informado no armazenamento Properties atual.

Documentação detalhada

deleteAllProperties()

Exclui todas as propriedades no armazenamento Properties atual.

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

Retorno

Properties: esta loja da Properties, para encadeamento


deleteProperty(key)

Exclui a propriedade com a chave fornecida no armazenamento Properties atual.

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

Parâmetros

NomeTipoDescrição
keyStringa chave da propriedade a ser excluída

Retorno

Properties: esta loja da Properties, para encadeamento


getKeys()

Recebe todas as chaves no armazenamento Properties atual.

// 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]);
}

Retorno

String[]: uma matriz de todas as chaves no armazenamento Properties atual.


getProperties()

Recebe uma cópia de todos os pares de chave-valor no armazenamento Properties atual. Observe que o objeto retornado não é uma visualização ao vivo da loja. Consequentemente, alterar as propriedades no objeto retornado não fará com que elas sejam atualizadas automaticamente no armazenamento ou vice-versa.

// 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]);
}

Retorno

Object: uma cópia de todos os pares de chave-valor no armazenamento Properties atual.


getProperty(key)

Recebe o valor associado à chave especificada no armazenamento Properties atual ou null se essa chave não existir.

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

Parâmetros

NomeTipoDescrição
keyStringa chave do valor da propriedade a ser recuperado

Retorno

String: o valor associado à chave especificada no armazenamento Properties atual


setProperties(properties)

Define todos os pares de chave-valor do objeto especificado no armazenamento Properties atual.

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

Parâmetros

NomeTipoDescrição
propertiesObjectum objeto que contém pares de chave-valor a serem definidos

Retorno

Properties: esta loja da Properties, para encadeamento


setProperties(properties, deleteAllOthers)

Define todos os pares de chave-valor do objeto especificado no armazenamento Properties atual, excluindo opcionalmente todas as outras propriedades no armazenamento.

// 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

NomeTipoDescrição
propertiesObjectum objeto que contém pares de chave-valor a serem definidos
deleteAllOthersBooleantrue para excluir todos os outros pares de chave-valor no objeto de propriedades, false para não

Retorno

Properties: esta loja da Properties, para encadeamento


setProperty(key, value)

Define o par de chave-valor informado no armazenamento Properties atual.

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

Parâmetros

NomeTipoDescrição
keyStringa chave da propriedade
valueStringo valor a ser associado à chave

Retorno

Properties: esta loja da Properties, para encadeamento