Class PropertiesService

PropriedadesServiço

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. 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.
const documentProperties = PropertiesService.getDocumentProperties();
const scriptProperties = PropertiesService.getScriptProperties();
const 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()PropertiesExtrai uma loja de propriedades (somente para este script) que todos os usuários podem acessar no documento, na planilha ou no formulário aberto.
getScriptProperties()PropertiesExtrai uma loja de propriedades que todos os usuários podem acessar, mas apenas neste script.
getUserProperties()PropertiesRetorna um repositório de propriedades que só o usuário atual pode acessar e apenas neste script.

Documentação detalhada

getDocumentProperties()

Extrai uma loja de propriedades (somente para este script) que todos os usuários podem acessar no documento, na planilha ou no formulário aberto. Ele 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 de documento criadas por um script não são acessíveis fora dele, nem mesmo por outros scripts que acessem o mesmo documento.

Retornar

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

getScriptProperties()

Extrai uma loja de propriedades que todos os usuários podem acessar, mas apenas neste script.

Retornar

Properties: um repositório de propriedades que todos os usuários do script podem acessar

getUserProperties()

Retorna um repositório de propriedades que só o usuário atual pode acessar e apenas neste script.

Retornar

Properties: uma loja de propriedades que só o usuário atual do script pode acessar