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

Promoção de um complemento pelo compartilhamento de tela.

Esta página descreve como promover um complemento para os usuários enquanto compartilha a tela de uma guia com o Google Meet, colocando uma pequena quantidade de código em outra página da Web.

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

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

  • additionalData: informações que o complemento pode usar para se inicializar. Só pode ser definido se a propriedade startActivityOnOpen for verdadeira e puder ser acessada usando o ActivityStartingState. Para mais informações, consulte Receber o estado de início da atividade.

  • cloudProjectNumber: obrigatório. O número do projeto do Google Cloud.

  • mainStageUrl: o URL que o palco principal abre quando o complemento é iniciado, como https://www.example.com. O URL precisa pertencer à mesma origem que os URLs especificados no manifesto do complemento.

  • sidePanelUrl: o URL em que o painel lateral é aberto quando o complemento é iniciado, como https://www.example.com. O URL precisa pertencer à mesma origem que os URLs especificados no manifesto do complemento.

  • startActivityOnOpen: obrigatório. Define se a experiência do complemento de atividade no Meet será iniciada imediatamente quando o usuário iniciar o complemento no banner de apresentação. Precisa ser verdadeiro se a propriedade mainStageUrl for usada.

Instalar e importar o SDK

É possível acessar o SDK usando o npm ou o gstatic.

Se o projeto usar o npm, siga as instruções para o pacote npm do SDK de complementos do Meet.

Primeiro, instale o pacote npm:

npm install @googleworkspace/meet-addons

Em seguida, o SDK de complementos do Meet fica disponível ao importar a interface MeetAddonScreenshareExport:

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

Para usuários do TypeScript, as definições do TypeScript são empacotadas com o módulo.

gstatic

O SDK de complementos do Google Meet está disponível como um pacote JavaScript de gstatic, um domínio que serve conteúdo estático.

Para usar o SDK de complementos do Meet, adicione a seguinte tag de script ao app:

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

O SDK de complementos do Meet está disponível na interface MeetAddon em window.meet.addon.

Exemplo: carregar no painel lateral sem iniciar uma atividade

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

<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 do Cloud.
  • SIDE_PANEL_URL: string. O URL do painel lateral.

Quando o usuário na tela de chamada do Meet compartilha a página, ele vê um banner de apresentação no Meet. Clicar no botão no banner abre o complemento para o número do projeto do Cloud no painel lateral. Como a propriedade startActivityOnOpen foi definida como falsa, o botão de iniciar atividade fica desativado até que o ActivityStartingState seja definido. Para mais informações, consulte Usar o estado de início da atividade.

Quando a atividade é iniciada, outros usuários na chamada são solicitados a iniciar ou instalar o complemento.

O complemento de exemplo"Animation" no GitHub inclui esse exemplo como parte de um complemento completo. Quando a página de índice do app da Web associado ao complemento é apresentada, o usuário que está apresentando é solicitado a instalar ou configurar o complemento.

Exemplo: carregar no palco principal

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

<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 do Google Cloud.
  • MAIN_STAGE_URL: string. O URL do palco principal.

Quando o usuário na tela de chamada do Meet compartilha a página, ele vê um banner de apresentação no Meet. Clicar no botão no banner abre o complemento para o número de projeto do Google Cloud no palco principal. A propriedade mainStageUrl é carregada, e a propriedade additionalData é usada para definir o estado de início da atividade do complemento. Outros usuários na chamada são imediatamente solicitados a instalar ou iniciar o complemento.

Exemplo: carregar no painel lateral

No exemplo de código abaixo, uma tela do usuário compartilha uma página com um complemento que quer iniciar no painel lateral, em vez do palco principal:

<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 do Cloud.
  • SIDE_PANEL_URL: string. O URL do painel lateral.

Quando o usuário na tela de chamada do Meet compartilha a página, ele vê um banner de apresentação no Meet. Clicar no botão no banner abre o complemento para o número do projeto do Cloud no painel lateral. A propriedade sidePanelUrl é carregada, e a propriedade additionalData é usada para definir o estado de início da atividade do complemento. Outros usuários na chamada são imediatamente solicitados a instalar ou iniciar o complemento.

Correspondência de origem

As origens fornecidas na propriedade mainStageUrl e na propriedade sidePanelUrl são comparadas às origens no manifesto do complemento do número do projeto do Cloud 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 de complemento.

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