Events

Calendar API 提供不同類型的活動資源，詳情請參閱「關於活動」。

如需本資源的方法清單，請見本頁結尾。

資源表示法

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
屬性名稱 值 說明 附註
anyoneCanAddSelf boolean 是否任何人都能邀請自己參加活動 (已淘汰)。選用設定。預設值為 False。 可寫入
attachments[] list 活動的檔案附件。

如要修改附件，supportsAttachments 要求參數應設為 true。

每項活動最多可有 25 個附件。
attachments[].fileId string 附加檔案的 ID。唯讀。

針對 Google 雲端硬碟檔案，這是 Drive API 中相應 Files 資源項目的 ID。
attachments[].fileUrl string 附件的網址連結。

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

新增附件時必填。

 可寫入
attachments[].mimeType string 附件的網際網路媒體類型 (MIME 類型)。
attachments[].title string 附件標題。
attendeesOmitted boolean 活動的代表是否省略參與者。擷取事件時，可能是因為 maxAttendee 查詢參數指定的限制所致。更新活動時，這只能用來更新參與者的回覆。選用設定。預設值為 False。 可寫入
attendees[] list 活動的參與者。如要進一步瞭解如何與其他日曆使用者安排活動，請參閱與參與者的活動指南。服務帳戶必須使用全網域授權委派功能，才能填入與會者名單。 可寫入
attendees[].additionalGuests integer 其他房客人數。選用設定。預設值為 0。 可寫入
attendees[].comment string 參與者的回覆留言。選填。 可寫入
attendees[].displayName string 出席者的姓名 (如有)。選填。 可寫入
attendees[].email string 參與者的電子郵件地址 (如有)。新增與會者時，必須提供這個欄位。請務必提供符合 RFC5322 規定的有效電子郵件地址。

新增與會者時必須填寫此欄位。

 可寫入
attendees[].id string 參與者的個人資料 ID (如有)。
attendees[].optional boolean 此人是否為自由參加。選用設定。預設值為 False。 可寫入
attendees[].organizer boolean 參加者是否為活動發起人。唯讀。預設值為 False。
attendees[].resource boolean 與會者是否為資源。只有在與會者首次加入活動時才能設定。系統會忽略後續的修改。選用設定。預設值為 False。 可寫入
attendees[].responseStatus string 參與者的回覆狀態。可能的值包括：
  • 「needsAction」- 參與者尚未回覆邀請 (建議參加新活動)。
  • 「declined」- 與會者已拒絕邀請。
  • 「tentative」- 與會者目前已接受邀請。
  • 「accepted」- 與會者已接受邀請。
 可寫入
attendees[].self boolean 此項目代表此活動副本出現在哪個日曆。唯讀。預設值為 False。
colorId string 事件的顏色。這個 ID 是指顏色定義的 event 部分中的項目 (請參閱顏色端點)。選填。 可寫入
conferenceData nested object 會議相關資訊，例如 Google Meet 會議的詳細資料。如要建立新的會議詳細資料，請使用「createRequest」欄位。如要保留變更，請記得將所有事件修改要求的 conferenceDataVersion 要求參數設為 1。 可寫入
conferenceData.conferenceId string 會議的 ID。

僅供開發人員用於追蹤會議，請勿向使用者顯示。

每種會議解決方案類型的 ID 值格式不同：

  • eventHangout：未設定 ID。(這個會議類型已淘汰)。
  • eventNamedHangout：ID 是 Hangouts 的名稱。(這個會議類型已淘汰)。
  • hangoutsMeet：ID 是 10 個字母的會議代碼，例如 aaa-bbbb-ccc。
  • addOn：ID 由第三方供應商定義。
選用。
conferenceData.conferenceSolution nested object 提供會議解決方案，例如 Google Meet。

為含有失敗建立要求的會議取消設定。

必須提供 conferenceSolution 和至少一個 entryPoint，或 createRequest。
conferenceData.conferenceSolution.iconUri string 這項解決方案的使用者可見圖示。
conferenceData.conferenceSolution.key nested object 可用於識別這場活動會議解決方案的專屬金鑰。
conferenceData.conferenceSolution.key.type string 會議解決方案類型。

