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

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 カレンダーの [予定を編集] 画面に表示される、対応する会議オプションが表示されます。
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 をオーバーライドします。

カンファレンス ソリューション

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

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

必須: カレンダーのプルダウン メニューに表示されるテキスト。この添付ファイル プロバイダを識別します。