Promouvoir un module complémentaire auprès des utilisateurs

Les développeurs peuvent améliorer la visibilité de leurs modules complémentaires en les promouvant dans le chat en cours d'appel de Meet et grâce à la fonctionnalité de partage d'écran de Meet.

Chat en cours d'appel

Les modules complémentaires Google Meet sont proposés aux utilisateurs dans le chat en cours d'appel de Meet automatiquement lorsqu'un message contient un ou plusieurs liens associés à un module complémentaire. Aucune action n'est requise de la part du développeur pour promouvoir les modules complémentaires dans le chat. L'équipe d'examen détermine le ou les liens à associer à un module complémentaire, en fonction de l'URI du panneau latéral et des origines du module complémentaire définies dans le manifeste de déploiement.

Lorsqu'un utilisateur envoie un message via un chat en cours d'appel associé à un module complémentaire, deux scénarios sont possibles :

1. Si le module complémentaire n'est pas installé, une fiche invite l'utilisateur à l'installer.
2. Si le module complémentaire est déjà installé, un bouton rappelle à l'utilisateur de l'ouvrir.

Partage d'écran

Cette page explique comment promouvoir un module complémentaire auprès des utilisateurs tout en partageant l'écran d'un onglet avec Google Meet en plaçant une petite quantité de code sur une autre page Web.

La méthode exposeToMeetWhenScreensharing() permet au site d'envoyer des informations à Meet lorsque son onglet est partagé à l'écran. Ces informations sont utilisées dans l'expérience du module complémentaire avec Meet lorsque l'utilisateur clique sur "Démarrer l'activité" sur la bannière de présentation s'il a installé le module complémentaire. Si l'utilisateur n'a pas installé le module complémentaire lorsqu'il partage l'écran d'un onglet, il est invité à l'installer.

L'objet AddonScreenshareInfo contient cinq propriétés qui peuvent être ajoutées en fonction du cas d'utilisation :

• additionalData : informations que le module complémentaire peut utiliser pour s'initialiser. Ne peut être défini que si la propriété startActivityOnOpen est définie sur "true" et est accessible à l'aide de ActivityStartingState. Pour en savoir plus, consultez Obtenir l'état de démarrage de l'activité.

• cloudProjectNumber : obligatoire. Numéro de votre projet Google Cloud.

• mainStageUrl : URL de la zone principale qui s'ouvre au démarrage du module complémentaire, par exemple https://www.example.com. L'URL doit appartenir à la même origine que les URL spécifiées dans le fichier manifeste du module complémentaire.

• sidePanelUrl : URL que le panneau latéral ouvre une fois le module complémentaire démarré, par exemple https://www.example.com. L'URL doit appartenir à la même origine que les URL spécifiées dans le fichier manifeste du module complémentaire.

• startActivityOnOpen : obligatoire. Indique s'il faut démarrer immédiatement l'expérience du module complémentaire d'activité dans Meet lorsque l'utilisateur démarre le module complémentaire à partir de la bannière de présentation. Doit être défini sur "true" si la propriété mainStageUrl est utilisée.

Installer et importer le SDK

Vous pouvez accéder au SDK à l'aide de npm ou de gstatic.

npm install @googleworkspace/meet-addons

import {meet} from '@googleworkspace/meet-addons/meet.addons.screenshare';

<script src="https://www.gstatic.com/meetjs/addons/1.1.0/meet.addons.screenshare.js"></script>

Exemple : Charger dans le panneau latéral sans démarrer d'activité

Dans l'exemple de code suivant, un utilisateur partage son écran avec un module complémentaire qui doit ajuster les autorisations d'accès aux ressources avant de pouvoir démarrer l'activité. En raison de cette exigence, le module complémentaire doit être démarré dans le panneau latéral, sans que l'activité ne soit démarrée pour tout le monde.

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: false,
    sidePanelUrl: SIDE_PANEL_URL,
  }
);
</script>

Remplacez les éléments suivants :

• CLOUD_PROJECT_NUMBER : chaîne. Numéro de projet de votre projet Cloud.
• SIDE_PANEL_URL : chaîne. URL du panneau latéral.

Lorsque l'utilisateur partage l'écran de la page lors de l'appel Meet, une bannière de présentation s'affiche dans Meet. Si vous cliquez sur le bouton de la bannière, le module complémentaire s'ouvre dans le panneau latéral pour le numéro de projet Cloud concerné. Étant donné que la propriété startActivityOnOpen a été définie sur "false", le bouton de démarrage de l'activité est désactivé jusqu'à ce que ActivityStartingState soit défini. Pour en savoir plus, consultez Utiliser l'état de démarrage de l'activité.

Une fois l'activité lancée, les autres utilisateurs de l'appel sont invités à lancer ou à installer le module complémentaire.

L'exemple de module complémentaire "Animation" sur GitHub inclut cet exemple dans un module complémentaire complet. Lorsque la page d'index de l'application Web associée au module complémentaire est présentée, l'utilisateur est invité à installer ou à configurer le module complémentaire.

Exemple : Chargement sur la scène principale

Dans l'exemple de code suivant, un utilisateur qui partage l'écran d'une page Web dans Meet contenant le code suivant est invité à lancer le module complémentaire :

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    mainStageUrl: MAIN_STAGE_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

Remplacez les éléments suivants :

• CLOUD_PROJECT_NUMBER : chaîne. Numéro de votre projet Google Cloud.
• MAIN_STAGE_URL : chaîne. URL de la scène principale.

Lorsque l'utilisateur partage l'écran de la page lors de l'appel Meet, une bannière de présentation s'affiche dans Meet. Si vous cliquez sur le bouton de la bannière, le module complémentaire s'ouvre pour le numéro de projet Cloud indiqué dans la zone principale. La propriété mainStageUrl est chargée et la propriété additionalData est utilisée pour définir l'état de démarrage de l'activité du module complémentaire. Les autres utilisateurs de l'appel sont immédiatement invités à installer ou à lancer le module complémentaire.

Exemple : Charger dans le panneau latéral

Dans l'exemple de code suivant, un utilisateur partage son écran avec un module complémentaire qui souhaite démarrer dans le panneau latéral plutôt que sur la scène principale :

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    sidePanelUrl: SIDE_PANEL_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

Remplacez les éléments suivants :

• CLOUD_PROJECT_NUMBER : chaîne. Numéro de projet de votre projet Cloud.
• SIDE_PANEL_URL : chaîne. URL du panneau latéral.

Lorsque l'utilisateur partage l'écran de la page lors de l'appel Meet, une bannière de présentation s'affiche dans Meet. Si vous cliquez sur le bouton de la bannière, le module complémentaire s'ouvre dans le panneau latéral pour le numéro de projet Cloud concerné. La propriété sidePanelUrl est chargée et la propriété additionalData est utilisée pour définir l'état de démarrage de l'activité du module complémentaire. Les autres utilisateurs de l'appel sont immédiatement invités à installer ou à lancer le module complémentaire.

Correspondance d'origine

Les origines fournies dans les propriétés mainStageUrl et sidePanelUrl sont comparées aux origines du fichier manifeste du module complémentaire du numéro de projet Cloud fourni. Si tout correspond, l'utilisateur est autorisé à lancer le module complémentaire.

De plus, l'origine du site qui lance le partage d'écran doit être listée dans le champ addOnOrigins du fichier manifeste du module complémentaire.

Pour en savoir plus, consultez la section Sécurité des modules complémentaires.

Articles associés

• Collaborer à l'aide d'un module complémentaire Meet
• Sécurité des modules complémentaires