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. As propriedades não podem ser compartilhadas entre scripts. Para mais informações sobre quando usar cada tipo de propriedade, consulte o guia do 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 esse script) que todos os usuários podem acessar no documento, planilha ou formulário aberto. |
getScriptProperties() | Properties | Recebe um armazenamento de propriedades que todos os usuários podem acessar, mas apenas nesse script. |
getUserProperties() | Properties | Recebe um armazenamento de propriedades que apenas o usuário atual pode acessar e somente neste script. |
Documentação detalhada
getDocumentProperties()
Recebe um armazenamento de propriedades (somente para esse script) que todos os usuários podem acessar no documento, planilha ou formulário aberto. Ela só estará disponível se o script for publicado e executado como um complemento ou se estiver vinculado a um tipo de arquivo do Google. Quando as propriedades do documento não estiverem disponíveis, esse método retornará null
. As propriedades de documentos criadas por um script não podem ser acessadas fora dele, mesmo por outros scripts que acessam o mesmo documento.
Retorno
Properties
: um armazenamento de propriedades para este script que apenas todos os usuários do documento atual podem
acessar ou null
se o script não for um complemento ou vinculado a um arquivo do Google
Workspace
getScriptProperties()
Recebe um armazenamento de propriedades que todos os usuários podem acessar, mas apenas nesse script.
Retorno
Properties
: um armazenamento de propriedades que todos os usuários do script podem acessar.
getUserProperties()
Recebe um armazenamento de propriedades que apenas o usuário atual pode acessar e somente neste script.
Retorno
Properties
: um armazenamento de propriedades que apenas o usuário atual do script pode acessar.