Events: insert

建立事件。立即試用。

要求

HTTP 要求

POST https://www.googleapis.com/calendar/v3/calendars/calendarId/events

參數

參數名稱 值 說明
路徑參數
calendarId string 日曆 ID。如要擷取日曆 ID，請呼叫 calendarList.list 方法。如要存取目前登入使用者的主日曆，請使用「primary」關鍵字。
選用查詢參數
conferenceDataVersion integer API 用戶端支援的會議資料版本號碼。版本 0 會假設不支援會議資料，並忽略事件主體中的會議資料。版本 1 支援複製 ConferenceData，以及使用 conferenceData 的 createRequest 欄位建立新會議。預設值為 0。可接受的值介於 0 到 1 (包含這兩者) 之間。
maxAttendees integer 回應中可納入的出席者人數上限。如果出席者人數超過指定數量，系統只會傳回參與者。選用。
sendNotifications boolean 已淘汰，請改用 sendUpdates。

是否要傳送新事件建立通知。請注意，即使您將值設為 false，系統仍可能會傳送部分電子郵件。預設為 false。
sendUpdates string 是否要傳送有關建立新事件的通知。請注意，部分電子郵件可能仍會傳送。預設為 false。

可接受的值如下：
  • 「all」：通知會傳送給所有邀請對象。
  • 「externalOnly」：通知只會傳送給非 Google 日曆邀請對象。
  • 「none」：不會傳送通知。
supportsAttachments boolean 執行操作的 API 用戶端是否支援事件附件。(非必要) 預設值為 False。

授權

這項要求需要至少具備下列其中一個範圍的授權：

範圍
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

詳情請參閱「驗證與授權」頁面。

要求主體

在要求主體中，請提供具有下列屬性的 Events 資源：

屬性名稱 值 說明 附註
必要屬性
end nested object 活動的結束時間 (不包含在內)。如果是週期性事件，則是第一個例項的結束時間。
start nested object 活動的開始時間 (包含在內)。如果是週期性事件，則為第一個例項的開始時間。
選用屬性
anyoneCanAddSelf boolean 是否允許任何人將自己邀請至活動 (已淘汰)。(非必要) 預設值為 False。 可寫入
attachments[].fileUrl string 附件的網址連結。

如要新增 Google 雲端硬碟檔案附件，請使用 Drive API 中 Files 資源的 alternateLink 屬性相同的格式。

新增附件時必須提供。

 可寫入
attendees[] list 活動與會者。如要進一步瞭解如何與其他日曆使用者安排活動，請參閱「有參與者的活動」指南。服務帳戶必須使用全網域授權委派功能，才能填入與會者名單。 可寫入
attendees[].additionalGuests integer 額外房客人數。(非必要) 預設值為 0。 可寫入
attendees[].comment string 與會者的回覆註解。選填。 可寫入
attendees[].displayName string 出席者的姓名 (如有)。選填。 可寫入
attendees[].email string 與會者的電子郵件地址 (如果有的話)。新增與會者時，必須提供這個欄位。必須是有效的電子郵件地址，符合 RFC5322 規定。

新增與會者時必須提供。

 可寫入
attendees[].optional boolean 這是否為選填與會者。(非必要) 預設值為 False。 可寫入
attendees[].resource boolean 與會者是否為資源。只有在與會者首次加入活動時才能設定。系統會忽略後續的修改。(非必要) 預設值為 False。 可寫入
attendees[].responseStatus string 與會者的回覆狀態。可能的值包括：
  • 「needsAction」：參與者未回覆邀請 (建議用於新活動)。
  • 「declined」：與會者已拒絕邀請。
  • 「tentative」：與會者已暫時接受邀請。
  • 「accepted」：與會者已接受邀請。
 可寫入
birthdayProperties nested object 生日或特殊活動資料。如果 eventType 為 "birthday"，則會使用此屬性。不可變更。 可寫入
birthdayProperties.type string 生日或特殊活動類型。可能的值包括：
  • "anniversary" - 生日以外的紀念日。一律包含 contact。
  • "birthday"：生日活動。這是預設值。
  • "custom"：特殊日期，其標籤會在 customTypeName 欄位中進一步指定。一律包含 contact。
  • "other"：不屬於其他類別的特殊日期，且沒有自訂標籤。一律包含 contact。
  • "self"：日曆擁有者的生日。不得有 contact。
