本页介绍了如何在使用 Google Meet 共享标签页屏幕时,通过在其他网页上放置少量代码,向用户宣传插件。
使用 exposeToMeetWhenScreensharing()
方法,网站可以在共享屏幕时向 Meet 发送信息。当用户点击演示文稿横幅上的“开始活动”(前提是用户已安装该插件)时,系统会在 Meet 插件体验中使用这些信息。如果用户在屏幕共享标签页时没有安装该插件,系统会提示用户安装该插件。
AddonScreenshareInfo
对象包含五个可根据用例添加的属性:
additionalData
:该插件可用来初始化自己的信息。仅当startActivityOnOpen
属性为 true 且可使用ActivityStartingState
访问时,才能进行设置。如需了解详情,请参阅获取 activity 的启动状态。cloudProjectNumber
:必填。您的 Google Cloud 项目的编号。mainStageUrl
:插件启动后主舞台打开的网址,例如https://www.example.com
。该网址必须与插件清单中指定的网址属于同一来源。sidePanelUrl
:边栏在插件启动后打开的网址,例如https://www.example.com
。该网址必须与插件清单中指定的网址属于同一来源。startActivityOnOpen
:必填。当用户从展示横幅中启动该插件时,是否立即在 Meet 中启动该插件体验。如果使用mainStageUrl
属性,则必须为 true。
安装并导入 SDK
您可以使用 npm 或 gstatic 访问该 SDK。
npm(推荐)
如果您的项目使用 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,请将以下脚本标记添加到您的应用中:
<script src="https://www.gstatic.com/meetjs/addons/1.1.0/meet.addons.screenshare.js"></script>
Meet 插件 SDK 可通过 window.meet.addon
下的 MeetAddon
接口获取。
示例:在侧边栏中加载,而无需启动 activity
在以下代码示例中,用户界面与插件共享一个页面,该插件必须先调整资源权限,然后才能启动 activity。鉴于此要求,您应在侧边栏中启动该插件,而无需为所有用户启动 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 中看到演示文稿横幅。点击横幅上的按钮,即可在侧边栏中打开给定云项目编号的插件。由于 startActivityOnOpen
属性已设置为 false,因此在设置 ActivityStartingState
之前,启动 activity 按钮处于停用状态。如需了解详情,请参阅使用 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 中看到演示文稿横幅。点击横幅上的按钮,即可在主舞台中打开给定云项目编号的插件。系统会加载 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 中看到演示文稿横幅。点击横幅上的按钮,即可在侧边栏中打开给定云项目编号的插件。系统会加载 sidePanelUrl
属性,并使用 additionalData
属性设置插件的 activity 启动状态。通话中的其他用户会立即收到安装或启动该插件的消息提示。
源匹配
系统会将 mainStageUrl
属性和 sidePanelUrl
属性中提供的来源与所提供 Cloud 项目编号的插件清单中的来源进行比较。如果一切匹配,用户就可以启动该插件。
此外,发起屏幕共享的网站的来源必须列在插件清单的 addOnOrigins
字段中。
如需了解详情,请参阅插件安全。