Promouvoir un module complémentaire auprès des utilisateurs via le partage d'écran

Promouvoir un module complémentaire via le partage d'écran.

Cette page explique comment promouvoir un module complémentaire auprès des utilisateurs lors du partage d'écran avec Google Meet en plaçant un petit extrait de code sur une autre page Web.

La méthode MeetAddonScreenshare.exposeToMeetWhenScreensharing permet au site d'envoyer des informations à Meet lorsque son onglet est partagé à l'écran. Ces informations sont utilisées dans le module complémentaire Meet lorsque l'utilisateur clique sur "Démarrer l'activité" dans la bannière de la 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 champs qui peuvent être ajoutés en fonction du cas d'utilisation:

  • AddonScreenshareInfo.additionalData : informations que le module complémentaire peut utiliser pour s'initialiser. Ne peut être défini que si AddonScreenshareInfo.startActivityOnOpen est défini sur "true" et est accessible à l'aide de CollaborationStartingState. Pour en savoir plus, consultez la section Utiliser l'état de début de la collaboration.

  • AddonScreenshareInfo.cloudProjectNumber : obligatoire. Numéro de projet Google Cloud du module complémentaire.

  • AddonScreenshareInfo.mainStageUrl : URL que l'étape principale 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.

  • AddonScreenshareInfo.sidePanelUrl : URL que le panneau latéral 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.

  • AddonScreenshareInfo.startActivityOnOpen : obligatoire. Indique si l'expérience du module complémentaire collaboratif doit être lancée immédiatement dans Meet lorsque l'utilisateur le lance à partir de la bannière de la présentation. Doit être défini sur "true" si AddonScreenshareInfo.mainStageUrl est utilisé.

Exemple: Charger dans l'étape 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 src="https://www.gstatic.com/meetjs/addons/0.1.0/meet.addons.screenshare.js"></script>
<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. Votre numéro de projet Cloud.
  • MAIN_STAGE_URL: chaîne. URL de l'étape principale.

Lorsque l'utilisateur partage la page sur l'écran d'appel Meet, une bannière de présentation s'affiche dans Meet. Cliquez sur le bouton de la bannière pour ouvrir le module complémentaire correspondant au numéro de projet Cloud donné dans l'étape principale. Le AddonScreenshareInfo.mainStageUrl est chargé, et AddonScreenshareInfo.additionalData permet de définir l'état de départ de la collaboration dans le module complémentaire. Les autres participants à 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, l'écran d'un utilisateur partage une page avec un module complémentaire qui souhaite commencer dans le panneau latéral plutôt que dans l'espace principal:

<script src="https://www.gstatic.com/meetjs/addons/0.1.0/meet.addons.screenshare.js"></script>
<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. Votre numéro de projet Cloud.
  • SIDE_PANEL_URL: chaîne. URL du panneau latéral.

Lorsque l'utilisateur partage la page sur l'écran d'appel Meet, une bannière de présentation s'affiche dans Meet. Cliquez sur le bouton de la bannière pour ouvrir le module complémentaire correspondant au numéro de projet Cloud donné dans le panneau latéral. Le AddonScreenshareInfo.sidePanelUrl est chargé, et AddonScreenshareInfo.additionalData permet de définir l'état de départ de la collaboration dans le module complémentaire. Les autres participants à l'appel sont immédiatement invités à installer ou à lancer le module complémentaire.

Exemple: Charger dans le panneau latéral sans démarrer de collaboration

Dans l'exemple de code suivant, un utilisateur partage une page avec un module complémentaire qui doit ajuster les autorisations d'accès aux ressources avant que l'activité de collaboration ne puisse être lancée. C'est pourquoi le module complémentaire doit être lancé dans le panneau latéral, sans que la collaboration ne soit lancée pour tout le monde.

<script src="https://www.gstatic.com/meetjs/addons/0.1.0/meet.addons.screenshare.js"></script>
<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. Votre numéro de projet Cloud.
  • SIDE_PANEL_URL: chaîne. URL du panneau latéral.

Lorsque l'utilisateur partage la page sur l'écran d'appel Meet, une bannière de présentation s'affiche dans Meet. Cliquez sur le bouton de la bannière pour ouvrir le module complémentaire correspondant au numéro de projet Cloud donné dans le panneau latéral. Comme AddonScreenshareInfo.startActivityOnOpen a été défini sur "false", le bouton de démarrage de l'activité est désactivé jusqu'à ce que CollaborationStartingState soit défini. Pour en savoir plus, consultez Utiliser l'état de départ de la collaboration.

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

Correspondance de l'origine

Les origines fournies dans AddonScreenshareInfo.mainStageUrl et AddonScreenshareInfo.sidePanelUrl sont comparées aux origines dans le 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.

En outre, l'origine du site à l'origine du partage d'écran doit être indiqué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.