Meet アドオンを使用してコラボレーションする

会議の参加者は、Google Meet アドオン アクティビティで共同作業できます。共同アクティビティが開始されると、会議の参加者全員にアクティビティが進行中であることを知らせる通知が届きます。

この通知は、アドオンの可用性とインストール ステータスに応じて調整されます。

  • 参加者がアドオンをインストールしている場合: アクティビティに参加できます。

  • 参加者がアドオンをインストールしていない場合: アドオンをインストールするよう指示されます。

  • 参加者のプラットフォームでアドオンを利用できない場合: 現在のデバイスではアクティビティに参加できないことが通知されます。

ユーザーがアクティビティに参加すると、アドオン コンテンツを含む独自の iframe が読み込まれます。新しい参加者がコラボレーション アクティビティをメイン画面とサイドパネルのどちらで開くかをカスタマイズできます。

アクティビティを開始する

アクティビティは、ActivityStartingState インターフェースを使用する startActivity() メソッドを呼び出すことで開始されます。

ステップ 1（省略可）: アドオンがアクティビティの開始状態を設定する

ActivityStartingState には、参加者がアクティビティへの参加招待を承諾したときに使用されるアドオンの初期状態に関する情報が含まれます。

アドオンは、アクティビティの前またはアクティビティ中に setActivityStartingState() メソッドを呼び出すことで、ActivityStartingState を設定または更新できます。ActivityStartingState が startActivity() の呼び出しで排他的に設定されている場合、setActivityStartingState() の呼び出しは省略できます。

ステップ 2: アドオンがアクティビティを開始する

アクティビティは、アドオンが MeetSidePanelClient で startActivity() メソッドを呼び出すと開始します。startActivity() メソッドは ActivityStartingState オブジェクトをパラメータとして受け取るため、setActivityStartingState() を呼び出す代わりに startActivity() を呼び出すことができます。

ユーザーがコンテンツの選択を完了し、アクティビティを開始する準備ができたら、アドオンで次のように startActivity() メソッドを呼び出します。

    sidePanelClient.startActivity({
        mainStageUrl: "https://app.example.com/mainstage",
        additionalData: JSON.stringify({
            // State to send to participants.
        })
    });

startActivity() メソッドが呼び出されると、Meet は次のアクションを実行します。

  • 他の参加者: アクティビティが進行中であることを知らせる通知が Meet に表示されます。

  • 開始者向け: ActivityStartingState でメインステージの URL が指定されている場合、Meet は ActivityStartingState の URL を使用してメインステージを開きます。

ステップ 3: アクティビティの開始状態を取得する

ユーザーがアクティビティに参加すると、ActivityStartingState に応じて、アドオンがメインステージまたはサイドパネルに読み込まれます。

additionalData プロパティを使用すると、アクティビティに参加するユーザーと初期データ（状態とも呼ばれます）を共有できます。MainStageClient または SidePanelClient を初期化した後、getActivityStartingState() メソッドを呼び出して additionalData プロパティを取得できます。

const startingState = client.getActivityStartingState();
const additionalData = JSON.parse(startingState.additionalData);

ステップ 4（省略可）: アクティビティでアドオンの状態を共有する

アクティビティの進行中にユーザー間で状態を共有することもできます。状態を共有する方法は 2 つあります。

  • 独自の同期バックエンドを作成して、自分で処理します。
  • Co-Doing API を使用します。これは、ユーザー間で任意のデータを共有する便利で高速な方法です。

例: GitHub のアニメーション アドオン

GitHub の「Animation」サンプル アドオンには、アドオンでのコラボレーションが含まれています。このガイドのステップ 1 はサンプルに含まれていません。代わりに、アドオンの開始者がサイドパネルの [Start the Animation] ボタンをクリックすると、ユーザーが選択した色で開始状態が設定され、startActivity() メソッドが呼び出されます（ステップ 2）。アクティビティが開始されると、メインステージは getActivityStartingState() メソッドを呼び出すことで開始状態を取得します（ステップ 3）。このサンプル アドオンでは、アクティビティ中に参加者間で状態（選択した色）が共有されないため、ステップ 4 は省略されています。ただし、個々のユーザーは色を選択して自分の状態を変更できます。この色は、フレーム間メッセージングを使用して、サイドパネル フレームからメインステージ フレームに送信されます。

制約