Class AuthorizationInfo

AuthorizationInfo

Objet qui vérifie si l'utilisateur a accordé l'autorisation pour les champs d'application requis du script. L'objet fournit également une URL d'autorisation permettant aux utilisateurs d'accorder ces autorisations.

Certaines exécutions de script peuvent commencer sans que l'utilisateur n'ait donné son consentement pour tous les champs d'application requis utilisés par le script. Les informations de cet objet vous permettent de contrôler l'accès aux sections de code qui nécessitent certains champs d'application et de demander l'autorisation de ces champs d'application pour les exécutions ultérieures.

Cet objet est renvoyé par ScriptApp.getAuthorizationInfo(authMode). Dans la quasi-totalité des cas, les scripts doivent appeler ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), car aucun autre mode d'autorisation n'exige que les utilisateurs accordent une autorisation.

Méthodes

MéthodeType renvoyéBrève description
getAuthorizationStatus()AuthorizationStatusRécupère une valeur qui indique si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services (par exemple, ScriptApp.AuthorizationStatus.REQUIRED).
getAuthorizationUrl()StringRécupère l'URL d'autorisation permettant d'accorder l'accès au script.
getAuthorizedScopes()String[]Récupère la liste des champs d'application autorisés pour le script.

Documentation détaillée

getAuthorizationStatus()

Récupère une valeur indiquant si l'utilisateur doit autoriser ce script à utiliser un ou plusieurs services (par exemple, ScriptApp.AuthorizationStatus.REQUIRED). 

// Log the authorization status (REQUIRED or NOT_REQUIRED).
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationStatus());

Renvois

AuthorizationStatus : état de l'autorisation

getAuthorizationUrl()

Récupère l'URL d'autorisation permettant d'accorder l'accès au script. Cette méthode renvoie null si aucune autorisation n'est requise. La page associée à l'URL se ferme automatiquement si elle est consultée et que le script ne nécessite aucune autorisation. 

// Log the URL used to grant access to the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL);
Logger.log(authInfo.getAuthorizationUrl());

Renvois

String : URL pouvant être utilisée pour autoriser le script

getAuthorizedScopes()

Récupère la liste des champs d'application autorisés pour le script. Si des informations d'autorisation sont demandées pour une liste de champs d'application spécifiée, renvoie les champs d'application autorisés à partir de la liste spécifiée. 

// Logs which scopes in the specified list have been authorized for the script.
const authInfo = ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL, [
  'https: //www.googleapis.com/auth/documents',
  'https: //www.googleapis.com/auth/spreadsheets',
]);
Logger.log(authInfo.getAuthorizedScopes());

Renvois

String[] : liste des champs d'application autorisés.