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 Properties
o
script chamou: Properties
, Properties
ou Properties
.
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étodo | Tipo de retorno | Breve descrição |
---|---|---|
delete | Properties | Exclui todas as propriedades na loja Properties atual. |
delete | Properties | Exclui a propriedade com a chave especificada na loja Properties atual. |
get | String[] | Recebe todas as chaves na loja Properties atual. |
get | Object | Recebe uma cópia de todos os pares de chave-valor na loja Properties atual. |
get | String | Consegue o valor associado à chave especificada na loja Properties atual ou null se essa chave não existir. |
set | Properties | Define todos os pares de chave-valor do objeto especificado na loja Properties atual. |
set | Properties | Define todos os pares de chave-valor do objeto especificado na loja Properties atual,
opcionalmente excluindo todas as outras propriedades da loja. |
set | Properties | Define o par de chave-valor especificado na loja Properties atual. |
Documentação detalhada
delete All Properties()
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
delete Property(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
Nome | Tipo | Descrição |
---|---|---|
key | String | a chave da propriedade a ser excluída |
Retornar
Properties
: esta loja Properties
, para encadeamento
get Keys()
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
get Properties()
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
get Property(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
Nome | Tipo | Descrição |
---|---|---|
key | String | a chave para o valor da propriedade a ser recuperado |
Retornar
String
: o valor associado à chave especificada na loja Properties
atual
set Properties(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
: esta loja Properties
, para encadeamento
set Properties(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
Nome | Tipo | Descrição |
---|---|---|
properties | Object | Um objeto que contém pares de chave-valor a serem definidos |
delete | Boolean | true 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
set Property(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
Nome | Tipo | Descrição |
---|---|---|
key | String | a chave da propriedade |
value | String | o valor a ser associado à chave |
Retornar
Properties
: esta loja Properties
, para encadeamento