Class Properties

Propriedades

O objeto de propriedades atua como a interface para acessar propriedades de usuário, documento ou 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 Properties.

Métodos

Método	Tipo de retorno	Breve descrição
deleteAllProperties()	Properties	Exclui todas as propriedades no repositório Properties atual.
deleteProperty(key)	Properties	Exclui a propriedade com a chave especificada no repositório Properties atual.
getKeys()	String[]	Recebe todas as chaves no repositório Properties atual.
getProperties()	Object	Recebe uma cópia de todos os pares de chave-valor no repositório Properties atual.
getProperty(key)	String	Recebe o valor associado à chave especificada no repositório Properties atual ou null se essa chave não existir.
setProperties(properties)	Properties	Define todos os pares de chave-valor do objeto especificado na loja Properties atual.
setProperties(properties, deleteAllOthers)	Properties	Define todos os pares de chave-valor do objeto especificado na loja Properties atual, excluindo opcionalmente todas as outras propriedades na loja.
setProperty(key, value)	Properties	Define o par de chave-valor especificado no repositório Properties atual.

Documentação detalhada

deleteAllProperties()

Exclui todas as propriedades no repositório Properties atual.

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

Retornar

Properties — esse repositório Properties, para encadeamento

---

deleteProperty(key)

Exclui a propriedade com a chave especificada no repositório Properties atual.

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

Parâmetros

Nome	Tipo	Descrição
key	String	a chave da propriedade a ser excluída

Retornar

Properties — esse repositório Properties, para encadeamento

---

getKeys()

Recebe todas as chaves no repositório 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 no repositório Properties atual

---

getProperties()

Recebe uma cópia de todos os pares de chave-valor no repositório Properties atual. Observe que o objeto retornado não é uma visualização dinâmica do repositório. Consequentemente, a mudança das propriedades no objeto retornado não as atualiza automaticamente no armazenamento e 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 no repositório Properties atual

---

getProperty(key)

Recebe o valor associado à chave especificada no repositório 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

Nome	Tipo	Descrição
key	String	a chave do valor da propriedade a ser recuperada

Retornar

String: o valor associado à chave especificada no repositório 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

Nome	Tipo	Descrição
properties	Object	um objeto que contém pares de chave-valor a serem definidos

Retornar

Properties — esse repositório Properties, para encadeamento

---

setProperties(properties, deleteAllOthers)

Define todos os pares de chave-valor do objeto especificado na loja Properties atual, excluindo opcionalmente todas as outras propriedades na 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

Nome	Tipo	Descrição
properties	Object	um objeto que contém pares de chave-valor a serem definidos
deleteAllOthers	Boolean	true para excluir todos os outros pares de chave-valor no objeto de propriedades ; false para não

Retornar

Properties — esse repositório Properties, para encadeamento

---

setProperty(key, value)

Define o par de chave-valor especificado no repositório Properties atual.

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

Parâmetros

Nome	Tipo	Descrição
key	String	a chave da propriedade
value	String	o valor a ser associado à chave

Retornar

Properties — esse repositório Properties, para encadeamento