如果用戶端遇到不熟悉或空白的類型，就仍能顯示進入點。但應禁止修改。

可能的值包括：

  • 適用於 Hangouts 消費者的 "eventHangout" (已淘汰；現有活動可能會顯示這個會議解決方案類型，但無法建立新會議)
  • 適用於 Google Workspace 使用者的傳統版 Hangouts："eventNamedHangout" (已淘汰，現有活動可能會顯示這個會議解決方案類型，但無法建立新會議)
  • "hangoutsMeet" for Google Meet (http://meet.google.com)
  • "addOn"：第三方會議供應商
conferenceData.conferenceSolution.name string 這項解決方案的使用者可見名稱。未進行本地化。
conferenceData.createRequest nested object 生成新會議並附加至活動的要求。資料是以非同步方式產生。如要確認資料是否存在，請檢查 status 欄位。

必須提供 conferenceSolution 和至少一個 entryPoint，或 createRequest。
conferenceData.createRequest.conferenceSolutionKey nested object 提供會議解決方案，例如 Hangouts 或 Google Meet。
conferenceData.createRequest.conferenceSolutionKey.type string 會議解決方案類型。

如果用戶端遇到不熟悉或空白的類型，就仍能顯示進入點。但應禁止修改。

可能的值包括：

  • 適用於 Hangouts 消費者的 "eventHangout" (已淘汰；現有活動可能會顯示這個會議解決方案類型，但無法建立新會議)
  • 適用於 Google Workspace 使用者的傳統版 Hangouts："eventNamedHangout" (已淘汰，現有活動可能會顯示這個會議解決方案類型，但無法建立新會議)
  • "hangoutsMeet" for Google Meet (http://meet.google.com)
  • "addOn" 適用於第三方會議服務供應商
conferenceData.createRequest.requestId string 用戶端為這個要求產生的專屬 ID。

用戶端應為每個新的要求重新產生此 ID。如果提供的 ID 與先前要求中的 ID 相同，系統就會忽略該要求。
conferenceData.createRequest.status nested object 會議建立要求的狀態。
conferenceData.createRequest.status.statusCode string 會議建立要求的目前狀態。唯讀。

可能的值包括：

  • "pending"：系統仍在處理會議建立要求。
  • "success"：會議建立要求已成功，已填入進入點。
  • "failure"：會議建立要求失敗，沒有任何進入點。
conferenceData.entryPoints[] list 個別會議進入點的相關資訊，例如網址或電話號碼。

這些使用者都必須屬於同一場會議。

必須提供 conferenceSolution 和至少一個 entryPoint，或 createRequest。
conferenceData.entryPoints[].accessCode string 會議的存取碼。長度上限為 128 個半形字元。

建立新會議資料時，請只填入與會議服務供應商所用術語相符的 {meetingCode、accessCode、passcode、password、pin} 欄位。系統只會顯示填入的欄位。

選填。
conferenceData.entryPoints[].entryPointType string 會議進入點的類型，

可能的值為：

  • "video" - 透過 HTTP 加入會議。會議可以有零個或一個 video 進入點。
  • "phone" - 撥打電話號碼加入會議。一場會議可以有零或多個 phone 進入點。
  • "sip" - 透過 SIP 加入會議。一場會議可以有零或一個 sip 進入點。
  • "more" - 進一步加入會議的操作說明，例如其他電話號碼。一場會議可以有零或一個 more 進入點。僅具有 more 進入點的會議不是有效的會議。
conferenceData.entryPoints[].label string URI 的標籤。向使用者顯示。未進行本地化。長度上限為 512 個半形字元。

範例：

  • video：meet.google.com/aaa-bbbb-ccc
  • phone：+1 123 268 2601
  • sip：12345678@altostrat.com
  • more：不應填寫

選填。
conferenceData.entryPoints[].meetingCode string 存取會議的會議代碼。長度上限為 128 個半形字元。

建立新會議資料時，請只填入與會議服務供應商所用術語相符的 {meetingCode、accessCode、passcode、password、pin} 欄位。系統只會顯示填入的欄位。

選填。
conferenceData.entryPoints[].passcode string 會議存取密碼。長度上限為 128 個半形字元。

建立新會議資料時，請只填入與會議服務供應商所用術語相符的 {meetingCode、accessCode、passcode、password、pin} 欄位。系統只會顯示填入的欄位。
conferenceData.entryPoints[].password string 會議存取密碼。長度上限為 128 個半形字元。

建立新會議資料時，請只填入與會議服務供應商所用術語相符的 {meetingCode、accessCode、passcode、password、pin} 欄位。系統只會顯示填入的欄位。

選填。
conferenceData.entryPoints[].pin string 存取會議的 PIN 碼。長度上限為 128 個半形字元。

建立新會議資料時，請只填入與會議服務供應商所用術語相符的 {meetingCode、accessCode、passcode、password、pin} 欄位。系統只會顯示填入的欄位。

選填。
conferenceData.entryPoints[].uri string 進入點的 URI。長度上限為 1300 個半形字元。

格式：

  • video、http: 或 https: 結構定義為必填欄位。
  • phone 的結構定義為 tel: 結構定義。URI 應包含完整的撥號序列 (例如 tel:+12345678900、,123456789;1234)。
  • 如果是 sip，則須使用 sip: 結構定義，例如 sip:12345678@myprovider.com。
  • more、http: 或 https: 結構定義為必填欄位。
conferenceData.notes string 要向使用者顯示的其他附註 (例如網域管理員的指示、法律聲明)。可包含 HTML。長度上限為 2048 個半形字元。選填。
conferenceData.signature string 會議資料的簽名。

在伺服器端產生。

為含有失敗建立要求的會議取消設定。

如果會議有待處理的建立要求，則為選用項目。
created datetime 事件的建立時間 (以 RFC3339 時間戳記表示)。唯讀。
creator object 活動的建立者。唯讀。
creator.displayName string 創作者的姓名 (如有)。
creator.email string 創作者的電子郵件地址 (如有)。
creator.id string 創作者的個人資料 ID (如有)。
creator.self boolean 建立者是否與活動副本出現的日曆對應。唯讀。預設值為 False。
description string 活動的說明。可包含 HTML。選填。 可寫入
end nested object 活動的結束時間 (不包含在內)。如果是週期性活動，則這是指第一個活動的結束時間。
end.date date 如果這是全天活動，請採用「yyyy-mm-dd」格式的日期。 可寫入
end.dateTime datetime 採用合併的日期時間值 (根據 RFC3339 格式) 表示的時間。除非在 timeZone 中明確指定時區，否則必須使用時區偏移。 可寫入
end.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「歐洲/蘇黎世」)。如果是週期性活動，則此為必要欄位，用於指定重複期間展開的時區。如果是單一活動，此為選填欄位，用來表示活動開始/結束的自訂時區。 可寫入
endTimeUnspecified boolean 是否實際上未指定結束時間。即使這項屬性設為 True，系統仍會基於相容性因素提供結束時間。預設值為 False。
etag etag 資源的 ETag。
eventType string 特定事件類型。活動建立後就無法修改。可能的值包括：
  • 「birthday」- 一場特別的全天活動，提供每年的週期性活動。
  • 「default」- 一般活動，或未指定進一步的活動。
  • 「focusTime」- 專注時間活動。
  • 「fromGmail」：Gmail 中的活動。無法建立這類事件。
  • 「outOfOffice」- 不在辦公室的活動。
  • 「workingLocation」- 工作地點事件。
 可寫入
extendedProperties object 事件的延伸屬性。
extendedProperties.private object 此日曆上顯示的活動副本專屬的私人屬性。 可寫入
extendedProperties.private.(key) string 私有屬性的名稱和對應值。
extendedProperties.shared object 其他參與者的活動副本共用的屬性日曆。 可寫入
extendedProperties.shared.(key) string 共用屬性的名稱和對應值。
focusTimeProperties nested object 專注時間事件資料。當 eventType 為 focusTime 時使用。 可寫入
focusTimeProperties.autoDeclineMode string 是否拒絕與專注時間活動重疊的會議邀請。有效值包括 declineNone (代表不會拒絕任何會議邀請)、declineAllConflictingInvitations (代表會拒絕所有與活動衝突的會議邀請) 和 declineOnlyNewConflictingInvitations (代表只會拒絕在專注時間活動期間收到的新會議邀請)。
focusTimeProperties.chatStatus string 在 Chat 和相關產品中標記使用者的狀態。可以是 available 或 doNotDisturb。
focusTimeProperties.declineMessage string Google 日曆自動拒絕現有活動或新邀請時要設定的回應訊息。
gadget object 延伸這項活動的小工具。小工具已淘汰；這個結構只是用來傳回生日日曆中繼資料。
gadget.display string 小工具的顯示模式。已淘汰，可能的值包括：
  • 「icon」：在日曆檢視畫面中，小工具會顯示在活動標題旁邊。
  • 「chip」- 使用者點選活動時會顯示小工具。
 可寫入
gadget.height integer 小工具的高度 (像素)。高度必須是大於 0 的整數。選用設定。已淘汰。 可寫入
gadget.preferences object 。 可寫入
gadget.preferences.(key) string 偏好設定名稱和對應值。
gadget.title string 小工具的標題。已淘汰。 可寫入
gadget.type string 小工具的類型。已淘汰。 可寫入
gadget.width integer 小工具的寬度 (單位為像素)。寬度必須是大於 0 的整數。選用設定。已淘汰。 可寫入
guestsCanInviteOthers boolean 主辦單位以外的參與者是否能邀請其他人參加活動。選用設定。預設值為 True。 可寫入
guestsCanModify boolean 主辦單位以外的與會者能否修改活動。選用設定。預設值為 False。 可寫入
guestsCanSeeOtherGuests boolean 主辦人以外的與會者是否能查看活動的參與者。選用設定。預設值為 True。 可寫入
iCalUID string RFC5545 中定義的事件專屬 ID。可用於識別跨日曆系統的事件，且在透過 import 方法匯入事件時必須提供。

請注意，iCalUID 和 id 並不相同，且只須在建立事件時提供其中一個項目。兩者的語意差異之一，就是在週期性事件中，所有出現一個事件的 id 都不同，而所有事件都共用相同的 iCalUID。如要使用 iCalUID 擷取事件，請使用 iCalUID 參數呼叫 events.list 方法。如要使用 id 擷取事件，請呼叫 events.get 方法。
id string 事件的不透明 ID。建立新的單一或週期性活動時，您可以指定活動 ID。提供的 ID 必須遵循以下規則：
  • ID 中允許使用的字元是 base32hex 編碼中使用的字元，也就是小寫字母 a 到 v 和數字 0 到 9，請參閱 RFC2938 中的第 3.1.2 節。
  • ID 長度必須介於 5 至 1,024 個半形字元之間
  • 每個日曆的 ID 不得重複
由於這套系統遍布全球，我們無法保證能在活動建立時偵測到 ID 衝突。為了盡可能降低衝突的風險，建議您使用現成的 UUID 演算法，如 RFC4122 中所述。

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

請注意，icalUID 和 id 並不相同，且只須在建立事件時提供其中一個項目。兩者的語意差異之一，就是在週期性事件中，所有出現一個事件的 id 都不同，而所有事件都共用相同的 icalUID。

 可寫入
kind string 資源類型 (「calendar#event」)。
location string 活動的地理位置，以任意形式顯示。選填。 可寫入
locked boolean 是否為已鎖定的活動副本，無法變更主要活動欄位「摘要」、「說明」、「地點」、「開始時間」、「結束時間」或「週期性」的值。預設值為 False。唯讀。
organizer object 活動發起人。如果主辦人也是與會者，attendees 中會有個別的項目，且 organizer 欄位會設為 True。如要變更主辦人，請使用「move」運算子。唯讀，但匯入事件時除外。 可寫入
organizer.displayName string 發起人的姓名 (如有)。 可寫入
organizer.email string 發起人的電子郵件地址 (如有)。請務必提供符合 RFC5322 規定的有效電子郵件地址。 可寫入
organizer.id string 發起人的個人資料 ID (如有)。
organizer.self boolean 發起人是否與活動副本出現在哪個日曆上。唯讀。預設值為 False。
originalStartTime nested object 以週期性活動來說，這是指根據週期性活動 ID 識別的週期性事件中，這個事件的開始時間。它可明確識別週期性活動系列中的例項，即使執行個體移動到不同的時間也一樣。不可變更。
originalStartTime.date date 如果這是全天活動，請採用「yyyy-mm-dd」格式的日期。 可寫入
originalStartTime.dateTime datetime 採用合併的日期時間值 (根據 RFC3339 格式) 表示的時間。除非在 timeZone 中明確指定時區，否則必須使用時區偏移。 可寫入
originalStartTime.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「歐洲/蘇黎世」)。如果是週期性活動，則此為必要欄位，用於指定重複期間展開的時區。如果是單一活動，此為選填欄位，用來表示活動開始/結束的自訂時區。 可寫入
outOfOfficeProperties nested object 不在辦公室的事件資料。如果 eventType 為 outOfOffice，則會使用此屬性。 可寫入
outOfOfficeProperties.autoDeclineMode string 是否拒絕與不在辦公室活動重疊的會議邀請。有效值為 declineNone，表示未拒絕任何會議邀請；declineAllConflictingInvitations，表示所有與活動衝突的會議邀請都會遭到拒絕；和 declineOnlyNewConflictingInvitations，也就是說，只有「不在辦公室」活動時送達的新會議邀請遭到拒絕。
outOfOfficeProperties.declineMessage string Google 日曆自動拒絕現有活動或新邀請時要設定的回應訊息。
privateCopy boolean 如果設為 True，系統就會停用事件傳播功能。請注意，這個動作與私人事件屬性不同。選用設定。不可變動。預設值為 False。
recurrence[] list 週期性事件的 RRULE、EXRULE、RDATE 和 EXDATE 行清單，如 RFC5545 所指定。請注意，這個欄位不允許使用 DTSTART 和 DTEND 行；事件的開始與結束時間是在 start 和 end 欄位中指定。單一活動或週期性活動例項時，系統會略過這個欄位。 可寫入
recurringEventId string 如果是週期性活動，這是指此執行個體所屬的週期性事件的 id。不可變更。
reminders object 已驗證使用者的活動提醒資訊。請注意，變更提醒並不會同時變更相關活動的 updated 屬性。
reminders.overrides[] list 如果活動未使用預設提醒，這裡會列出該活動專屬的提醒；如未設定，則表示尚未設定任何提醒。覆寫提醒次數上限為 5 次。 可寫入
reminders.overrides[].method string 這項提醒使用的方法。可能的值包括：
  • 「email」- 系統會透過電子郵件傳送提醒。
  • 「popup」- 系統會透過使用者介面彈出式視窗傳送提醒。

新增提醒時必填。

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

新增提醒時為必填。

 可寫入
reminders.useDefault boolean 是否要將日曆的預設提醒套用至活動。 可寫入
sequence integer 其序號。 可寫入
source object 建立事件的來源。例如網頁、電子郵件，或任何透過 HTTP 或 HTTPS 配置識別網址的文件。只能由活動建立者查看或修改。
source.title string 來源的標題，例如網頁標題或電子郵件主旨。 可寫入
source.url string 指向資源的來源網址。網址架構必須是 HTTP 或 HTTPS。 可寫入
start nested object 事件的開始時間 (含首尾)。如果是週期性活動，這是指第一個例項的開始時間。
start.date date 如果這是全天活動，請採用「yyyy-mm-dd」格式的日期。 可寫入
start.dateTime datetime 採用合併的日期時間值 (根據 RFC3339 格式) 表示的時間。除非在 timeZone 中明確指定時區，否則必須使用時區偏移。 可寫入
start.timeZone string 指定時間的時區。(格式為 IANA 時區資料庫名稱，例如「歐洲/蘇黎世」)。如果是週期性活動，則此為必要欄位，用於指定重複期間展開的時區。如果是單一活動，此為選填欄位，用來表示活動開始/結束的自訂時區。 可寫入
status string 事件的狀態。選用設定。可能的值包括：
  • 「confirmed」- 已確認活動。此為預設狀態。
  • 「tentative」- 活動暫定已確認。
  • 「cancelled」- 活動已取消 (已刪除)。只有在指定 syncToken 或 updatedMin 或 showDeleted 旗標設為 true 時，list 方法才會傳回取消的事件。get 方法一律會傳回這些結果。

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

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

      如果例外狀況遭取消，id、recurringEventId 和 originalStartTime 欄位的值才一定會填入值。其他欄位可能會空白。

    2. 而所有其他取消的活動則代表已刪除的活動。用戶端應移除已在本機同步處理的副本。這些取消的活動最終會消失，因此請勿持續使用。

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

    在發起人日曆中，已取消的活動會持續顯示活動詳細資料 (摘要、地點等)，方便您還原 (取消刪除)。同樣地，使用者受邀和手動移除的活動仍會提供詳細資料。不過，將 showDeleted 設為 false 的漸進式同步處理要求不會傳回這些詳細資料。

    如果活動有變更主辦方 (例如透過移動作業)，但原始發起人不在參與者清單中，系統會將已取消的活動留在已取消的活動後方，活動只能填入 id 欄位。

 可寫入
summary string 活動名稱。 可寫入
transparency string 活動是否會在日曆上阻擋時間。選用設定。可能的值包括：
  • 「opaque」- 預設值。這個活動確實會在日曆上封鎖時段。等同於在日曆 UI 中將「我的顯示狀態」設為「忙碌」。
  • 「transparent」- 活動不會在日曆上浪費時間。這相當於在 Google 日曆使用者介面中將「顯示我為」設為「有空」。
 可寫入
updated datetime 主要事件資料的上次修改時間 (以 RFC3339 時間戳記為準)。更新活動提醒不會造成這項變更。唯讀。
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 在 Google 日曆網頁版和行動版用戶端顯示的辦公室名稱。建議您參照機構「資源」資料庫中的建築物名稱。 可寫入
workingLocationProperties.type string 工作地點的類型。可能的值包括：
  • 「homeOffice」- 使用者在家工作。
  • 「officeLocation」- 使用者在辦公室工作。
  • 「customLocation」- 使用者從自訂位置工作。
任何詳細資料皆會在指定名稱的子欄位中指明，但如果留空，這個欄位可能會留空。系統會忽略任何其他欄位。

新增工作地點屬性時為必填。

 可寫入

方法

刪除
刪除活動。
取得
根據活動的 Google 日曆 ID 傳回活動。如要使用 i 行事曆 ID 擷取事件，請使用 iCalUID 參數呼叫 event.list 方法。
import
匯入活動。這項作業可用於在日曆中新增現有活動的私人副本。只能匯入 eventType 為 default 的事件。

已淘汰的行為：匯入非 default 事件時，其類型會變更為 default，任何事件類型專屬屬性都會遭到捨棄。

插入
建立活動。
instances
傳回指定週期性事件的例項。
list
傳回特定日曆中的活動。
移動
將活動移至其他日曆，例如變更活動主辦者。請注意，只能移動 default 個事件。無法移動 birthday、focusTime、fromGmail、outOfOffice 和 workingLocation 事件。
修補程式
更新活動。這個方法支援 patch 語意。請注意，每個修補要求都會耗用三個配額單位；偏好使用 get，後面加上 update。您指定的欄位值會取代現有的值。未指定要求中的欄位會維持不變。陣列欄位 (如有指定) 會覆寫現有陣列；就會捨棄先前的所有陣列元素。
quickAdd
根據簡單的文字字串建立事件。
更新
更新活動。這個方法不支援修補語意，且一律會更新整個事件資源。如要進行部分更新，請執行 get，然後使用 Etag 執行 update，以確保不可部分完成。
手錶
留意「活動」資源的異動。