ホームページ

ホームページは、1 つ以上のコンテキスト カード以外のカードを定義できる新しい Google Workspace アドオン機能です。コンテキスト外のカードは、ユーザーが特定のコンテキスト外にいるときにユーザー インターフェースを表示するために使用されます。たとえば、ユーザーが Gmail の受信トレイを表示しているが、メールや下書きを開いていない場合などです。

ホームページでは、クイック アクセス サイドパネル （Keep、カレンダー、ToDo リスト）の Google アプリと同様に、コンテキストに依存しないコンテンツを表示できます。ホームページは、ユーザーがアドオンを初めて開く際の最初の出発点にもなり、新規ユーザーにアドオンの操作方法を教えるのに役立ちます。

アドオンのホームページは、プロジェクト マニフェストで指定し、1 つ以上の homepageTrigger 関数を実装することで定義できます（ホームページの構成を参照）。

アドオンが拡張するホスト アプリケーションごとに、複数のホームページを設定できます。カスタム ホームページを指定していないホストで使用される共通のデフォルト ホームページを 1 つ定義することもできます。

アドオンのホームページは、次のいずれかの条件が満たされた場合に表示されます。

  • アドオンがホストで初めて開かれたとき（承認後）。
  • アドオンが開いているときに、ユーザーがコンテキスト コンテキストからコンテキストなしコンテキストに切り替えた場合。たとえば、カレンダーの予定の編集画面からメインのカレンダーに移動します。
  • ユーザーが [戻る] ボタンを複数回クリックして、内部スタックからカードを 1 枚おきにポップした場合。
  • コンテキスト カード以外の UI インタラクションが Navigation.popToRoot() 呼び出しにつながる場合。

ホームページの設計は必須ではありませんが、強く推奨されます。ホームページを定義しない場合、ユーザーがホームページに移動しようとすると、アドオン名を含む一般的なカードが使用されます。

ホームページの設定

Google Workspace アドオンは、addOns.common.homepageTrigger フィールドを使用して、アドオンのすべてのホスト アプリケーションのデフォルトのホームページ（コンテキストなし）アドオン コンテンツをアドオンのマニフェストで構成します。

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }

  • runFunction: Google Workspace アドオン フレームワークがホームページ アドオンカードをレンダリングするために呼び出す Apps Script 関数の名前。この関数はホームページ トリガー関数です。この関数は、ホームページの UI を構成する Card オブジェクトの配列を構築して返す必要があります。複数のカードが返された場合、ホスト アプリケーションは、ユーザーが選択できるリストにカードのヘッダーを表示します（複数のカードを返すを参照）。

  • enabled: このスコープでホームページ カードを有効にするかどうか。このフィールドは省略可能で、デフォルト値は true です。これを false に設定すると、すべてのホストでホームページ カードが無効になります（そのホストでオーバーライドされていない場合。下記を参照）。

共通構成に加えて、各ホスト アプリケーションの構成（addOns.gmail.homepageTrigger、addOns.calendar.homepageTrigger など）で、同じ構造のホストごとのオーバーライドも利用できます。

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

これは、次のマニフェストの抜粋と同等です。

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

homepageTrigger セクションはどれも必須ではありません。ただし、特定のホスト プロダクトでアドオンに表示される UI は、対応するマニフェスト フィールドが存在するかどうか、および関連付けられた homepageTrigger があるかどうかによって異なります。次の例は、さまざまなマニフェスト構成のホームページ UI を作成するために実行されるアドオン トリガー関数（存在する場合）を示しています。

ホームページのフロー

ホームページのイベント オブジェクト

呼び出されると、上記のホームページ トリガー関数（runFunction）には、呼び出しコンテキストのデータを含むイベント オブジェクトが渡されます。

ホームページのイベント オブジェクトには、ウィジェットやコンテキスト情報は含まれません。渡される情報は、次の共通イベント オブジェクトのフィールドに限定されます。

詳しくは、イベント オブジェクトをご覧ください。

その他のコンテキスト以外のカード

アドオンの UI には、ホームページ以外のコンテキスト以外のカードを追加できます。たとえば、ホームページに [設定] カードを開くボタンがあり、ユーザーがアドオンの設定を調整できる場合があります（このような設定は、ほとんどの場合、コンテキストとは独立しているため、コンテキスト依存ではありません）。

コンテキスト以外のカードは他のカードと同様に作成されます。唯一の違いは、カードを生成して表示するアクションまたはイベントです。カード間のトランジションの作成方法について詳しくは、ナビゲーション メソッドをご覧ください。