Promover um complemento para os usuários com o compartilhamento de tela

Promover um complemento pelo compartilhamento de tela.

Esta página descreve como promover um complemento para os usuários ao compartilhar uma guia de tela com o Google Meet inserindo uma pequena quantidade de código em outra página da Web.

O método MeetAddonScreenshare.exposeToMeetWhenScreensharing permite que o site envie informações ao Meet quando a tela é compartilhada. Essas informações são usadas na experiência de complemento no Meet quando o usuário clica em "Iniciar atividade" no banner da apresentação se tiver o complemento instalado. Se o usuário não tiver o complemento instalado quando compartilhar uma guia de tela, ele vai receber uma solicitação para instalar o complemento.

O objeto AddonScreenshareInfo contém cinco campos que podem ser adicionados com base no caso de uso:

Exemplo: carregamento no cenário principal

No exemplo de código a seguir, um usuário que compartilha a tela uma página da Web no Meet contendo o seguinte código é solicitado a iniciar o complemento:

<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>

Substitua:

  • CLOUD_PROJECT_NUMBER: string. O número do projeto na nuvem.
  • MAIN_STAGE_URL: string. É o URL do cenário principal.

Quando o usuário na tela de chamada do Meet compartilhar a página, ele verá um banner de apresentação no Meet. Clique no botão no banner para abrir o complemento para o número especificado do projeto na nuvem no cenário principal. O AddonScreenshareInfo.mainStageUrl é carregado e o AddonScreenshareInfo.additionalData é usado para definir o estado inicial da colaboração do complemento. Os demais usuários na chamada vão receber imediatamente uma solicitação para instalar ou iniciar o complemento.

Exemplo: carregar no painel lateral

No exemplo de código a seguir, uma tela de usuário compartilha uma página com um complemento que quer começar no painel lateral, em vez de no cenário 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>

Substitua:

  • CLOUD_PROJECT_NUMBER: string. O número do projeto na nuvem.
  • SIDE_PANEL_URL: string. É o URL do painel lateral.

Quando o usuário na tela de chamada do Meet compartilhar a página, ele verá um banner de apresentação no Meet. Quando você clica no botão no banner, o complemento para o número de projeto na nuvem especificado é aberto no painel lateral. O AddonScreenshareInfo.sidePanelUrl é carregado e o AddonScreenshareInfo.additionalData é usado para definir o estado inicial da colaboração do complemento. Os demais usuários na chamada vão receber imediatamente uma solicitação para instalar ou iniciar o complemento.

Exemplo: carregar no painel lateral sem iniciar uma colaboração

No exemplo de código a seguir, uma tela de usuário compartilha uma página com um complemento que precisa ajustar as permissões de recursos antes que a atividade de colaboração possa ser iniciada. Devido a esse requisito, o complemento precisa ser iniciado no painel lateral, sem que a colaboração seja iniciada para todos.

<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>

Substitua:

  • CLOUD_PROJECT_NUMBER: string. O número do projeto na nuvem.
  • SIDE_PANEL_URL: string. É o URL do painel lateral.

Quando o usuário na tela de chamada do Meet compartilhar a página, ele verá um banner de apresentação no Meet. Quando você clica no botão no banner, o complemento para o número de projeto na nuvem especificado é aberto no painel lateral. Como o AddonScreenshareInfo.startActivityOnOpen foi definido como falso, o botão "Iniciar atividade" ficará desativado até que o CollaborationStartingState seja definido. Para mais informações, consulte Usar o estado inicial da colaboração.

Quando a atividade for iniciada, os outros usuários na chamada precisarão iniciar ou instalar o complemento.

Correspondência de origem

As origens fornecidas em AddonScreenshareInfo.mainStageUrl e AddonScreenshareInfo.sidePanelUrl são comparadas às origens no manifesto do complemento do número de projeto na nuvem fornecido. Se tudo corresponder, o usuário poderá iniciar o complemento.

Além disso, a origem do site que inicia o compartilhamento de tela precisa ser listada no campo addOnOrigins no manifesto do complemento.

Para mais informações, consulte Segurança de complementos.