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

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

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