このページでは、別のウェブページに簡単なコードを配置して、タブを Google Meet で画面共有しながら、ユーザーにアドオンを宣伝する方法について説明します。
MeetAddonScreenshare.exposeToMeetWhenScreensharing メソッドを使用すると、サイトが Meet のタブを画面共有しているときに、Meet に情報を送信できます。この情報は、アドオンがインストールされている Meet の場合、ユーザーがプレゼンテーション バナーで [アクティビティを開始] をクリックすると、Meet のアドオン機能で使用されます。ユーザーがアドオンをインストールしていない場合、タブを画面共有すると、アドオンをインストールするよう求められます。
AddonScreenshareInfo オブジェクトには、ユースケースに応じて追加できる 5 つのフィールドが含まれています。
AddonScreenshareInfo.additionalData: アドオンが自身の初期化に使用できる情報。AddonScreenshareInfo.startActivityOnOpenが true の場合にのみ設定でき、CollaborationStartingStateを使用してアクセスできます。詳細については、コラボレーションの開始状態を使用するをご覧ください。AddonScreenshareInfo.cloudProjectNumber: 必須。アドオンの Google Cloud プロジェクト番号。AddonScreenshareInfo.mainStageUrl: アドオンの開始後にメインステージが開く URL（https://www.example.comなど）。URL は、アドオン マニフェストで指定した URL と同じオリジンに属している必要があります。AddonScreenshareInfo.sidePanelUrl: アドオンの開始時にサイドパネルが開く URL（https://www.example.comなど）。URL は、アドオン マニフェストで指定した URL と同じオリジンに属している必要があります。AddonScreenshareInfo.startActivityOnOpen: 必須。ユーザーがプレゼンテーション バナーからアドオンを起動したときに、すぐに Meet のコラボレーション型アドオン エクスペリエンスを開始するかどうか。AddonScreenshareInfo.mainStageUrlを使用する場合は true にする必要があります。
例: メインステージで読み込む
次のコードサンプルでは、Meet で次のコードを含むウェブページを画面共有すると、アドオンを起動するよう求められます。
<script src="https://www.gstatic.com/meetjs/addons/0.1.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: 文字列。メインステージの URL。
Meet の通話画面でユーザーがページを共有すると、Meet にプレゼンテーション バナーが表示されます。バナーのボタンをクリックすると、メインステージで特定の Cloud プロジェクト番号のアドオンが開きます。AddonScreenshareInfo.mainStageUrl が読み込まれ、AddonScreenshareInfo.additionalData を使用してアドオンのコラボレーション開始状態が設定されます。通話の他のユーザーは、アドオンをインストールまたは起動するようにすぐに求められます。
例: サイドパネルで読み込む
次のコードサンプルでは、メインステージではなくサイドパネルから開始するアドオンとページがユーザー画面で共有されています。
<script src="https://www.gstatic.com/meetjs/addons/0.1.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: 文字列。サイドパネルの URL。
Meet の通話画面でユーザーがページを共有すると、Meet にプレゼンテーション バナーが表示されます。バナーのボタンをクリックすると、サイドパネルに特定の Cloud プロジェクト番号のアドオンが開きます。AddonScreenshareInfo.sidePanelUrl が読み込まれ、AddonScreenshareInfo.additionalData を使用してアドオンのコラボレーション開始状態が設定されます。通話の他のユーザーは、アドオンをインストールまたは起動するようにすぐに求められます。
例: コラボレーションを開始せずにサイドパネルを読み込む
次のコードサンプルでは、ユーザーの画面でアドオンとページを共有しています。アドオンは、共同編集アクティビティを開始する前にリソース権限を調整する必要があります。この要件により、すべてのユーザーのコラボレーションは開始せずに、サイドパネルでアドオンを起動する必要があります。
<script src="https://www.gstatic.com/meetjs/addons/0.1.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: 文字列。サイドパネルの URL。
Meet の通話画面でユーザーがページを共有すると、Meet にプレゼンテーション バナーが表示されます。バナーのボタンをクリックすると、サイドパネルに特定の Cloud プロジェクト番号のアドオンが開きます。AddonScreenshareInfo.startActivityOnOpen が false に設定されていたため、CollaborationStartingState が設定されるまでアクティビティ開始ボタンは無効になります。詳しくは、共同編集の開始状態を使用するをご覧ください。
アクティビティが開始されると、通話の他のユーザーに対して、アドオンを起動またはインストールするように求められます。
オリジンの照合
AddonScreenshareInfo.mainStageUrl と AddonScreenshareInfo.sidePanelUrl で指定されたオリジンは、指定された Cloud プロジェクト番号のアドオン マニフェストのオリジンと比較されます。すべてが一致する場合、ユーザーはアドオンを起動できます。
また、画面共有を開始したサイトのオリジンを、アドオン マニフェストの addOnOrigins フィールドに記載する必要があります。
詳細については、アドオンのセキュリティをご覧ください。