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

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

カレンダー

Google Workspace Google カレンダー拡張機能のアドオン マニフェスト構成。 詳しくは、アドオンによるカレンダーの拡張 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 をオーバーライドします。

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

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

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

string

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

string

ソリューションを表すアイコンへのリンク。画像のサイズは 96 x 96 dp にする必要があります。

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

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

string

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

string

必須。Google カレンダーでこのような会議を作成しようとしたときに呼び出される Apps Script 関数の名前。アドオンでサポートされているカンファレンス ソリューションごとに、この関数を実装する必要があります。

イベント オープントリガー

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

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

string

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

イベント更新トリガー

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

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

string

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

EventAttachment トリガー

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

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

string

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

string

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