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

通过屏幕共享来推广插件。

本页介绍如何在与 Google Meet 共享标签页时,通过在另一个网页上放置少量代码,向用户推广插件。

MeetAddonScreenshare.exposeToMeetWhenScreensharing 方法允许网站在标签页共享时向 Meet 发送信息。如果用户安装了 Meet 插件,那么当用户点击展示横幅上的“Start activity”时,系统就会在 Meet 插件体验中使用此信息。如果用户在屏幕共享标签页时没有安装该插件,系统会提示用户安装该插件。

AddonScreenshareInfo 对象包含五个字段,可以根据用例加以添加:

示例:在主界面中加载

在以下代码示例中,如果用户在 Meet 中共享包含以下代码的网页,则系统会提示该用户启动该插件:

<script src="https://www.gstatic.com/meetjs/addons/0.7.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>

请替换以下内容:

  • CLOUD_PROJECT_NUMBER:字符串。您的 Cloud 项目编号。
  • MAIN_STAGE_URL:字符串。主界面的网址。

当用户通过 Meet 通话屏幕共享页面时,他们会在 Meet 中看到展示横幅。点击横幅上的按钮会在主阶段打开指定 Cloud 项目编号的插件。系统会加载 AddonScreenshareInfo.mainStageUrl,并使用 AddonScreenshareInfo.additionalData 设置插件的协作开始状态。系统会立即提示通话中的其他用户安装或启动该插件。

示例:在侧边栏中加载

在以下代码示例中,用户共享一个页面,其中包含希望在侧边栏(而不是主界面)中启动的插件:

<script src="https://www.gstatic.com/meetjs/addons/0.7.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>

请替换以下内容:

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

当用户通过 Meet 通话屏幕共享页面时,他们会在 Meet 中看到展示横幅。点击横幅上的按钮会在侧边栏中打开给定 Cloud 项目编号的插件。系统会加载 AddonScreenshareInfo.sidePanelUrl,并使用 AddonScreenshareInfo.additionalData 设置插件的协作开始状态。系统会立即提示通话中的其他用户安装或启动该插件。

示例:在不开始协作的情况下在侧边栏中加载

在以下代码示例中,用户屏幕与插件共享一个页面,该插件必须在启动协作 activity 之前调整资源权限。鉴于此要求,应在侧边栏中启动该插件,而无需为所有人启动协作。

<script src="https://www.gstatic.com/meetjs/addons/0.7.0/meet.addons.screenshare.js"></script>
<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 项目编号的插件。由于 AddonScreenshareInfo.startActivityOnOpen 设置为 false,因此启动 activity 按钮处于停用状态,直到设置 CollaborationStartingState。如需了解详情,请参阅使用协作开始状态

activity 启动后,系统会提示通话中的其他用户启动或安装该插件。

源匹配

AddonScreenshareInfo.mainStageUrlAddonScreenshareInfo.sidePanelUrl 中提供的来源将与提供的 Cloud 项目编号的插件清单中的来源进行比较。如果所有结果均匹配,则用户可以启动该插件。

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

如需了解详情,请参阅插件安全性