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

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 をオーバーライドします。

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

アドオンが提供する会議ソリューションの構成。各ソリューションには、Google カレンダーの [Edit Event] 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 関数の名前。アドオンが対応している会議ソリューションごとに、 この関数を実装する必要があります。

イベント OpenTrigger

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

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

string

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

イベント更新トリガー

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

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

string

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

イベント アタッチメント トリガー

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

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

string

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

string

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