Esta página foi traduzida pela API Cloud Translation.

Class Properties

O objeto de propriedades atua como a interface para acessar as propriedades do usuário, do documento ou do script. A tipo de propriedade específico depende de qual dos três métodos de PropertiesService o um script chamado PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties() ou PropertiesService.getScriptProperties(). Não é possível compartilhar propriedades entre scripts. Para mais informações sobre os tipos de propriedade, consulte a guia sobre o serviço de propriedades.

Métodos

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

Documentação detalhada

`deleteAllProperties()`

Exclui todas as propriedades no armazenamento atual do Properties.

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

Retornar

Properties: esta loja de Properties, para encadeamento

`deleteProperty(key)`

Exclui a propriedade com a chave informada no armazenamento atual de Properties.

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

Parâmetros

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

Retornar

Properties: esta loja de Properties, para encadeamento

`getKeys()`

Recebe todas as chaves no armazenamento atual de Properties.

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

Retornar

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

`getProperties()`

Recebe uma cópia de todos os pares de chave-valor no armazenamento atual de Properties. Observe que o objeto retornado não é uma visualização ao vivo da loja. Consequentemente, a alteração das propriedades da um objeto retornado não os atualizará 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]);
}

Retornar

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

`getProperty(key)`

Recebe o valor associado à chave especificada no armazenamento atual de Properties 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

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

Retornar

String: o valor associado à chave fornecida no armazenamento atual de Properties.

`setProperties(properties)`

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

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

Retornar

Properties: esta loja de Properties, para encadeamento

`setProperties(properties, deleteAllOthers)`

Define todos os pares de chave-valor do objeto especificado no armazenamento atual de Properties. ou excluir todas as outras propriedades na loja.

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

Nome	Tipo	Descrição
`properties`	`Object`	um objeto que contém pares de chave-valor para definir
`deleteAllOthers`	`Boolean`	`true` para excluir todos os outros pares de chave-valor das propriedades object; `false` para não

Retornar

Properties: esta loja de Properties, para encadeamento

`setProperty(key, value)`

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

// Sets the user property 'nickname' to 'Bobby'.
var 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: esta loja de Properties, para encadeamento