Installer et autoriser des modules complémentaires

Les utilisateurs doivent installer et autoriser un module complémentaire avant de pouvoir l'ouvrir et l'utiliser. Ces étapes constituent la première partie de l'expérience utilisateur du module complémentaire. Vous devez donc les comprendre avant de commencer à créer vos propres modules complémentaires.

Cette section de documentation explique comment les utilisateurs peuvent installer, autoriser et commencer à utiliser des modules complémentaires.

Installer des modules complémentaires

Pour pouvoir utiliser un module complémentaire, vous devez l'installer. Une fois installé, le module complémentaire devient disponible dans l'application hôte Google Workspace qu'il étend.

Vous pouvez installer des modules complémentaires publiés à partir de l'application hôte Google Workspace ou de Google Workspace Marketplace. Les administrateurs de domaine peuvent également installer des modules complémentaires pour le compte de leurs utilisateurs à partir de Google Workspace Marketplace. Vous pouvez également installer des modules complémentaires non publiés que vous développez afin de les tester. Pour pouvoir utiliser un module complémentaire installé pour la première fois, vous devez l'autoriser.

Pour en savoir plus, consultez Publier des modules complémentaires.

Autoriser les modules complémentaires

Une fois le module complémentaire installé, il devient disponible dans l'application hôte Google Workspace qu'il étend. La première fois qu'un utilisateur tente d'utiliser le module complémentaire, l'application hôte affiche une carte ou une boîte de dialogue d'autorisation. Cette fiche explique ce que le module complémentaire a besoin d'une autorisation pour permettre à l'utilisateur, par exemple d'accéder au contenu de la feuille de calcul Google Sheets actuelle. L'utilisateur peut ensuite accorder ces autorisations et autoriser le module complémentaire à continuer. Si l'utilisateur refuse l'autorisation du module complémentaire, il ne peut pas l'utiliser.

Les modules complémentaires des éditeurs utilisent un modèle d'autorisation différent de celui des modules complémentaires Google Workspace. Étant donné que les modules complémentaires de l'éditeur opèrent sur les fichiers Google Drive, le modèle d'autorisation de l'éditeur définit divers modes d'autorisation qui apparaissent lorsque des modules complémentaires sont utilisés avec des fichiers individuels. Lorsque vous développez des modules complémentaires de l'éditeur, il est important de comprendre les différents modes et la façon dont ils passent de l'un à l'autre.

Autoriser la publication de modules complémentaires

Une fois que vous avez installé un module complémentaire publié, le flux d'autorisation commence immédiatement:

  1. Vous êtes invité à Sélectionner un compte pour installer le module complémentaire.
  2. La liste des autorisations dont le module complémentaire a besoin pour s'exécuter s'affiche afin que vous sachiez ce qu'il tente de faire. Examinez attentivement cette liste et, si vous souhaitez tout de même accorder une autorisation, cliquez sur Allow (Autoriser). Cette opération permet d'activer le module complémentaire.
  3. Vous pouvez maintenant l'exécuter à partir de l'application hôte qu'il étend. Si l'application était déjà ouverte dans un onglet de navigateur, vous devrez peut-être actualiser l'onglet avant que le module complémentaire ne soit disponible.

Si le module complémentaire que vous avez installé est mis à jour ultérieurement et nécessite des autorisations supplémentaires que vous n'avez pas encore accordées, vous serez invité à les fournir la prochaine fois que vous utiliserez le module complémentaire.

Autoriser les modules complémentaires Google Workspace non publiés

Carte d'autorisation pour les modules complémentaires

Les modules complémentaires non publiés ne suivent pas le même flux d'autorisation que les modules complémentaires publiés, car ils ne sont pas encore listés sur Google Workspace Marketplace. Après avoir installé un module complémentaire non publié, vous n'êtes pas immédiatement invité à donner son autorisation. Au lieu de cela, le flux d'autorisation démarre lorsque vous essayez d'utiliser le module complémentaire pour la première fois.

Lorsqu'un module complémentaire est exécuté, il détermine si une autorisation utilisateur est nécessaire. Si une autorisation est nécessaire, le module complémentaire présente une carte d'autorisation. L'autorisation est toujours requise lors de la première exécution d'un module complémentaire, et peut également être requise si une nouvelle version du module complémentaire utilise un service qui n'a pas été autorisé précédemment. Le bouton Authorize Access (Autoriser l'accès) fournit une boîte de dialogue permettant à l'utilisateur d'autoriser ou de refuser l'autorisation pour le module complémentaire.

Autoriser des services autres que Google pour un module complémentaire Google Workspace

Un module complémentaire Google Workspace peut se connecter à un service tiers qui nécessite lui-même une autorisation. Les modules complémentaires Google Workspace qui se connectent à ces services nécessitent deux actions distinctes de la part de l'utilisateur:

  • Autorisation du module complémentaire lui-même lors de son installation ou de son premier démarrage
  • Autorisation du service autre que Google lors du premier accès.

Si un module complémentaire Google Workspace que vous développez a besoin d'accéder à un service autre que Google à l'aide d'OAuth, vous devez configurer la connexion pour ce service lors de la création du module complémentaire.

Pour en savoir plus, consultez Connecter votre module complémentaire Google Workspace à un service tiers.

Systèmes de conférence tiers

Les modules complémentaires Google Workspace qui étendent Google Agenda peuvent également ajouter d'autres solutions de conférence, qui permettent aux utilisateurs de sélectionner un système de conférence tiers lorsqu'ils modifient des événements Google Agenda. Si votre module complémentaire propose des options de conférence nécessitant que l'utilisateur se connecte, votre module complémentaire doit permettre à l'utilisateur de le faire.

Si un utilisateur tente de créer une conférence avec votre module complémentaire sans qu'il soit nécessaire de se connecter, la méthode onCreateFunction des solutions de conférence doit renvoyer un objet ConferenceData contenant un ConferenceError avec une URL d'authentification.

À la réception de cet objet, Google Agenda crée un bouton LOG IN (Se connecter) dans l'interface utilisateur de modification des événements. Ce bouton est associé à l'URL d'authentification fournie par le module complémentaire. Les utilisateurs peuvent ensuite utiliser ce bouton pour se connecter au système tiers avant d'utiliser le module complémentaire.

Consultez la section Créer des conférences tierces pour en savoir plus sur la gestion des autorisations à l'aide de ConferenceError.

Autoriser les modules complémentaires de l'éditeur dont la publication a été annulée

Il est recommandé de tester les modules complémentaires de l'éditeur à mesure que vous les développez. Le flux d'autorisation est identique à celui des modules complémentaires de l'éditeur publiés, sauf qu'il démarre lorsque vous tentez de tester le module complémentaire pour la première fois. Si vous testez à nouveau le même module complémentaire par la suite, vous n'êtes plus invité à confirmer l'autorisation.

Annuler l'autorisation des modules complémentaires

Lorsque vous développez des modules complémentaires, il peut être utile de les annuler afin de pouvoir tester à nouveau le flux d'autorisation.

Pour annuler l'autorisation d'un module complémentaire, procédez comme suit:

  1. Ouvrez la console de sécurité de votre compte.
  2. Recherchez le module complémentaire que vous souhaitez annuler et cliquez dessus.
  3. Cliquez sur Supprimer l'accès.

Lorsque vous exécutez à nouveau le module complémentaire après l'avoir annulé, le flux d'autorisation s'affiche à nouveau.