向用户推广插件

开发者可以通过 Meet 的通话中聊天功能和屏幕共享功能宣传插件，从而提高插件的曝光度。

通话中聊天

当消息包含与插件相关联的链接时，系统会自动在 Meet 的通话中聊天功能中向用户宣传 Google Meet 插件。开发者无需执行任何操作即可在聊天中宣传插件。审核团队会根据边栏 URI 和部署清单中设置的插件来源，确定要与插件相关联的链接 。

当用户通过与插件相关联的通话中聊天功能发送消息时，会发生以下两种情况之一：

1. 如果未安装插件，系统会显示一张卡片，提示用户安装插件。
2. 如果已安装插件，系统会显示一个按钮，提醒用户打开插件。

屏幕共享

本页介绍了如何在通过 Google Meet 屏幕共享标签页时，通过在另一个网页上放置少量代码来向用户宣传插件。

借助 exposeToMeetWhenScreensharing() 方法，网站可以在其标签页被屏幕共享时向 Meet 发送信息。如果用户安装了插件，并且点击了演示文稿横幅上的“开始 activity”，则系统会在插件体验中使用此信息。如果用户在屏幕共享标签页时未安装插件，系统会提示用户安装插件。

The AddonScreenshareInfo 对象包含五个属性，您可以根据用例添加这些属性：

• additionalData：插件可用于初始化自身的信息。只有在 startActivityOnOpen 属性为 true 时才能设置，并且可以使用 ActivityStartingState 进行访问。 如需了解详情，请参阅获取 activity 启动 状态。

• cloudProjectNumber：必需。您的 Google Cloud 项目的项目编号。

• mainStageUrl：插件启动后主舞台打开的网址，例如 https://www.example.com。该网址必须与插件清单中指定的网址属于同一 来源。

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

• startActivityOnOpen：必需。是否在用户从演示文稿横幅启动插件时，立即在 Meet 中启动 activity 插件体验。如果使用 mainStageUrl 属性，则必须为 true。

安装和导入 SDK

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

npm install @googleworkspace/meet-addons

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

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

示例：在边栏中加载，而不启动 activity

在以下代码示例中，用户屏幕共享的页面包含一个插件，该插件必须先调整资源权限，然后才能启动 activity。由于此要求，插件应在边栏中启动，而不为所有人启动 activity。

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

替换以下内容：

• CLOUD_PROJECT_NUMBER：字符串。您的云项目项目编号。
• SIDE_PANEL_URL：字符串。边栏的网址。

当 Meet 通话中的用户屏幕共享该页面时，他们会在 Meet 中看到演示文稿横幅。点击横幅上的按钮会在侧边栏中打开给定云项目编号的插件。由于 startActivityOnOpen 属性已设置为 false，因此在设置 ActivityStartingState之前，启动 activity 按钮处于停用状态。如需了解详情，请参阅使用 activity 启动状态。

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

GitHub 上的 “Animation”示例插件 包含此示例，作为完整插件的一部分。当 呈现与插件关联的 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 中看到演示文稿横幅。点击横幅上的按钮会在主舞台中打开给定云项目编号的插件。系统会加载 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：字符串。您的云项目项目编号。
• SIDE_PANEL_URL：字符串。边栏的网址。

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

来源匹配

系统会将 来源（在 mainStageUrl 属性和 sidePanelUrl 属性中提供）与提供的云项目编号的插件 清单中的来源进行比较。如果一切匹配，则允许用户启动插件。

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

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

相关主题

• 使用 Meet 插件进行协作
• 插件安全性