ホームページは、1 つ以上のコンテキスト カードを定義する機能を提供する Google Workspace アドオンの機能です。コンテキストなしのカードは、ユーザーが特定のコンテキスト外にいる場合（メッセージや下書きを開かずに Gmail の受信トレイを表示している場合など）に、ユーザー インターフェースを表示します。
ホームページでは、クイック アクセス サイドパネル（Google Keep、Google カレンダー、Google ToDo リスト）の Google アプリと同様に、コンテキストに依存しないコンテンツを表示できます。ホームページは、ユーザーがアドオンを初めて開く際の最初の出発点にもなり、新規ユーザーにアドオンの操作方法を教えるのに役立ちます。
プロジェクト マニフェストでホームページを指定し、1 つ以上の homepageTrigger 関数を実装して、アドオンのホームページを定義します（ホームページの構成を参照）。
ホームページは複数設定できます。アドオンが拡張するホスト アプリケーションごとに 1 つずつ設定できます。カスタム ホームページを指定していないホストで使用される共通のデフォルト ホームページを 1 つ定義することもできます。
アドオンのホームページは、次の場合に表示されます。
- アドオンがホストで初めて開かれたとき（承認後）。
- アドオンが開いているときに、ユーザーがコンテキスト コンテキストからコンテキスト以外のコンテキストに切り替えた場合。たとえば、カレンダーの予定の編集からメインのカレンダーに移動します。
- ユーザーが [戻る] ボタンを何度もクリックして、内部スタックからカードを 1 枚おきにポップアップさせた場合。
- コンテキスト カード以外の UI インタラクションが
Navigation.popToRoot呼び出しにつながる場合。
ホームページを設計することをおすすめします。定義しない場合、ユーザーがホームページに移動するたびに、アドオン名を含む一般的なカードが使用されます。
ホームページの設定
Google Workspace アドオンは、addOns.common.homepageTrigger フィールドを使用して、アドオンのマニフェストでホスト アプリケーションのデフォルトのホームページ（コンテキストなし）アドオン コンテンツを構成します。
{
"addOns": {
"common": {
"homepageTrigger": {
"runFunction": "myFunction",
"enabled": true
}
}
}
}
runFunction: Google Workspace アドオン フレームワークがホームページ アドオンカードをレンダリングするために呼び出す Google Apps Script 関数の名前。この関数はホームページ トリガー関数です。この関数は、ホームページの UI を構成するCardオブジェクトの配列を構築して返す必要があります。複数のカードが返された場合、ホスト アプリケーションは、ユーザーが選択できるリストにカードの見出しを表示します（複数のカードを返すを参照）。enabled: このスコープでホームページ カードを有効にするかどうか。このフィールドは省略可能で、デフォルト値はtrueです。これをfalseに設定すると、すべてのホストでホームページ カードが無効になります（そのホストでオーバーライドされていない場合。ホスト固有の構成をご覧ください）。
ホストが共通のホームページを使用するには、addOns.common.homepageTrigger とホストの最上位リソースの両方がアドオンのマニフェストに存在する必要があります。たとえば、マニフェストに addOns.gmail が存在しない場合、アドオンは Gmail で無効になり、そのホストでホームページなどの機能が表示されなくなります。
共通の構成に加えて、同一構造のホストごとのオーバーライドが、各ホスト アプリケーションの構成（addOns.gmail.homepageTrigger、addOns.calendar.homepageTrigger、その他のホスト固有のトリガー）で利用できます。
次の例は、一般的なホームページ トリガーが定義されているが、カレンダーとドライブのカスタム関数でオーバーライドされ、Gmail では無効になっているマニフェストを示しています。この構成では、共通の buildHomePage 関数はオーバーライドされるか、ホストが無効になるため、実行されません。
{
...
"addOns": {
...
"common": {
"homepageTrigger": { "runFunction": "buildHomePage" }
},
"calendar": {
"homepageTrigger": { "runFunction": "buildCalendarHomepage" }
},
"drive": {
"homepageTrigger": { "runFunction": "buildDriveHomepage" }
},
"gmail": {
"homepageTrigger": { "enabled": false }
},
...
}
}
次のマニフェストの抜粋は、デフォルトの homepageTrigger と Gmail の構成が省略されていますが、前の例と同じです。
{
"addOns": {
"common": {},
"calendar": {
"homepageTrigger": { "runFunction": "myCalendarFunction" }
},
"drive": {
"homepageTrigger": { "runFunction": "myDriveFunction" }
},
"gmail": {},
...
}
}
homepageTrigger セクションは必須ではありません。ホスト プロダクトでアドオンに表示される UI は、対応するマニフェスト フィールドが存在するかどうかと、関連付けられた homepageTrigger があるかどうかによって異なります。次の例は、さまざまなマニフェスト構成でホームページ UI を作成するために実行されるアドオン トリガー関数を示しています。
ホームページのイベント オブジェクト
呼び出されると、前述のホームページ トリガー関数（runFunction）に、呼び出しコンテキストのデータを含むイベント オブジェクトが渡されます。
ホームページのイベント オブジェクトには、ウィジェットやコンテキスト情報は含まれません。渡される情報は、次の共通イベント オブジェクトのフィールドに限定されます。
commonEventObject.clientPlatformcommonEventObject.hostAppcommonEventObject.userLocaleとcommonEventObject.userTimezone（制限事項については、ユーザーのロケールとタイムゾーンへのアクセスを参照）。
詳しくは、イベント オブジェクトをご覧ください。
その他のコンテキスト以外のカード
アドオンの UI には、ホームページ以外のコンテキスト以外のカードを追加できます。たとえば、ホームページに [設定] カードを開いてアドオンの設定を調整するボタンがある場合があります（通常、このような設定はコンテキストに依存しません）。
コンテキスト以外のカードは他のカードと同様に作成されます。唯一の違いは、カードを生成して表示するアクションまたはイベントです。カード間のトランジションの作成方法について詳しくは、ナビゲーション メソッドをご覧ください。