Bonnes pratiques

Améliorez les performances expérience globale en suivant ces guides pour Conception du module complémentaire Google Meet

Bonnes pratiques concernant les autorisations

Nous vous encourageons à appliquer les bonnes pratiques suivantes Modules complémentaires Google Meet nécessitant une authentification ou une autorisation

Utiliser Google Sign-In

De nombreux utilisateurs des modules complémentaires Google Workspace se sont déjà déjà connectés à Google à la réunion. Par conséquent, Google Sign-In vous permet de faire gagner plusieurs clics à vos utilisateurs lorsqu'ils passent par procédure de connexion.

Ouvrir la page de connexion tierce dans une nouvelle fenêtre

Outre Google Sign-In, votre application peut proposer des identifiants de connexion supplémentaires ces mécanismes. Si c'est le cas, utilisez une boîte de dialogue plutôt que d'ouvrir une page de connexion dans une nouvel onglet. De cette façon, l'utilisateur peut toujours consulter et revenir Meet, et enregistrera un nombre de clics global moins élevé.

Champs d'application des requêtes appropriés pour les API Google

Si votre module complémentaire Meet appelle des API Google : vous devez fournir la liste complète des champs d'application requise par votre module complémentaire. Cette opération s'effectue Page de configuration de l'application Google Workspace Marketplace. Après avoir ajouté ces des champs d'application, une invite s'affiche pour les utilisateurs lorsqu'ils installent votre qui indique aux utilisateurs le type de données permettant à votre application d'y accéder.

Avant de publier votre module complémentaire, vous devez également configurer l'authentification OAuth écran. Pour cela, vous devez ajouter exactement les mêmes niveaux d'autorisation que ceux de votre Configuration de l'application Google Workspace Marketplace. Configurer OAuth l’écran de consentement nécessite également de définir les informations de branding, les règles de confidentialité, et les conditions d'utilisation qui s'affichent lorsque des champs d'application sont demandés. Pour publier toutes ces informations doivent être renvoyées pour validation.

Lorsque vous écrivez du code pour appeler les API Google Workspace, suivez les consignes JavaScript Guide de démarrage rapide est le moyen le plus simple de commencer. Cette approche respecte les bonnes pratiques à l'aide de Google Sign-In et de fenêtres de dialogue. Notez que l'initialisation du jeton client en JavaScript exige de demander séparément les champs d'application utilise réellement lors de l'exécution. Pour une expérience utilisateur optimale, les niveaux d'accès requis doivent correspondre à ceux de la section "Configuration de l'application Google Workspace Marketplace" . Cette redondance constitue une solution de secours pour les cas dans lesquels un utilisateur a révoqué champs d'application.

Bonnes pratiques de maintenance

Les bonnes pratiques suivantes concernent l'écriture applications Web, mais elles sont particulièrement importantes lors de l'écriture Découvrez les modules complémentaires.

Utiliser la dernière version du SDK des modules complémentaires Google Meet

Le SDK des modules complémentaires Meet est régulièrement mis à jour. Le SDK respecte gestion sémantique des versions. Pour obtenir la dernière version:

  • En cas d'utilisation de gstatic: la dernière version du SDK est contenue dans le fichier gstatic. URL figurant dans les instructions d'utilisation du SDK.
  • Lorsque vous utilisez npm: exécutez npm update @googleworkspace/meet-add-ons depuis Répertoire contenant la classe package.json pour le site Web qui héberge votre module complémentaire Meet.

Créer un projet Google Cloud de préproduction

Une fois votre module complémentaire Google Meet publié sur le Google Workspace Marketplace, tout nouveau déploiement de votre module complémentaire Google Meet pour les utilisateurs de Meet. Les utilisateurs verront ces modifications ils vident leur cache ou celui-ci expire. Par conséquent, nous vous recommandons transmettre les modifications à votre site de production jusqu'à ce qu'elles soient testées de manière approfondie.

Pour éviter un déploiement directement en production, nous vous recommandons de créer un pipeline distinct un projet Google Cloud publié de manière privée à votre organisation. Ce projet Cloud hébergera à la fois de développement pour votre module complémentaire Meet. Accès pour ce projet Cloud doit être limitée à une petite équipe vous travaillez directement sur le développement de votre module complémentaire.

Pour créer ces environnements alternatifs pour votre module complémentaire, vous devez d'abord héberger d'autres environnements de l'application Web contenant votre module complémentaire, sur un domaine qui vous appartient. Ensuite, vous pouvez créer d'autres environnements en ajoutant des déploiements à votre projet Google Cloud de préproduction. Pour ces nouveaux déploiements, qui pointent vers les autres environnements de votre application Web. Nous vous recommandons ensuite d'installer comme suit:

  • Préproduction: publiez la version de préproduction en mode privé. afin que tous les membres de votre organisation puissent participer aux tests.
  • Développement: cliquez sur Installer dans la colonne Actions pour installer la Version de développement du module complémentaire Meet disponible uniquement sur votre compte.

Écrire des tests

Avant de déployer votre module complémentaire Meet sur un environnement de développement nous vous recommandons d'écrire des tests unitaires. Vos tests unitaires doivent inclure les éléments suivants:

  • Effectuer une simulation du SDK des modules complémentaires Meet, puis vérifier que Le module complémentaire Meet appelle les fonctions du SDK comme prévu.
  • Les tests unitaires de toutes les fonctionnalités non liées au SDK de votre avec le framework de test Web de votre choix.

Bonnes pratiques concernant l'expérience utilisateur

Les bonnes pratiques suivantes vous aident à créer un module complémentaire Meet plus intuitive et plus affinée.

Gérer tous les états de départ dans le panneau latéral

Nous vous encourageons vivement à configurer votre module complémentaire en vous basant sur les actions effectuées par l'utilisateur dans le panneau latéral. Pour ce faire, définissez la collaboration l'état dans JavaScript. Toutes les données incluses dans CollaborationStartingState doit être défini par l'initiateur du module complémentaire (généralement l'organisateur de la réunion) dans le panneau latéral. Vous pouvez penser à la première vue panneau latéral afin de contrôler la configuration un module complémentaire.

Fermer le panneau latéral lorsque vous ne l'utilisez pas

Après avoir démarré l'activité en appelant startCollaboration, ne conservez que le panneau latéral s'il fait partie intégrante de l'expérience utilisateur Module complémentaire Google Meet. Vous pouvez fermer le panneau latéral une fois que le bouton l'étape est ouverte en appelant unloadSidePanel

Promouvoir votre module complémentaire Meet via le partage d'écran

Les modules complémentaires Meet offrent une expérience plus riche que le partage d'écran. Cependant, de nombreux utilisateurs ont l'habitude d'utiliser le partage d'écran de Meet. . Si un utilisateur partage un onglet affichant le site Web qui héberge votre Meet peut être configuré pour afficher une bannière invitant tous les participants à l'appel à installer ou à utiliser le module complémentaire Meet correspondant. Pour en savoir plus, consultez faire la promotion de votre module complémentaire via l'écran partage.