Champs d'application des autorisations

Les utilisateurs doivent autoriser les projets de script qui accèdent à leurs données ou agissent en leur nom. Lorsqu'un utilisateur exécute un script nécessitant une autorisation pour la première fois, l'UI affiche une invite pour lancer le flux d'autorisation.

Au cours de ce flux, l'UI indique à l'utilisateur ce que le script souhaite faire. Par exemple, un script peut demander l'autorisation de lire les e-mails de l'utilisateur ou de créer des événements dans son agenda. Le projet de script définit ces autorisations individuelles en tant que champs d'application OAuth.

Pour la plupart des scripts, Apps Script détecte automatiquement les portées dont vous avez besoin. Vous pouvez afficher les portées utilisées par un script à tout moment. Vous pouvez également définir des champs d'application explicitement dans votre fichier manifeste à l'aide de chaînes d'URL. Il est parfois nécessaire de définir explicitement des champs d'application pour certaines applications telles que les modules complémentaires, car les applications publiées doivent toujours utiliser les champs d'application les plus restreints possible.

Au cours du flux d'autorisation, Apps Script présente à l'utilisateur des descriptions lisibles des champs d'application requis. Par exemple, si votre script a besoin d'un accès en lecture seule à vos feuilles de calcul, le champ d'application du fichier manifeste peut être https://www.googleapis.com/auth/spreadsheets.readonly. Au cours du flux d'autorisation, un script avec cette habilitation demande à l'utilisateur d'autoriser cette application à "Afficher vos feuilles de calcul Google".

Certains champs d'application englobent d'autres. Par exemple, lorsqu'il est autorisé, le champ d'application https://www.googleapis.com/auth/spreadsheets autorise un accès en lecture et en écriture aux feuilles de calcul.

Pour certaines surfaces sur lesquelles des scripts s'exécutent, comme l'exécution d'un script directement depuis l'IDE Apps Script, l'écran de consentement OAuth détaillé s'affiche. Cela permet aux utilisateurs de sélectionner des autorisations spécifiques à accorder plutôt que d'accorder toutes les autorisations en une fois. Il est important de concevoir votre script pour gérer les autorisations OAuth précises.

Afficher les champs d'application

Pour afficher les champs d'application actuellement requis par votre projet de script, procédez comme suit:

  1. Ouvrez le projet de script.
  2. Sur la gauche, cliquez sur Vue d'ensemble .
  3. Consultez les habilitations sous Champs d'application OAuth du projet.

Définir des champs d'application explicites

Apps Script détermine automatiquement les portées dont un script a besoin en analysant son code à la recherche d'appels de fonction qui en ont besoin. Pour la plupart des scripts, cela suffit et vous fait gagner du temps. Toutefois, pour les modules complémentaires publiés, les applications Web, les applications Google Chat et les appels à l'API Google Chat, vous devez exercer un contrôle plus direct sur les étendues.

Apps Script attribue parfois automatiquement des champs d'application très permissifs aux projets. Cela peut signifier que votre script demande à l'utilisateur plus que ce dont il a besoin, ce qui est une mauvaise pratique. Pour les scripts publiés, vous devez remplacer les champs d'application larges par un ensemble plus limité qui couvre les besoins du script et pas plus.

Vous pouvez définir explicitement les portées utilisées par votre projet de script en modifiant son fichier manifeste. Le champ de fichier manifeste oauthScopes est un tableau de tous les champs d'application utilisés par le projet. Pour définir les champs d'application de votre projet, procédez comme suit:

  1. Ouvrez le projet de script.
  2. Sur la gauche, cliquez sur Paramètres du projet .
  3. Cochez la case Afficher le fichier manifeste "appsscript.json" dans l'éditeur.
  4. Sur la gauche, cliquez sur Montage .
  5. À gauche, cliquez sur le fichier appsscript.json.
  6. Recherchez le champ de niveau supérieur intitulé oauthScopes. Si ce n'est pas le cas, vous pouvez l'ajouter.
  7. Le champ oauthScopes spécifie un tableau de chaînes. Pour définir les champs d'application utilisés par votre projet, remplacez le contenu de ce tableau par les champs d'application que vous souhaitez utiliser. Exemple : 
          {
        ...
        "oauthScopes": [
          "https://www.googleapis.com/auth/spreadsheets.readonly",
          "https://www.googleapis.com/auth/userinfo.email"
        ],
       ...
      }
  8. En haut, cliquez sur (Enregistrer).

