Enum AuthMode

AuthMode

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

Para chamar um tipo enumerado, chame a classe mãe, o nome e a propriedade 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

PropriedadeTipoDescrição
NONEEnumUm modo que não permite o acesso a nenhum serviço que exija autorização. Esse modo ocorre quando um complemento executa um gatilho simples onOpen(e) e o usuário instala um complemento em um documento diferente, mas ele não tiver sido usado no documento atual.
CUSTOM_FUNCTIONEnumum modo que permite acesso a um subconjunto limitado de serviços para uso em 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 um ambiente função. Como as funções personalizadas não incluem um parâmetro de evento, esse valor nunca é returned; ela é documentada apenas para demonstrar que as funções personalizadas são executadas nos próprios modo de autorização.
LIMITEDEnumum modo que permite acesso a um subconjunto limitado de serviços. Esse modo ocorre quando um complemento ou um um script vinculado a um documento executa um acionador simples onOpen(e) ou onEdit(e), exceto no caso descrito para NONE.
FULLEnumUm modo que concede acesso a todos os serviços que exigem autorização. Esse modo ocorre quando uma ou um script é executado como resultado de qualquer gatilho diferente dos casos descritos para LIMITED ou NONE.