向使用者宣傳外掛程式

開發人員可以透過 Meet 的通話中即時通訊和螢幕分享功能宣傳外掛程式,提高外掛程式的曝光度。

通話中即時通訊

如果訊息含有與外掛程式相關聯的連結,系統就會在 Google Meet 的通話中聊天室中,自動向使用者宣傳 Google Meet 外掛程式。開發人員不必採取任何行動,即可在對話中宣傳外掛程式。審查團隊會根據側邊面板 URI 和部署資訊清單中設定的外掛程式來源,決定要與外掛程式建立關聯的連結。

使用者透過與外掛程式相關聯的通話內即時通訊傳送訊息時,會發生下列其中一種情況:

  1. 如果未安裝外掛程式,系統會顯示資訊卡,提示使用者安裝外掛程式。
  2. 如果已安裝外掛程式,按鈕會提醒使用者開啟外掛程式。

分享螢幕畫面

透過分享螢幕宣傳外掛程式。

本頁說明如何透過在其他網頁上放置少量程式碼,在透過 Google Meet 分享分頁畫面時,向使用者宣傳外掛程式。

網站可透過 exposeToMeetWhenScreensharing() 方法,在分頁畫面分享時將資訊傳送至 Meet。如果使用者已安裝外掛程式,並點選簡報橫幅上的「開始活動」,系統就會在 Meet 外掛程式體驗中使用這項資訊。如果使用者分享分頁畫面時未安裝外掛程式,系統會提示他們安裝。

AddonScreenshareInfo 物件包含五個屬性,可根據用途新增:

  • additionalData:外掛程式可用於初始化自身的資訊。只有在 startActivityOnOpen 屬性為 true 時才能設定,且可使用 ActivityStartingState 存取。詳情請參閱「取得活動的啟動狀態」。

  • cloudProjectNumber: 必要。Google Cloud 專案的專案編號。

  • mainStageUrl:外掛程式啟動後,主要階段開啟的網址,例如 https://www.example.com。網址必須與外掛程式資訊清單中指定的網址屬於同一來源

  • sidePanelUrl:外掛程式啟動後側邊面板開啟的網址,例如 https://www.example.com。網址必須與外掛程式資訊清單中指定的網址屬於同一來源

  • startActivityOnOpen: 必要。使用者從簡報橫幅啟動外掛程式時,是否要立即在 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 定義會與模組一起封裝。 TypeScript 使用者應在專案的 tsconfig.json 中將 moduleResolution 設為 "bundler",以便 package.json「exports」規格啟用匯入螢幕分享套件匯出

gstatic

Google Meet 外掛程式 SDK 可從 gstatic (提供靜態內容的網域) 取得 JavaScript 套件。

如要使用 Meet 外掛程式 SDK,請在應用程式中加入下列指令碼標記:

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

您可以在 window.meet.addon 下的 MeetAddon 介面中找到 Meet 外掛程式 SDK。

範例:在側邊面板中載入,但不啟動活動

在下列程式碼範例中,使用者分享的畫面含有外掛程式,必須先調整資源權限,才能啟動活動。因此,外掛程式應在側邊面板中啟動,而不為所有人啟動活動。

<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 為止。詳情請參閱「使用活動啟動狀態」。

活動開始後,系統會提示通話中的其他使用者啟動或安裝外掛程式。

GitHub 上的「Animation」範例外掛程式包含這個範例,是完整外掛程式的一部分。當系統顯示與外掛程式相關聯的網頁應用程式索引頁面時,會提示顯示該頁面的使用者安裝或設定外掛程式。

範例:載入主舞台

在下列程式碼範例中,如果使用者在含有下列程式碼的網頁上分享螢幕畫面,系統就會提示使用者啟動外掛程式:

<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 屬性設定外掛程式的活動啟動狀態。系統會立即提示通話中的其他使用者安裝或啟動外掛程式。

範例:在側邊面板中載入

在下列程式碼範例中,使用者畫面會與外掛程式共用頁面,而外掛程式想在側邊面板中啟動,而非主要舞台:

<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 屬性設定外掛程式的活動啟動狀態。系統會立即提示通話中的其他使用者安裝或啟動外掛程式。

來源比對

系統會比較 mainStageUrl 屬性和 sidePanelUrl 屬性中提供的來源,以及所提供 Cloud 專案編號的附加元件資訊清單中的來源。如果一切相符,使用者就能啟動外掛程式。

此外,啟動螢幕分享的網站來源必須列在外掛程式資訊清單addOnOrigins 欄位中。

詳情請參閱「外掛程式安全性」。