Class Properties

Propriedades

O objeto de propriedades funciona como a interface para acessar 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 os tipos de propriedade, consulte o guia do serviço de propriedades.

Métodos

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

Documentação detalhada

deleteAllProperties()

Exclui todas as propriedades na loja Properties atual. 

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

Retornar

Properties: esta loja Properties, para encadeamento

deleteProperty(key)

Exclui a propriedade com a chave especificada na loja Properties atual. 

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

Parâmetros

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

Retornar

Properties: esta loja Properties, para encadeamento

getKeys()

Recebe todas as chaves na loja Properties atual. 

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

Retornar

String[]: uma matriz de todas as chaves na loja Properties atual

getProperties()

Recebe uma cópia de todos os pares de chave-valor na loja Properties atual. O objeto retornado não é uma visualização em tempo real da loja. Consequentemente, mudar as propriedades no objeto retornado não vai atualizá-las automaticamente no armazenamento, ou vice-versa. 

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

Retornar

Object: uma cópia de todos os pares de chave-valor na loja Properties atual

getProperty(key)

Consegue o valor associado à chave especificada na loja Properties atual ou null se essa chave não existir. 

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

Parâmetros

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

Retornar

String: o valor associado à chave especificada na loja Properties atual

setProperties(properties)

Define todos os pares de chave-valor do objeto especificado na loja Properties atual. 

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

Retornar

Properties: esta loja Properties, para encadeamento

setProperties(properties, deleteAllOthers)

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

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

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 excluir

Retornar

Properties: esta loja Properties, para encadeamento

setProperty(key, value)

Define o par de chave-valor especificado na loja Properties atual. 

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

Parâmetros

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

Retornar

Properties: esta loja Properties, para encadeamento