通过屏幕共享向用户宣传插件

通过屏幕宣传插件
共享。

本页介绍了如何在使用 Google Meet 共享标签页的屏幕内容时,通过在其他网页上放置少量代码,向用户宣传插件。

通过 exposeToMeetWhenScreensharing() 方法可让该网站向 Meet 发送信息 其标签页在屏幕处于共享状态时显示这些信息会用于 在使用 Meet 时, 用户点击“启动活动”展示横幅上的 插件。如果用户在屏幕共享标签页时未安装该插件,系统会提示他们安装该插件。

AddonScreenshareInfo 对象包含五个可根据用例添加的属性:

  • additionalData: 插件可用于初始化自身的信息。罐形 仅当 startActivityOnOpen 属性为 true 时才设置,可以 使用 ActivityStartingState。 如需了解详情,请参阅获取 activity 的启动状态

  • cloudProjectNumber: 必填。您的 Google Cloud 项目的编号。

  • mainStageUrl:插件启动后主舞台打开的网址,例如 https://www.example.com。该网址必须属于 origin 指定为 插件清单

  • sidePanelUrl: 插件在侧边栏打开的网址 开始,例如 https://www.example.com。该网址必须与插件清单中指定的网址属于同一来源

  • startActivityOnOpen:必填。是否启动 activity 插件 即可立即体验 Meet 中的精彩体验 插件。如果使用 mainStageUrl 属性,则必须为 true。

安装并导入 SDK

您可以使用 npm 或 gstatic 访问该 SDK。

如果您的项目使用 npm,则可以按照 Meet 插件 SDK npm 软件包

首先,安装 npm 软件包:

npm install @googleworkspace/meet-addons

然后,通过导入 MeetAddonScreenshareExport 接口,即可使用 Meet 插件 SDK:

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

对于 TypeScript 用户,TypeScript 定义会打包到模块中。

Gstatic

Google Meet 插件 SDK 以 JavaScript 软件包的形式从 gstatic(提供静态内容的网域)提供。

如要使用 Meet 插件 SDK,请将以下脚本标记添加到 app:

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

Meet 插件 SDK 可通过 MeetAddon 界面的 window.meet.addon 找到。

示例:在侧边栏中加载,而无需启动 activity

在以下代码示例中,用户屏幕与 插件,必须先调整资源权限,然后才能 活动。为此, 插件应在侧边栏中启动,而不使用 为所有人启动一项活动

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

替换以下内容:

  • CLOUD_PROJECT_NUMBER:字符串。您的 Cloud 项目的项目编号。
  • SIDE_PANEL_URL:字符串。侧边栏的网址。

当用户在 Meet 通话屏幕中分享网页时,会在 Meet 中看到演示文稿横幅。点击横幅上的按钮 会打开指定 Cloud 项目编号的插件, 。由于 startActivityOnOpen 属性设置为 false,则“启动 Activity”按钮将处于停用状态,直到 已设置 ActivityStartingState。有关详情,请参阅使用 activity 启动状态

该 activity 启动后,通话中的其他用户会收到启动或安装该插件的指示。

“动画”GitHub 上的示例插件 将此示例作为完整插件的一部分包含在内。时间 索引页 与该插件关联的 Web 应用界面中显示的内容。 系统会提示用户安装或设置 插件。

示例:在主界面中加载

在下面的代码示例中,屏幕共享 系统会提示包含以下代码的 Meet 启动 插件:

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

替换以下内容:

  • CLOUD_PROJECT_NUMBER:字符串。您的 Google Cloud 项目。
  • MAIN_STAGE_URL:字符串。主舞台的网址。

当用户在 Meet 通话屏幕中分享网页时,会在 Meet 中看到演示文稿横幅。点击横幅上的按钮 会打开指定 Cloud 项目编号的插件, 主舞台系统会加载 mainStageUrl 属性,并使用 additionalData 属性设置插件的 activity 启动状态。通话中的其他用户会立即收到安装或启动该插件的消息提示。

示例:在侧边栏中加载

在以下代码示例中,用户屏幕与 希望从侧边栏启动的插件 与主阶段相比:

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

替换以下内容:

  • CLOUD_PROJECT_NUMBER:字符串。您的 Cloud 项目的项目编号。
  • SIDE_PANEL_URL:字符串。侧边栏的网址。

当用户在 Meet 通话屏幕中分享网页时,会在 Meet 中看到演示文稿横幅。点击横幅上的按钮 会打开指定 Cloud 项目编号的插件, 。系统会加载 sidePanelUrl 属性,并使用 additionalData 属性设置插件的 activity 启动状态。通话中的其他用户会立即收到安装或启动该插件的消息提示。

源匹配

源站 mainStageUrl 属性和 sidePanelUrl 属性与插件中的源进行比较 清单。如果所有项目均匹配,则用户 可以发布该插件。

此外,发起屏幕共享的网站的来源必须列在插件清单addOnOrigins 字段中。

有关详情,请参阅插件 安全性