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

Promover um complemento pela tela compartilhamento.

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 exposeToMeetWhenScreensharing() permite que o site envie informações para o Meet quando a guia é compartilhada de tela. Essas informações são usadas com o Meet quando o usuário clica em "Iniciar atividade" no banner da apresentação se tiverem instalado. Se o usuário não tiver instalado quando compartilham a tela de uma guia, uma solicitação para instalar o complemento.

O 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 Iniciar a atividade estado.

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

  • mainStageUrl: O URL que o cenário principal abre assim que 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. Se o complemento de atividades será iniciado no Meet assim que o usuário inicia a do complemento no banner da apresentação. Precisa ser verdadeiro se a propriedade mainStageUrl for usada.

Instalar e importar o SDK

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

Se o projeto usar o npm, siga as instruções para o pacote npm do SDK do Meet Add-ons.

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 seu aplicativo:

<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 a seguir, a tela de um usuário compartilha uma página com um que precisa ajustar as permissões de recursos antes que o atividade pode 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 do banner abre o complemento para o número fornecido de projeto na nuvem em no painel lateral. Como o startActivityOnOpen propriedade for definida como falsa, o botão de início de atividade ficará desativado até que a ActivityStartingState foi definido. Para mais informações, consulte Usar o estado inicial da atividade.

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

A página "Animação" complemento de amostra no GitHub inclui este 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: carregamento no cenário 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 projeto do Google Cloud.
  • MAIN_STAGE_URL: string. O URL do palco principal.

Quando o usuário na tela de ligações do Meet compartilhar a página, ele verá uma 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 o A propriedade additionalData é usada para definir o início da atividade estado do complemento. Outros usuários na chamada: será solicitado imediatamente a instalar ou iniciar o complemento.

Exemplo: carregar no painel lateral

No exemplo de código a seguir, a tela de um usuário compartilha uma página com um que queira iniciar no painel lateral, do que na fase 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 ligações do Meet compartilhar a página, ele verá uma 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 a 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 iniciou o compartilhamento de tela precisa ser listada. no campo addOnOrigins do complemento manifesto do app.

Para mais informações, consulte Complemento segurança dos dados.