Enum AuthMode

AuthMode

Uma enumeração que identifica quais categorias de serviços autorizados o Apps Script podem executar com uma função acionada. Esses valores são expostos em funções acionadas como a propriedade authMode do parâmetro de evento, e. Para mais informações, consulte o guia do ciclo de vida de autorização para complementos.

Para chamar um tipo enumerado, chame a classe, o nome e a propriedade pai dele. Por exemplo, ScriptApp.AuthMode.CUSTOM_FUNCTION.

function onOpen(e) {
  var menu = SpreadsheetApp.getUi().createAddonMenu();
  if (e && e.authMode == ScriptApp.AuthMode.NONE) {
    // Add a normal menu item (works in all authorization modes).
    menu.addItem('Start workflow', 'startWorkflow');
  } else {
    // Add a menu item based on properties (doesn't work in AuthMode.NONE).
    var properties = PropertiesService.getDocumentProperties();
    var workflowStarted = properties.getProperty('workflowStarted');
    if (workflowStarted) {
      menu.addItem('Check workflow status', 'checkWorkflow');
    } else {
      menu.addItem('Start workflow', 'startWorkflow');
    }
    // Record analytics.
    UrlFetchApp.fetch('http://www.example.com/analytics?event=open');
  }
  menu.addToUi();
}

Propriedades

Propriedade	Tipo	Descrição
NONE	Enum	Um modo que não permite acesso a nenhum serviço que exige autorização. Esse modo ocorre quando um complemento executa um acionador simples da onOpen(e) e o usuário instalou um complemento em um documento diferente, mas o complemento não foi usado no documento atual.
CUSTOM_FUNCTION	Enum	Um modo que permite acesso a um subconjunto limitado de serviços para uso em funções de planilhas personalizadas. Alguns desses serviços, incluindo o acesso somente leitura ao serviço de planilhas, normalmente exigem autorização, mas são permitidos sem autorização quando usados em uma função personalizada. Como as funções personalizadas não incluem um parâmetro de evento, esse valor nunca é retornado. Ele é documentado apenas para demonstrar que as funções personalizadas são executadas no próprio modo de autorização.
LIMITED	Enum	Um modo que permite acesso a um subconjunto limitado de serviços. Esse modo ocorre quando um complemento ou um script vinculado a um documento executa um acionador simples onOpen(e) ou onEdit(e), exceto no caso descrito para NONE.
FULL	Enum	Um modo que dá acesso a todos os serviços que exigem autorização. Esse modo ocorre quando um complemento ou script é executado como resultado de qualquer gatilho diferente dos casos descritos para LIMITED ou NONE.