Google カレンダー インターフェースの構築

Google Workspace アドオンは、Google Workspace の インターフェース。 これにより、関連する追加情報をユーザーに提供したり、 サードパーティ製システムと Google カレンダーを接続できます。

Google カレンダーのアドオン インターフェースを作成する場合、 homepage。同じ 複数の主催者向けのホームページを作成したり、Google カレンダー用に特定のホームページを設計したりできます。

アドオンでは、ユーザーが開いたときに表示されるインターフェースも定義できます。 カレンダーの予定が開きます。

アドオン UI へのアクセス

Google Workspace アドオンでは、開く方法に応じて、ホームページ、Google カレンダーの予定のインターフェース、添付ファイルの選択インターフェース、または次の 3 つすべてを定義できます。

  • ユーザーがカレンダー ビューでアドオン アイコンをクリックすると、アドオンが実行されます 対応する calendar.homepageTrigger 使用します(存在する場合)。この関数は、ホームページ カードを作成して返します。 カレンダーに表示できます「いいえ」の場合 calendar.homepageTrigger 関数が定義されていない場合は、代わりに汎用のホームページ カードが表示されます。
  • ユーザーがカレンダーの予定を開き、アドオン アイコンをクリックした場合 ユーザーがイベントを開くとアドオンが開き、 対応する eventOpenTrigger 使用します(存在する場合)。この関数は、アドオンのカレンダーの予定を作成します。 Google カレンダーに戻って表示されます。
  • アドオンが eventAttachmentTrigger 関数を定義する場合: ユーザーがカレンダーの予定の編集中に [添付ファイルを追加] をクリックすると、アドオンが添付ファイル プロバイダとして表示されます。アドオンを選択すると eventAttachmentTrigger 関数はアドオンのアタッチメントを作成します。 Google カレンダーに返します。

カレンダー アドオン インターフェースの構築

Google カレンダーを拡張するには、 Google Workspace アドオンを使用する手順は次のとおりです。

  1. アドオンにカレンダー固有の機能を使用するかどうかを指定する homepage。 また、ユーザーがログインしたときにカスタム インターフェースを提供するかどうかも決定します。 カレンダーの予定の編集に使用できます。
  2. 適切な addOns.common および addOns.calendar フィールドをアドオン スクリプト プロジェクトのマニフェストに追加します。 (必要なスコープを含む)。
  3. カレンダー固有の API を提供する場合は、 homepage、 実装する calendar.homepageTrigger 関数を使用してこのインターフェースを構築します。また、 common.homepageTrigger インターフェースを複数の Google Workspace ホストにホストできます。
  4. カレンダーの予定のインターフェースを提供する場合、 calendar.eventOpenTrigger 関数を使用してこのインターフェースを構築します。詳しくは、 カレンダーの予定のインターフェースの拡張 をご覧ください。
  5. ユーザーのリクエストへの応答に必要な、関連するコールバック関数を実装します。 UI 操作(ボタンのクリックなど)。

カレンダーのホームページ

Google カレンダーでは、Google Workspace アドオンのホームページの表示がサポートされています。 Google カレンダーにアドオンの一般的なホームページを表示するには、 addOns.calendar である フィールドを宣言する必要があります。

または、 calendar.homepageTrigger をアドオン マニフェストに追加して、カレンダー固有のホームページを提供します。

いずれの場合も、ホームページのトリガー関数の名前を スクリプト プロジェクト。この関数は自動的に呼び出され、 Google カレンダーのホームページを必要に応じて開くことができます。ビルドするには、この関数を実装する必要があります。 単一の Card または次の配列 Card オブジェクトを定義します。ホームページ トリガー関数は、 イベント オブジェクト パラメータとして渡すことにより、クライアントの できます。イベント オブジェクト データを使用して、 できます。

カレンダーの予定インターフェースの拡張

Google カレンダーはコンテキストに基づくトリガーを使用して、 ユーザーがカレンダーの予定を編集したときに表示されます。トリガーが トリガーが発生すると、 calendar.eventOpenTrigger フィールド(アドオンのマニフェスト内)に追加します。

関数で calendar.eventOpenTrigger 表示されます。この関数は、イベント オブジェクトを 単一の ID または値を返す Card オブジェクトまたは カレンダーでエクスポートするオブジェクト Card ユーザーがイベントを開いている間のみ 表示されます

イベント オブジェクト

イベント オブジェクトが作成され、 渡される calendar.eventOpenTrigger ユーザーが開いたときにコンテキストに応じてトリガーされる クリックします。トリガー関数は、このイベントの情報を使用して そのオブジェクトを使用して、アドオンカードの作成方法や、アドオンの制御方法を決定します。 確認します。イベント オブジェクトも作成され、 homepageTrigger ユーザーが初めてアドオンを開いたとき、ユーザーが インタラクティブなウィジェットが用意されています。

イベント オブジェクトの完全な構造については、 イベント オブジェクト。 カレンダーがアドオンの代理ホストアプリである場合は、コンテキスト トリガーと ウィジェットインタラクションイベントオブジェクトには Calendar イベント オブジェクト フィールドに、カレンダー固有のクライアント情報を格納します。

カレンダーの予定を更新する

コンテキスト情報に加えて calendar.eventOpenTrigger ユーザーが開いたときに起動されます 編集する場合は、カレンダーで calendar.eventUpdateTrigger ユーザーがカレンダーの予定を更新して保存すると起動されます。このトリガーのみ ユーザーが次の編集を 1 つ以上行うと発生します。

  • 1 人以上の参加者を追加します。
  • 1 人以上の参加者を削除します。
  • 別の会議ソリューションを追加するか、別の会議ソリューションに切り替えます。

このトリガーが発生すると、 トリガー関数 calendar.eventUpdateTrigger 宣言します。この関数は、カレンダーの予定の編集前に 保存します。

calendar.eventUpdateTrigger 通常は、次のような処理に使用されます。

  • ユーザーの変更に応じてアドオンのカレンダーの予定のインターフェースを更新する カレンダーの予定に表示されます。
  • カレンダーの予定データをサードパーティ製システム(会議システムなど)と同期する Google カレンダーに接続されているシステムです。

カレンダーの予定のデータを調整するのにアドオンが必要になった場合は、 追加するには、アドオンの calendar.currentEventAccess マニフェスト フィールドを WRITE または READ_WRITE に設定します。また、 機能を使用するには、アドオンに https://www.googleapis.com/auth/calendar.addons.current.event.write scope

会議ソリューションの追加

会議ソリューション ユーザーが接続できるサードパーティ製会議オプションを Google カレンダーの予定。「 サードパーティ製会議の概要 ドキュメントに、新しいアドオンを追加する 説明しました。このタイプの UI は UI を作成する必要はない 拡張機能追加されたソリューションは、プルダウン メニューにオプションとして Google カレンダーの予定 UI を表示します。