Compartir pantalla para promocionar un complemento entre los usuarios

Promoción de un complemento a través de la pantalla para compartir.

En esta página, se describe cómo promocionar un complemento entre los usuarios mientras compartes la pantalla de una pestaña con Google Meet colocando una pequeña cantidad de código en otra página web.

El exposeToMeetWhenScreensharing() permite que el sitio envíe información a Meet cuando la pestaña se comparte en pantalla. Esta información se usa en el de complementos de Meet cuando el usuario hace clic en “Iniciar actividad” en el banner de la presentación el complemento instalado. Si el usuario no tiene el complemento instalado cuando comparten la pantalla de una pestaña, están que se te solicite instalar el complemento.

El AddonScreenshareInfo contiene cinco propiedades que se pueden agregar según el caso de uso:

  • additionalData: Información que el complemento puede usar para inicializarse. Lata solo se puede establecer si la propiedad startActivityOnOpen es verdadera y se puede a los que se accede mediante ActivityStartingState Para obtener más información, consulta Cómo usar la actividad inicial estado.

  • cloudProjectNumber: Obligatorio. El número de tu proyecto de Google Cloud.

  • mainStageUrl: La URL que abre la etapa principal una vez que se agrega el complemento de inicio de sesión, como https://www.example.com. La URL debe pertenecer a la misma origin como las URLs especificadas en el del complemento.

  • sidePanelUrl: La URL que se abre en el panel lateral una vez que se agrega el complemento de inicio de sesión, como https://www.example.com. La URL debe pertenecer a la misma origin como las URLs especificadas en el del complemento.

  • startActivityOnOpen: Obligatorio. Si se desea iniciar el complemento de actividad en Meet inmediatamente cuando el usuario inicia el desde el banner de la presentación. Debe ser verdadero si se usa la propiedad mainStageUrl.

Instalar e importar el SDK

Puedes acceder al SDK mediante npm o gstatic.

Si tu proyecto utiliza npm, puedes seguir las instrucciones para la Paquete de Administración de socios de red del SDK de complementos de Meet.

Primero, instala el paquete npm:

npm install @googleworkspace/meet-addons

Luego, podrás acceder al SDK de complementos de Meet importando MeetAddonScreenshareExport :

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

Para los usuarios de TypeScript, sus definiciones se empaquetan con el módulo.

gstatic

El SDK de complementos de Google Meet está disponible como Paquete de JavaScript de gstatic, un dominio que entrega contenido estático.

Para usar el SDK de complementos de Meet, agrega la siguiente etiqueta de secuencia de comandos a tu app:

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

El SDK de complementos de Meet está disponible a través de la interfaz de MeetAddon en window.meet.addon.

Ejemplo: Carga en la etapa principal

En la siguiente muestra de código, un usuario que comparte una página web en Meet que contenga el siguiente código, se le solicitará que inicie el complemento:

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

Reemplaza lo siguiente:

  • CLOUD_PROJECT_NUMBER: Cadena. El número de proyecto de tu proyecto de Google Cloud.
  • MAIN_STAGE_URL: Cadena. La URL de la escena principal.

Cuando el usuario en la pantalla de la llamada de Meet comparte la página, ve un mensaje de de la presentación en Meet. Hacer clic en el botón del banner abre el complemento para el número de proyecto de la nube determinado en a la escena principal. Se carga la propiedad mainStageUrl, y la Se usa la propiedad additionalData para establecer la actividad que se iniciará estado del complemento. Los demás usuarios de la llamada le solicitará de inmediato que instale o inicie el complemento.

Ejemplo: Carga en el panel lateral

En la siguiente muestra de código, la pantalla de un usuario comparte una página con un un complemento que quiere comenzar en el panel lateral en lugar de que en la etapa principal:

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

Reemplaza lo siguiente:

  • CLOUD_PROJECT_NUMBER: Cadena. El número de proyecto de tu Cloud.
  • SIDE_PANEL_URL: Cadena. La URL del panel lateral.

Cuando el usuario en la pantalla de la llamada de Meet comparte la página, ve un mensaje de de la presentación en Meet. Hacer clic en el botón del banner abre el complemento para el número de proyecto de la nube determinado en el panel lateral. Se carga la propiedad sidePanelUrl, y la Se usa la propiedad additionalData para establecer la actividad que se iniciará estado del complemento. Los demás usuarios de la llamada le solicitará de inmediato que instale o inicie el complemento.

Ejemplo: Cómo cargar el panel lateral sin iniciar una actividad

En la siguiente muestra de código, la pantalla de un usuario comparte una página con un un complemento que debe ajustar los permisos de los recursos antes de cómo se puede iniciar la actividad. Debido a este requisito, la complemento debería iniciarse en el panel lateral, sin actividad que se está iniciando para todos.

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

Reemplaza lo siguiente:

  • CLOUD_PROJECT_NUMBER: Cadena. El número de proyecto de tu Cloud.
  • SIDE_PANEL_URL: Cadena. La URL del panel lateral.

Cuando el usuario en la pantalla de la llamada de Meet comparte la página, ve un mensaje de de la presentación en Meet. Hacer clic en el botón del banner abre el complemento para el número de proyecto de la nube determinado en el panel lateral. Ya que el startActivityOnOpen se configuró como false, el botón de inicio de actividad se inhabilitará hasta que la Se estableció ActivityStartingState. Para obtener más información, consulta Cómo usar la actividad estado inicial.

Una vez que se inicia la actividad, se les indica a los demás usuarios de la llamada que hagan lo siguiente: iniciar o instalar el complemento.

Coincidencia de origen

Los orígenes proporcionados en mainStageUrl y la sidePanelUrl de la propiedad se comparan con los orígenes del complemento manifiesto del número de proyecto de la nube proporcionado. Si todo coincide, el usuario tiene permitido iniciar el complemento.

Además, se debe indicar el origen del sitio que inicia el uso compartido de la pantalla en el campo addOnOrigins del complemento de Terraform.

Para obtener más información, consulta Complementos seguridad.