日曆資訊清單資源

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

日曆

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 scope

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

eventOpenTrigger

object (EventOpenTrigger)

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

eventUpdateTrigger

object (EventUpdateTrigger)

必須提供相關內容,才能在 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 日曆活動時,會觸發的內容觸發條件設定。詳情請參閱「擴充日曆活動介面」。

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

必填。這個文字會顯示在日曆下拉式選單中,用於識別這個附件提供者。