Calendar API 僅支援建立類型為 "birthday" 的活動。事件建立後即無法變更類型。		 可寫入
colorId string 事件的顏色。這個 ID 是指顏色定義的 event 部分中的項目 (請參閱 顏色端點)。選填。 可寫入
conferenceData nested object 會議相關資訊，例如 Google Meet 會議的詳細資料。如要建立新的會議詳細資料，請使用 createRequest 欄位。如要保留變更，請記得將所有事件修改要求的 conferenceDataVersion 要求參數設為 1。 可寫入
description string 活動的說明。可包含 HTML。選填。 可寫入
end.date date 如果是全天活動，請提供日期，格式為「yyyy-mm-dd」。 可寫入
end.dateTime datetime 時間，以結合日期和時間的值表示 (格式符合 RFC3339 標準)。除非在 timeZone 中明確指定時區，否則必須指定時區偏移量。 可寫入
end.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「Europe/Zurich」)。這個欄位適用於週期性活動，且為必填欄位，用來指定週期性活動的擴充時區。對於單一事件，這個欄位是選用的，可用於指定事件開始/結束時間的自訂時區。 可寫入
eventType string 事件的具體類型。這項設定在活動建立後即無法變更。可能的值包括：
  • 「birthday」：一年一度的特殊全天活動。
  • 「default」：一般事件或未進一步指定的事件。
  • 「focusTime」：專注時間事件。
  • 「fromGmail」：Gmail 中的活動。無法建立這類事件。
  • 「outOfOffice」- 不在辦公室的活動。
  • 「workingLocation」- 工作地點事件。
 可寫入
extendedProperties.private object 此日曆上顯示的活動副本專屬的私人屬性。 可寫入
extendedProperties.shared object 在其他參與者日曆上，活動副本之間共用的屬性。 可寫入
focusTimeProperties nested object 專注時間活動資料。如果 eventType 為 focusTime，則會使用此屬性。 可寫入
gadget.display string 小工具的顯示模式。已淘汰，可能的值包括：
  • 「icon」：在日曆檢視畫面中，小工具會顯示在活動標題旁邊。
  • 「chip」：點選事件時會顯示小工具。
 可寫入
gadget.height integer 小工具的高度 (以像素為單位)。高度必須為大於 0 的整數。(非必要) 已淘汰。 可寫入
gadget.preferences object 。 可寫入
gadget.title string 小工具的標題。已淘汰。 可寫入
gadget.type string 小工具的類型。已淘汰。 可寫入
gadget.width integer 小工具的寬度 (以像素為單位)。寬度必須為大於 0 的整數。(非必要) 已淘汰。 可寫入
guestsCanInviteOthers boolean 主辦人以外的與會者是否可以邀請其他人參加活動。(非必要) 預設值為 True。 可寫入
guestsCanModify boolean 主辦人以外的與會者是否可以修改活動。(非必要) 預設值為 False。 可寫入
guestsCanSeeOtherGuests boolean 主辦人以外的與會者是否能查看活動的與會者。(非必要) 預設值為 True。 可寫入
id string 事件的不明瞭識別碼。建立新的單次或週期性事件時，您可以指定 ID。提供的 ID 必須遵循下列規則：
  • ID 中允許使用的字元是 base32hex 編碼中使用的字元，也就是小寫字母 a 到 v 和數字 0 到 9，請參閱 RFC2938 中的第 3.1.2 節
  • ID 長度必須介於 5 至 1024 個半形字元之間
  • 每個日曆的 ID 不得重複
由於系統具有全球分散的特性，我們無法保證系統會在事件建立時偵測到 ID 衝突。為盡量降低衝突風險，建議您使用已建立的 UUID 演算法，例如 RFC4122 所述的演算法。

如果您未指定 ID，系統會自動產生 ID。

請注意，icalUID 和 id 並不相同，且在事件建立時，只應提供其中一個。這兩者在語意上的差異在於，在週期性事件中，同一個事件的所有事件都有不同的 id，但都共用相同的 icalUID。

 可寫入
location string 活動的地理位置，格式為自由格式文字。選填。 可寫入
originalStartTime.date date 如果是全天活動，請提供日期，格式為「yyyy-mm-dd」。 可寫入
originalStartTime.dateTime datetime 時間，以結合日期和時間的值表示 (格式符合 RFC3339 標準)。除非在 timeZone 中明確指定時區，否則必須指定時區偏移量。 可寫入
originalStartTime.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「Europe/Zurich」)。這個欄位適用於週期性活動，且為必填欄位，用來指定週期性活動的擴充時區。對於單一事件，這個欄位是選用的，可用於指定事件開始/結束時間的自訂時區。 可寫入
outOfOfficeProperties nested object 不在辦公室的活動資料。如果 eventType 為 outOfOffice，則會使用此屬性。 可寫入
recurrence[] list 如 RFC5545 所述，這是重複事件的 RRULE、EXRULE、RDATE 和 EXDATE 行清單。請注意，這個欄位不允許使用 DTSTART 和 DTEND 行；事件開始和結束時間已在 start 和 end 欄位中指定。對於單一事件或週期性事件的例項，則省略這個欄位。 可寫入
reminders.overrides[] list 如果活動未使用預設提醒，這裡會列出該活動專屬的提醒事項；如果未設定提醒事項，則表示系統未為此活動設定提醒事項。覆寫提醒數量上限為 5 個。 可寫入
reminders.overrides[].method string 提醒事項使用的提醒方法。可能的值包括：
  • 「email」- 系統會透過電子郵件傳送提醒。
  • 「popup」- 透過 UI 彈出式視窗傳送提醒。

新增提醒時必須提供。

 可寫入
reminders.overrides[].minutes integer 活動開始前幾分鐘，系統應觸發提醒的時間點。有效值介於 0 到 40320 (4 週以分鐘為單位) 之間。

