Enum AuthMode

AuthMode

Énumération qui identifie les catégories de services autorisés qu'Apps Script peut exécuter via une fonction déclenchée. Ces valeurs sont exposées dans les fonctions déclenchées en tant que authMode propriété du paramètre d'événement, e. Pour en savoir plus, consultez le guide sur le cycle de vie de l'autorisation pour les modules complémentaires.

Pour appeler une énumération, vous devez appeler sa classe parente, son nom et sa propriété. Par exemple : ScriptApp.AuthMode.CUSTOM_FUNCTION.

function onOpen(e) {
  const 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).
    const properties = PropertiesService.getDocumentProperties();
    const 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();
}

Propriétés

PropriétéTypeDescription
NONEEnumMode qui n'autorise l'accès à aucun service nécessitant une autorisation. Ce mode se produit lorsqu'un module complémentaire exécute un onOpen(e) déclencheur simple et que l'utilisateur a installé un module complémentaire dans un autre document, mais qu'il n'a pas été utilisé dans le document actuel.
CUSTOM_FUNCTIONEnumMode qui autorise l'accès à un sous-ensemble limité de services à utiliser dans des fonctions de feuille de calcul personnalisées. Certains de ces services, y compris l'accès en lecture seule au service de feuille de calcul, nécessitent normalement une autorisation, mais sont autorisés sans autorisation lorsqu'ils sont utilisés dans une fonction personnalisée. Étant donné que les fonctions personnalisées n'incluent pas de paramètre d'événement, cette valeur n'est jamais renvoyée. Elle est documentée uniquement pour montrer que les fonctions personnalisées s'exécutent dans leur propre mode d'autorisation.
LIMITEDEnumMode qui autorise l'accès à un sous-ensemble limité de services. Ce mode se produit lorsqu'un module complémentaire ou un script lié à un document exécute un onOpen(e) ou onEdit(e) déclencheur simple, sauf dans le cas décrit pour NONE.
FULLEnumMode qui autorise l'accès à tous les services nécessitant une autorisation. Ce mode se produit lorsqu'un module complémentaire ou un script s'exécute à la suite d'un déclencheur autre que ceux décrits pour LIMITED ou NONE.