Gérer les autorisations OAuth précises

L'écran de consentement OAuth détaillé permet aux utilisateurs de spécifier les habilitations OAuth individuelles qu'ils souhaitent autoriser. Les autorisations OAuth précises permettent aux utilisateurs de contrôler plus précisément les données de compte qu'ils choisissent de partager avec chaque script. Par exemple, imaginez que vous développiez un script qui demande l'autorisation pour les champs d'application "e-mail" et "agenda". Vos utilisateurs peuvent souhaiter utiliser votre script uniquement pour ses fonctionnalités avec Google Agenda, mais pas avec Gmail. Avec les autorisations OAuth précises, les utilisateurs peuvent choisir de n'accorder que l'autorisation Agenda, mais pas Gmail.

Les sections suivantes décrivent les principales façons de gérer les autorisations OAuth précises.

Exiger automatiquement l'autorisation pour les champs d'application nécessaires

Si un flux d'exécution a besoin d'autorisations pour les champs d'application pour fonctionner, vous pouvez demander aux utilisateurs d'accorder ces autorisations avant de pouvoir l'utiliser. Votre script peut vérifier si l'utilisateur a déjà accordé l'autorisation et, si ce n'est pas le cas, lui demander automatiquement de le faire.

Les méthodes suivantes de la classe ScriptApp vous permettent de valider l'autorisation pour les champs d'application requis et d'afficher automatiquement l'invite d'autorisation pour demander les autorisations manquantes:

  • requireScopes(authMode, oAuthScopes) : utilisez cette méthode pour les flux d'exécution qui reposent sur un ou plusieurs champs d'application, mais pas sur tous ceux utilisés par votre script.
  • requireAllScopes(authMode) : utilisez cette méthode si un flux d'exécution repose sur tous les champs d'application utilisés par votre script.

Exemple

L'exemple suivant montre comment appeler les méthodes requireScopes(authMode, oAuthScopes) et requireAllScopes(authMode). Le script utilise des portées pour Gmail, Sheets et Agenda. La fonction sendEmail() ne nécessite que les portées pour Gmail et Sheets, tandis que la fonction createEventSendEmail() nécessite toutes les portées utilisées par le script.

// This function requires the Gmail and Sheets scopes.
function sendEmail() {
  // Validates that the user has granted permission for the Gmail and Sheets scopes.
  // If not, the execution ends and prompts the user for authorization.
  ScriptApp.requireScopes(ScriptApp.AuthMode.FULL, [
    'https://mail.google.com/',
    'https://www.googleapis.com/auth/spreadsheets'
  ]);

  // Sends an email.
  GmailApp.sendEmail("dana@example.com", "Subject", "Body");
  Logger.log("Email sent successfully!");

  // Opens a spreadsheet and sheet to track the sent email.
  const ss = SpreadsheetApp.openById("abc1234567");
  const sheet = ss.getSheetByName("Email Tracker")

  // Gets the last row of the sheet.
  const lastRow = sheet.getLastRow();

  // Adds "Sent" to column E of the last row of the spreadsheet.
  sheet.getRange(lastRow, 5).setValue("Sent");
  Logger.log("Sheet updated successfully!");
}

// This function requires all scopes used by the script (Gmail,
// Calendar, and Sheets).
function createEventSendEmail() {
  // Validates that the user has granted permission for all scopes used by the
  // script. If not, the execution ends and prompts the user for authorization.
  ScriptApp.requireAllScopes(ScriptApp.AuthMode.FULL);

  // Creates an event.
  CalendarApp.getDefaultCalendar().createEvent(
    "Meeting",
    new Date("November 28, 2024 10:00:00"),
    new Date("November 28, 2024 11:00:00")
  );
  Logger.log("Calendar event created successfully!");

  // Sends an email.
  GmailApp.sendEmail("dana@example.com", "Subject 2", "Body 2");
  Logger.log("Email sent successfully!");

  // Opens a spreadsheet and sheet to track the created meeting and sent email.
  const ss = SpreadsheetApp.openById("abc1234567");
  const sheet = ss.getSheetByName("Email and Meeting Tracker")
  // Gets the last row
  const lastRow = sheet.getLastRow();

  // Adds "Sent" to column E of the last row
  sheet.getRange(lastRow, 5).setValue("Sent");
  // Adds "Meeting created" to column F of the last row
  sheet.getRange(lastRow, 6).setValue("Meeting created");
  Logger.log("Sheet updated successfully!");
}

