日曆資訊清單資源

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

日曆

Google 日曆擴充功能的 Google Workspace 外掛程式資訊清單設定。詳情請參閱「使用 Google Workspace 外掛程式擴充 Google 日曆功能」。

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 scope

如果設為 WRITEREAD_WRITE,外掛程式必須 具備 https://www.googleapis.com/auth/calendar.addons.current.event.write scope

eventOpenTrigger

object (EventOpenTrigger)

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

eventUpdateTrigger

object (EventUpdateTrigger)

必須在 Google 日曆中提供相關活動更新介面。日曆中活動更新觸發條件的觸發條件規格。

eventAttachmentTrigger

object (EventAttachmentTrigger)

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

homepageTrigger

object (HomepageTrigger)

在 Google 日曆主機中建立外掛程式首頁的觸發函式規格。這會覆寫 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

必要。日曆下拉式選單中顯示的文字,用於識別這個附件供應商。