新增提醒時必須提供。

 可寫入
reminders.useDefault boolean 日曆的預設提醒是否套用至活動。 可寫入
sequence integer 依據 iCalendar 的序號。 可寫入
source.title string 來源的標題，例如網頁標題或電子郵件主旨。 可寫入
source.url string 指向資源的來源網址。網址架構必須是 HTTP 或 HTTPS。 可寫入
start.date date 如果是全天活動，請提供日期，格式為「yyyy-mm-dd」。 可寫入
start.dateTime datetime 時間，以結合日期和時間的值表示 (格式符合 RFC3339 標準)。除非在 timeZone 中明確指定時區，否則必須指定時區偏移量。 可寫入
start.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「Europe/Zurich」)。這個欄位適用於週期性活動，且為必填欄位，用來指定週期性活動的擴充時區。對於單一事件，這個欄位是選用的，可用於指定事件開始/結束時間的自訂時區。 可寫入
status string 事件的狀態。(非必要) 可能的值包括：
  • 「confirmed」：事件已確認。這是預設狀態。
  • 「tentative」：活動已暫時確認。
  • 「cancelled」：活動已取消 (刪除)。list 方法只會在遞增式同步處理 (指定 syncToken 或 updatedMin) 或 showDeleted 標記設為 true 時傳回已取消的事件。get 方法一律會傳回這些值。

    取消狀態代表兩種不同的狀態，具體取決於事件類型：

    1. 未取消的週期性事件中，已取消的例外狀況表示這個例項不應再向使用者顯示。用戶端應在父項週期性活動的整個生命週期中儲存這些事件。

      取消的例外狀況只保證會填入 id、recurringEventId 和 originalStartTime 欄位的值。其他欄位可能會空白。

    2. 所有其他已取消的事件都代表已刪除的事件。用戶端應移除本機同步處理的副本。這類已取消的事件最終會消失，因此請勿依賴這些事件永久可用。

      系統只保證已刪除的事件會填入 id 欄位。

    在主辦人的日曆中，已取消的活動仍會顯示活動詳細資料 (摘要、地點等)，因此可以還原 (取消刪除) 活動。同樣地，使用者邀請並手動移除的活動也會繼續提供詳細資料。不過，如果 showDeleted 設為 false，增量同步處理要求就不會傳回這些詳細資料。

    如果活動變更主辦人 (例如透過移動作業)，且原始主辦人不在參與者名單中，系統會留下已取消的活動，且只會填入 id 欄位。

 可寫入
summary string 事件的名稱。 可寫入
transparency string 活動是否會在日曆上阻擋時間。(非必要) 可能的值包括：
  • 「opaque」- 預設值。活動會在日曆上顯示為已預約的時間。這相當於在 Google 日曆 UI 中將「顯示我為」設為「忙碌」。
  • 「transparent」：活動不會在日曆上阻擋時間。這相當於在 Google 日曆使用者介面中將「顯示我為」設為「有空」。
 可寫入
visibility string 事件的瀏覽權限。(非必要) 可能的值包括：
  • 「default」：使用日曆中活動的預設瀏覽權限。這是預設值。
  • 「public」：活動為公開，所有日曆讀者都能查看活動詳細資料。
  • 「private」：活動為私人活動，只有與會者才能查看活動詳細資料。
  • 「confidential」：事件為私人活動。這個值是為了相容性而提供。
 可寫入
workingLocationProperties nested object 工作地點事件資料。 可寫入
workingLocationProperties.customLocation object 如果存在，則表示使用者正在自訂位置工作。 可寫入
workingLocationProperties.customLocation.label string 額外資訊的選用額外標籤。 可寫入
workingLocationProperties.homeOffice any value 如果存在，則表示使用者在家工作。 可寫入
workingLocationProperties.officeLocation object 如果有這個值，表示使用者是在辦公室工作。 可寫入
workingLocationProperties.officeLocation.buildingId string 選用的建築物 ID。這個值應參照機構資源資料庫中的建築物 ID。 可寫入
workingLocationProperties.officeLocation.deskId string 選用的櫃檯 ID。 可寫入
workingLocationProperties.officeLocation.floorId string 選用的樓層 ID。 可寫入
workingLocationProperties.officeLocation.floorSectionId string 選用的樓層區段 ID。 可寫入
workingLocationProperties.officeLocation.label string 在網路版日曆和行動版用戶端中顯示的辦公室名稱。建議您參考機構的「資源」資料庫中的建築物名稱。 可寫入
workingLocationProperties.type string 工作地點類型。可能的值包括：
  • 「homeOffice」：使用者在家工作。
  • 「officeLocation」：使用者在辦公室工作。
  • 「customLocation」：使用者正在自訂位置工作。
所有詳細資料都會在指定名稱的子欄位中指定，但如果此欄位為空白，則可能會缺少此欄位。系統會忽略其他欄位。

新增工作地點屬性時必須使用。

 可寫入

回應

如果成功的話，這個方法會在回應內文中傳回 Events 資源。

試試看！

您可以使用下方的 API Explorer，針對即時資料呼叫這個方法，然後查看回應。