日曆資訊清單資源

用來在 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 日曆中提供情境事件更新介面,此為必要項目。Google 日曆中事件更新觸發條件的觸發事件規格。

eventAttachmentTrigger

object (EventAttachmentTrigger)

Google 日曆中事件附件觸發條件的觸發規格。

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 日曆活動時觸發。詳情請參閱「擴充 Google 日曆活動介面」。

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

string

在使用者開啟要查看或編輯日曆活動時,系統執行的 Apps Script 函式名稱。指定此函式後,您必須實作此函式來建構並傳回 Card 物件陣列,以供外掛程式使用者介面顯示。

EventUpdateTrigger

使用者編輯並儲存 Google 日曆活動時,比對內容觸發條件的設定。詳情請參閱「更新日曆活動」。

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

string

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

EventAttachmentTrigger

當使用者在「日曆」下拉式選單中點選外掛程式連結提供者時,內容相關觸發條件的設定。

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

string

必要。當使用者在「Google 日曆」下拉式選單中選取外掛程式連結提供者時,系統會執行的 Apps Script 函式名稱。您必須實作此函式,才能建構並傳回 Card 物件陣列,以便顯示在外掛程式使用者介面中。
label

string

必要。「日曆」下拉式選單中會顯示的文字,用以識別這個附件提供者。