カレンダー マニフェスト リソース

Google カレンダー内の Google Workspace アドオンのコンテンツと動作を定義するために使用されるリソース構成。Google Workspace アドオン マニフェストでカレンダーを拡張する場合は、すべてのコンポーネントに [必須] というマークを付ける必要があります。

カレンダー

Google カレンダー拡張機能の Google Workspace アドオン マニフェストの構成。詳しくは、Google Workspace アドオンによるカレンダーの拡張をご覧ください。

JSON 表現
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "eventAttachmentTrigger": {
    object (EventAttachmentTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
フィールド
createSettingsUrlFunction

string

アドオンが 会議ソリューションを提供している場合にのみ使用されます。省略可。アドオンの設定ページに移動する URL を生成する Apps Script 関数の名前。

詳細については、 会議アドオンの設定を追加するをご覧ください。
conferenceSolution[]

object (ConferenceSolution)

アドオンが 会議ソリューションを提供する場合にのみ使用されます。その場合は、少なくとも 1 つのソリューションを定義する必要があります。アドオンが提供する会議ソリューションのリスト。各ソリューションには、Google カレンダーの [予定を編集] UI に、対応する会議オプションが表示されます。
currentEventAccess

string

ユーザー作成データ イベントデータに対するアドオンのアクセスレベルを決定します。指定しない場合、イベント メタデータはアドオンに渡されません。有効な設定は次のとおりです。

  • METADATA は、アドオンが基本的なイベント メタデータにのみアクセスできることを示します。
  • READ は、アドオンが基本的なイベント メタデータに加えて、ユーザー作成のイベントデータを読み取れることを示します。
  • WRITE は、アドオンがユーザー作成のイベントデータを書き込めることを示します。
  • READ_WRITE は、アドオンがユーザー作成のイベントデータを読み書きできること、および基本的なメタデータを読み取れることを示します。

READ または READ_WRITE に設定する場合は、アドオンに https://www.googleapis.com/auth/calendar.addons.current.event.read スコープが必要です。

WRITE または READ_WRITE に設定する場合、アドオンには https://www.googleapis.com/auth/calendar.addons.current.event.write スコープが必要です。

eventOpenTrigger

object (EventOpenTrigger)

カレンダーのイベント開くトリガーのトリガー仕様。

eventUpdateTrigger

object (EventUpdateTrigger)

Google カレンダーでコンテキストに応じた予定更新インターフェースを提供するために必要です。カレンダーの予定更新トリガーのトリガー仕様。

eventAttachmentTrigger

object (EventAttachmentTrigger)

カレンダーの予定の添付トリガーのトリガー仕様。

homepageTrigger

object (HomepageTrigger)

カレンダー ホストにアドオンのホームページを作成するトリガー関数の仕様。これは addOns.common.homepageTrigger をオーバーライドします。

ConferenceSolution

アドオンで提供される会議ソリューションの構成。各ソリューションには、Google カレンダーの [予定を編集] UI に表示される対応する会議オプションがあります。

JSON 表現
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
フィールド
id

string

必須。会議ソリューションの識別子。アドオンで提供される一連の会議ソリューション内で一意である必要があります。一度選択した ID は変更しないでください。
logoUrl

string

解決策を表すアイコンへのリンク。画像のサイズは 96 x 96 dp にする必要があります。

任意の URL は使用できません。画像は Google のインフラストラクチャでホストされている必要があります。詳しくは、 会議ソリューションのロゴを提供するをご覧ください。

指定した場合、この画像は、拡張するホストアプリでアドオンを表すために使用されるアドオン calendar.logoUrl とは異なる場合があります。特定のソリューションにロゴ画像が指定されていない場合は、代わりに calendar.logoUrl が使用されます。
name

string

必須。ユーザーが予定を作成または編集するときに Google カレンダーの UI に表示される会議ソリューションの名前。
onCreateFunction

string

必須。Google カレンダーがこのタイプの会議の作成を試行するときに呼び出される Apps Script 関数の名前。アドオンがサポートする会議ソリューションごとに、 この関数を実装する必要があります。

EventOpenTrigger

ユーザーが Google カレンダーのイベントを開いたときにトリガーされるコンテキスト トリガーの設定。詳しくは、カレンダーの予定インターフェースの拡張をご覧ください。

JSON 表現
{
  "runFunction": string
}
フィールド
runFunction

string

ユーザーがカレンダーの予定を開いて表示または編集するときに実行される Apps Script 関数の名前。指定する場合は、この関数を実装して、アドオン UI に表示する Card オブジェクトの配列を作成して返す必要があります。

EventUpdateTrigger

ユーザーが Google カレンダーのイベントを編集して保存したときにトリガーされるコンテキスト トリガーの設定。詳しくは、カレンダーの予定の更新をご覧ください。

JSON 表現
{
  "runFunction": string
}
フィールド
runFunction

string

ユーザーがカレンダーの予定を編集して保存したときに実行される Apps Script 関数の名前。指定する場合は、この関数を実装して、アドオン UI に表示する Card オブジェクトの配列を作成して返す必要があります。

EventAttachmentTrigger

ユーザーがカレンダーのプルダウン メニューでアドオンの添付ファイル プロバイダをクリックしたときにトリガーされるコンテキスト トリガーの設定。

JSON 表現
{
  "runFunction": string,
  "label": string,
}
フィールド
runFunction

string

必須。ユーザーがカレンダーのプルダウン メニューでアドオンの添付ファイル プロバイダを選択したときに実行される Apps Script 関数の名前。この関数を実装して、アドオン UI に表示する Card オブジェクトの配列を作成して返す必要があります。
label

string

必須。カレンダーのプルダウン メニューに表示されるテキスト。このアタッチメント プロバイダを識別します。