Permite que os scripts armazenem dados simples em pares de chave-valor com escopo para um script, um usuário de um script ou um documento em que um complemento é usado. Não é possível compartilhar propriedades entre scripts. Para mais informações sobre quando usar cada tipo de propriedade, consulte o guia para o serviço de propriedades.
// Sets three properties of different types.
var documentProperties = PropertiesService.getDocumentProperties();
var scriptProperties = PropertiesService.getScriptProperties();
var userProperties = PropertiesService.getUserProperties();
documentProperties.setProperty('DAYS_TO_FETCH', '5');
scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
userProperties.setProperty('DISPLAY_UNITS', 'metric');
Métodos
| Método | Tipo de retorno | Breve descrição |
|---|---|---|
getDocumentProperties() | Properties | Recebe um armazenamento de propriedades (somente para este script) que todos os usuários podem acessar no documento, planilha ou formulário. |
getScriptProperties() | Properties | Recebe um repositório de propriedades que todos os usuários podem acessar, mas somente nesse script. |
getUserProperties() | Properties | Recebe um repositório de propriedades que somente o usuário atual pode acessar e somente nesse script. |
Documentação detalhada
getDocumentProperties()
Recebe um armazenamento de propriedades (somente para este script) que todos os usuários podem acessar no
documento, planilha ou formulário. Ela só vai estar disponível se o script for publicado e executado.
como um complemento ou se estiver vinculado a um arquivo do Google
não é válido. Quando as propriedades do documento não estão disponíveis, esse método retorna null. Documento
As propriedades criadas por um script não podem ser acessadas fora dele, nem mesmo por outros scripts
acessar o mesmo documento.
Retornar
Properties: um armazenamento de propriedades apenas para esse script que todos os usuários do documento atual podem
ou null se o script não for um complemento ou não estiver vinculado a uma conta do
Arquivo do espaço de trabalho
getScriptProperties()
Recebe um repositório de propriedades que todos os usuários podem acessar, mas somente nesse script.
Retornar
Properties: um armazenamento de propriedades que todos os usuários do script podem acessar.
getUserProperties()
Recebe um repositório de propriedades que somente o usuário atual pode acessar e somente nesse script.
Retornar
Properties: um armazenamento de propriedades que apenas o usuário atual do script pode acessar.