Créer une expérience personnalisée pour les champs d'application manquants

Vous pouvez obtenir les informations d'autorisation de l'utilisateur qui exécute votre script et concevoir une expérience personnalisée en fonction de son état d'autorisation. Par exemple, vous pouvez décider de désactiver des fonctionnalités spécifiques de votre script qui nécessitent des autorisations que l'utilisateur n'a pas accordées, ou d'afficher une boîte de dialogue personnalisée expliquant les autorisations manquantes. Les méthodes suivantes récupèrent un objet contenant les informations d'autorisation de l'utilisateur, y compris les portées que l'utilisateur a autorisées et une URL permettant de demander les portées manquantes:

Pour obtenir les détails de l'autorisation à partir de l'objet d'informations d'autorisation, comme une liste des champs d'application autorisés et une URL pour demander les autorisations manquantes, utilisez les méthodes de la classe AuthorizationInfo.

Exemple

L'exemple suivant montre comment appeler la méthode getAuthorizationInfo(authMode, oAuthScopes) pour ignorer des fonctionnalités spécifiques dans un flux d'exécution où les portées requises n'ont pas été accordées. Cela permet au reste du flux d'exécution de se poursuivre sans avoir à demander l'autorisation des champs d'application manquants.

// This function uses the Gmail scope and skips the email
// capabilities if the scope for Gmail hasn't been granted.
function myFunction() {
  const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, ['https://mail.google.com/']);
  if (authInfo.getAuthorizationStatus() === ScriptApp.AuthorizationStatus.NOT_REQUIRED) {
    GmailApp.sendEmail("dana@example.com", "Subject", "Body");
    Logger.log("Email sent successfully!");
  } else {
    const scopesGranted = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL).getAuthorizedScopes();
    console.warn(`Authorized scopes: ${scopesGranted} not enough to send mail, skipping.`);
  }
  // Continue the rest of the execution flow...
}

Vérifier que les exécutions de déclencheurs disposent d'autorisations

Les fonctions associées aux déclencheurs peuvent s'exécuter automatiquement lors de certains événements, et l'utilisateur peut ne pas être présent pour fournir d'autres autorisations. Nous vous recommandons d'utiliser requireScopes(authMode, oAuthScopes) avant d'installer un déclencheur. L'utilisateur est alors invité à fournir les autorisations manquantes et l'installation du déclencheur n'est pas autorisée sans elles.

Exemple

// This function requires scope Sheets.
function trackFormSubmissions(e){
  // Opens a spreadsheet to track the sent email.
  const ss = SpreadsheetApp.openById("abc1234567");
  const sheet = ss.getSheetByName("Submission Tracker")

  // Gets the last row of the sheet.
  const lastRow = sheet.getLastRow();

  // Adds email address of user that submitted the form
  // to column E of the last row of the spreadsheet.
  sheet.getRange(lastRow, 5).setValue(e.name);
  Logger.log("Sheet updated successfully!");
}


function installTrigger(){
  // Validates that the user has granted permissions for trigger
  // installation and execution. If not, trigger doesn't get
  // installed and prompts the user for authorization.
  ScriptApp.requireScopes(ScriptApp.AuthMode.FULL, [
    'https://www.googleapis.com/auth/script.scriptapp',
    'https://www.googleapis.com/auth/spreadsheets',
    'https://www.googleapis.com/auth/forms.currentonly'
  ]);
  ScriptApp.newTrigger('trackFormSubmission')
    .forForm(FormApp.getActiveForm())
    .onFormSubmit()
    .create();
}

Validation OAuth

Certains champs d'application OAuth sont sensibles, car ils permettent d'accéder aux données utilisateur Google. Si votre projet de script utilise des champs d'application qui permettent d'accéder aux données utilisateur, il doit passer par la validation du client OAuth avant que vous puissiez le publier publiquement en tant qu'application Web ou module complémentaire. Pour en savoir plus, consultez les guides suivants :

Champs d'application restreints

En plus des niveaux d'accès sensibles, certains sont classés comme restreints et soumis à des règles supplémentaires qui aident à protéger les données utilisateur. Si vous souhaitez publier une application Web ou un module complémentaire qui utilise un ou plusieurs champs d'application restreints, l'application doit respecter toutes les restrictions spécifiées avant de pouvoir être publiée.

Consultez la liste complète des champs d'application limités avant de tenter de publier. Si votre application en utilise une, vous devez respecter les exigences supplémentaires pour les champs d'application d'API spécifiques avant de la publier.