Add-ons über die Bildschirmfreigabe bewerben

Werbung für ein Add-on über die Bildschirmfreigabe

Auf dieser Seite wird beschrieben, wie Sie Nutzern ein Add-on präsentieren, während Sie einen Tab mit Google Meet teilen. Dazu fügen Sie einen kleinen Code-Snippet auf einer anderen Webseite ein.

Mit der Methode exposeToMeetWhenScreensharing() kann die Website Informationen an Meet senden, wenn der Tab freigegeben wird. Diese Informationen werden im Add-on für Meet verwendet, wenn der Nutzer auf dem Präsentationsbanner auf „Aktivität starten“ klickt, sofern das Add-on installiert ist. Wenn der Nutzer das Add-on nicht installiert hat, wird er beim Teilen des Bildschirms aufgefordert, es zu installieren.

Das AddonScreenshareInfo-Objekt enthält fünf Properties, die je nach Anwendungsfall hinzugefügt werden können:

  • additionalData: Informationen, mit denen sich das Add-on initialisieren kann. Kann nur festgelegt werden, wenn die Property startActivityOnOpen auf „wahr“ gesetzt ist und über ActivityStartingState darauf zugegriffen werden kann. Weitere Informationen finden Sie unter Startstatus der Aktivität abrufen.

  • cloudProjectNumber: Erforderlich. Die Projektnummer Ihres Google Cloud-Projekts.

  • mainStageUrl: Die URL, die die Hauptbühne öffnet, sobald das Add-on gestartet wird, z. B. https://www.example.com. Die URL muss derselben Quelle wie die im Add-on-Manifest angegebenen URLs zugewiesen sein.

  • sidePanelUrl: Die URL, über die der Seitenbereich geöffnet wird, sobald das Add-on gestartet wird, z. B. https://www.example.com. Die URL muss derselben Quelle wie die im Add-on-Manifest angegebenen URLs zugewiesen sein.

  • startActivityOnOpen: Erforderlich. Ob das Aktivitäts-Add-on in Meet sofort gestartet werden soll, wenn der Nutzer das Add-on über das Präsentationsbanner startet. Muss „wahr“ sein, wenn die Property mainStageUrl verwendet wird.

SDK installieren und importieren

Sie können über npm oder gstatic auf das SDK zugreifen.

Wenn in Ihrem Projekt npm verwendet wird, folgen Sie der Anleitung für das npm-Paket des Meet Add-ons SDK.

Installieren Sie zuerst das npm-Paket:

npm install @googleworkspace/meet-addons

Anschließend können Sie das Meet Add-ons SDK verwenden, indem Sie die MeetAddonScreenshareExport-Benutzeroberfläche importieren:

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

Für TypeScript-Nutzer werden TypeScript-Definitionen mit dem Modul verpackt.

gstatic

Das Google Meet Add-ons SDK ist als JavaScript-Bundle von gstatic verfügbar, einer Domain, die statische Inhalte bereitstellt.

Wenn Sie das Meet Add-ons SDK verwenden möchten, fügen Sie Ihrer App das folgende Script-Tag hinzu:

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

Das SDK für Meet-Add-ons ist über die MeetAddon-Benutzeroberfläche unter window.meet.addon verfügbar.

Beispiel: Im Seitenbereich laden, ohne eine Aktivität zu starten

Im folgenden Codebeispiel wird auf einem Nutzerbildschirm eine Seite mit einem Add-on geteilt, für das die Ressourcenberechtigungen angepasst werden müssen, bevor die Aktivität gestartet werden kann. Aus diesem Grund sollte das Add-on im Seitenpanel gestartet werden, ohne dass die Aktivität für alle Nutzer gestartet wird.

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

Ersetzen Sie Folgendes:

  • CLOUD_PROJECT_NUMBER: String. Die Projektnummer Ihres Cloud-Projekts.
  • SIDE_PANEL_URL: String. Die URL für die Seitenleiste.

Wenn der Nutzer die Seite auf dem Meet-Anrufbildschirm freigibt, wird in Meet ein Präsentationsbanner angezeigt. Wenn Sie auf die Schaltfläche im Banner klicken, wird das Add-on für die angegebene Cloud-Projektnummer in der Seitenleiste geöffnet. Da die Property startActivityOnOpen auf „falsch“ gesetzt wurde, ist die Schaltfläche zum Starten der Aktivität deaktiviert, bis ActivityStartingState festgelegt wurde. Weitere Informationen finden Sie unter Startstatus der Aktivität verwenden.

Sobald die Aktivität gestartet wurde, werden andere Nutzer im Anruf aufgefordert, das Add-on entweder zu starten oder zu installieren.

Das Beispiel-Add-on „Animation“ auf GitHub enthält dieses Beispiel als Teil eines vollständigen Add-ons. Wenn die Indexseite der mit dem Add-on verknüpften Web-App angezeigt wird, wird der Nutzer aufgefordert, das Add-on entweder zu installieren oder einzurichten.

Beispiel: In der Hauptbühne laden

Im folgenden Codebeispiel wird ein Nutzer, der in Meet eine Webansicht mit dem folgenden Code teilt, aufgefordert, das Add-on zu starten:

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

Ersetzen Sie Folgendes:

  • CLOUD_PROJECT_NUMBER: String. Die Projektnummer Ihres Google Cloud-Projekts.
  • MAIN_STAGE_URL: String. Die URL für den Hauptbildschirm.

Wenn der Nutzer die Seite auf dem Meet-Anrufbildschirm freigibt, wird in Meet ein Präsentationsbanner angezeigt. Wenn Sie auf die Schaltfläche im Banner klicken, wird das Add-on für die angegebene Cloud-Projektnummer auf der Hauptbühne geöffnet. Die Property mainStageUrl wird geladen und die Property additionalData wird verwendet, um den Startstatus der Aktivität des Add-ons festzulegen. Andere Nutzer im Anruf werden sofort aufgefordert, das Add-on zu installieren oder zu starten.

Beispiel: In der Seitenleiste laden

Im folgenden Codebeispiel wird auf einem Nutzerbildschirm eine Seite mit einem Add-on geteilt, das nicht im Hauptbereich, sondern im Seitenbereich gestartet werden soll:

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

Ersetzen Sie Folgendes:

  • CLOUD_PROJECT_NUMBER: String. Die Projektnummer Ihres Cloud-Projekts.
  • SIDE_PANEL_URL: String. Die URL für die Seitenleiste.

Wenn der Nutzer die Seite auf dem Meet-Anrufbildschirm freigibt, wird in Meet ein Präsentationsbanner angezeigt. Wenn Sie auf die Schaltfläche im Banner klicken, wird das Add-on für die angegebene Cloud-Projektnummer in der Seitenleiste geöffnet. Die Property sidePanelUrl wird geladen und die Property additionalData wird verwendet, um den Startstatus der Aktivität des Add-ons festzulegen. Andere Nutzer im Anruf werden sofort aufgefordert, das Add-on zu installieren oder zu starten.

Ursprungsabgleich

Die Ursprünge, die in der Property mainStageUrl und der Property sidePanelUrl angegeben sind, werden mit den Ursprüngen im Add-on-Manifest der angegebenen Cloud-Projektnummer verglichen. Wenn alles übereinstimmt, darf der Nutzer das Add-on starten.

Außerdem muss die Quelle der Website, auf der die Bildschirmfreigabe gestartet wird, im Feld addOnOrigins im Add-on-Manifest aufgeführt sein.

Weitere Informationen finden Sie unter Add-on-Sicherheit.