Class PropertiesService

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
PropertiesService

Permite que os scripts armazenem dados simples em pares de chave-valor no escopo de 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 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étodoTipo de retornoBreve descrição
getDocumentProperties()PropertiesRecebe um armazenamento de propriedades (somente para este script) que todos os usuários podem acessar no documento, planilha ou formulário aberto.
getScriptProperties()PropertiesRecebe um armazenamento de propriedades que todos os usuários podem acessar, mas somente nesse script.
getUserProperties()PropertiesRecebe um armazenamento 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 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 estão disponíveis, esse método retorna null. As propriedades do documento criadas por um script não podem ser acessadas fora desse script, mesmo por outros scripts que acessam o mesmo documento.

Retornar

Properties: um armazenamento de propriedades para esse script somente que todos os usuários do documento atual podem acessar ou null se o script não for um complemento ou estiver vinculado a um arquivo do Google Workspace


getScriptProperties()

Recebe um armazenamento 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 armazenamento de propriedades que somente o usuário atual pode acessar e somente nesse script.

Retornar

Properties: um armazenamento de propriedades que somente o usuário atual do script pode acessar.