日曆資訊清單資源

用來在 Google 日曆中定義 Google Workspace 外掛程式內容和行為的資源設定。如果 Google Workspace 外掛程式資訊清單擴充了 Google 日曆,則必須包含所有標示為「必要」的元件。

日曆

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

只有在外掛程式提供 會議解決方案時才會使用。選用設定。Apps Script 函式的名稱,用於產生外掛程式設定頁面。

詳情請參閱 新增會議通訊外掛程式設定
conferenceSolution[]

object (ConferenceSolution)

只有在外掛程式提供 會議解決方案時才會使用;如果是,請至少定義一項解決方案。外掛程式提供的會議解決方案清單。在 Google 日曆的「編輯活動」使用者介面中,每個解決方案都有對應的會議選項。
currentEventAccess

string

決定外掛程式對於使用者產生的資料事件資料的存取層級。如未提供,系統就不會將任何事件中繼資料傳遞至外掛程式。 有效的設定如下:

  • METADATA 表示外掛程式僅可存取基本事件中繼資料。
  • READ 表示外掛程式除了可以讀取基本事件中繼資料外,也可以讀取使用者產生的事件資料。
  • WRITE 表示外掛程式可以寫入使用者產生的事件資料。
  • READ_WRITE 表示外掛程式可以讀取及寫入使用者產生的事件資料,以及讀取基本中繼資料。

如果設為 READREAD_WRITE,外掛程式就必須擁有 https://www.googleapis.com/auth/calendar.addons.current.event.read 範圍

如果設為 WRITEREAD_WRITE,外掛程式就必須包含 https://www.googleapis.com/auth/calendar.addons.current.event.write 範圍

eventOpenTrigger

object (EventOpenTrigger)

Google 日曆中活動開啟觸發條件的觸發條件規格。

eventUpdateTrigger

object (EventUpdateTrigger)

如要在 Google 日曆中提供情境事件更新介面,此為必要欄位。日曆事件更新觸發條件的觸發條件規格。

eventAttachmentTrigger

object (EventAttachmentTrigger)

日曆中活動附件觸發條件的觸發條件規格。

homepageTrigger

object (HomepageTrigger)

用於在日曆主機中建立外掛程式首頁的觸發條件函式規格。這會覆寫 addOns.common.homepageTrigger

ConferenceSolution

外掛程式提供的會議解決方案設定。每個解決方案都有對應的會議選項,顯示在 Google 日曆的「編輯活動」使用者介面中。

JSON 表示法
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
欄位
id

string

必填。會議解決方案的 ID。在外掛程式提供的一系列會議解決方案中,均不得重複。 ID 一經選取即無法變更。
logoUrl

string

代表解決方案的圖示連結。圖片尺寸應調整為 96 x 96 dp。

不得為任意網址,圖片必須託管於 Google 的基礎架構。詳情請參閱 提供會議解決方案標誌

如有提供,此映像檔可能與外掛程式 calendar.logoUrl 不同,後者是用來在主應用程式擴充的主機應用程式中代表外掛程式。如未提供特定解決方案的標誌圖片,系統會改用 calendar.logoUrl
name

string

必填。使用者建立或編輯活動時,Google 日曆 UI 中顯示的會議解決方案名稱。
onCreateFunction

string

必填。Google 日曆嘗試建立這類會議時呼叫的 Apps Script 函式名稱。您必須針對外掛程式支援的每項會議解決方案 實作這個函式

EventOpenTrigger

內容相關觸發條件的設定,會在使用者開啟 Google 日曆活動時觸發。詳情請參閱擴充日曆活動介面

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

在使用者開啟要檢視或編輯的日曆活動時,運作的 Apps Script 函式名稱。如果有指定,您必須實作此函式以建構並傳回 Card 物件的陣列,以顯示在外掛程式 UI 中。

EventUpdateTrigger

內容相關觸發條件的設定,會在使用者編輯及儲存 Google 日曆活動時觸發。詳情請參閱更新日曆活動

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

使用者編輯並儲存日曆活動時執行的 Apps Script 函式名稱。如果有指定,您必須實作此函式以建構並傳回 Card 物件的陣列,以顯示在外掛程式 UI 中。

EventAttachmentTrigger

內容相關觸發條件的設定,會在使用者點選日曆下拉式選單中的外掛程式附件供應器時觸發。

JSON 表示法
{
  "runFunction": string,
  "label": string,
}
欄位
runFunction

string

必要。當使用者在日曆下拉式選單中選取外掛程式附件供應器時,系統會執行的 Apps Script 函式名稱。您必須實作此函式以建構並傳回 Card 物件的陣列,以顯示在外掛程式 UI 中。
label

string

必要。顯示在日曆下拉式選單中的文字,可用於識別該附件提供者。