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 是环聊的名称。(此会议类型已弃用。)
  • hangoutsMeet:ID 是 10 个字母的会议代码,例如 aaa-bbbb-ccc
  • addOn:ID 由第三方提供商定义。
可选。

conferenceData.conferenceSolution nested object 会议解决方案,例如 Google Meet。

为创建请求失败的会议取消设置。

必须提供 conferenceSolution 以及至少一个 entryPointcreateRequest

conferenceData.conferenceSolution.iconUri string 此解决方案的用户可见图标。
conferenceData.conferenceSolution.key nested object 可唯一标识此活动的会议解决方案的密钥。
conferenceData.conferenceSolution.key.type string 会议解决方案类型。

如果客户端遇到陌生类型或空类型,它应该仍能够显示入口点。但是,系统应禁止修改。

可能的值包括:

  • 适用于个人用户版 Hangouts 的 "eventHangout"(已弃用;现有活动可能会显示此会议解决方案类型,但无法创建新的会议)
  • 适用于 Google Workspace 传统版 Hangouts 用户的 "eventNamedHangout"(已弃用;现有活动可能显示此会议解决方案类型,但无法创建新的会议)
  • "hangoutsMeet"(适用于 Google Meet (http://meet.google.com))
  • "addOn"(适用于第三方会议服务提供商)

conferenceData.conferenceSolution.name string 此解决方案的用户可见名称。未本地化。
conferenceData.createRequest nested object 请求生成新会议并将其附加到活动。这些数据是异步生成的。如需查看数据是否存在,请检查 status 字段。

必须提供 conferenceSolution 以及至少一个 entryPointcreateRequest

conferenceData.createRequest.conferenceSolutionKey nested object 会议解决方案,例如 Hangouts 或 Google Meet。
conferenceData.createRequest.conferenceSolutionKey.type string 会议解决方案类型。

如果客户端遇到陌生类型或空类型,它应该仍能够显示入口点。但是,系统应禁止修改。

可能的值包括:

  • 适用于个人用户版 Hangouts 的 "eventHangout"(已弃用;现有活动可能会显示此会议解决方案类型,但无法创建新的会议)
  • 适用于 Google Workspace 传统版 Hangouts 用户的 "eventNamedHangout"(已弃用;现有活动可能显示此会议解决方案类型,但无法创建新的会议)
  • "hangoutsMeet"(适用于 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 以及至少一个 entryPointcreateRequest

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 个字符。

格式:

  • 必须提供对于 videohttp:https: 架构。
  • 对于 phone,必须提供 tel: 架构。URI 应包含完整的拨号序列(例如 tel:+12345678900,,123456789;1234)。
  • 对于 sip,必须提供 sip: 架构,例如 sip:12345678@myprovider.com。
  • 必须提供对于 morehttp: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 事件的具体类型。活动创建后,此字段将无法修改。可能的值有:
  • default”- 常规事件,或未进一步指定。
  • outOfOffice”- 不在办公室的活动。
  • focusTime”- 专注时间活动。
  • workingLocation”- 工作地点事件。
可写入
extendedProperties object 事件的扩展属性。
extendedProperties.private object 仅对此日历上显示的活动副本有效的属性。 可写入
extendedProperties.private.(key) string 私有属性的名称及其对应的值。
extendedProperties.shared object 在其他参加者的日历上的活动副本之间共享的属性。 可写入
extendedProperties.shared.(key) string 共享属性的名称及对应的值。
focusTimeProperties nested object 专注时间事件数据。如果 eventTypefocusTime,使用此属性。 可写入
focusTimeProperties.autoDeclineMode string 是否拒绝与专注时间活动重叠的会议邀请。有效值为 declineNone(表示所有会议邀请均被拒绝);declineAllConflictingInvitations(表示与活动冲突的所有冲突会议邀请都会被拒绝);declineOnlyNewConflictingInvitations(表示只有专注时间活动期间到达的新冲突会议邀请会被拒绝)。
focusTimeProperties.chatStatus string 在 Chat 及相关产品中标记用户的状态。可为 availabledoNotDisturb
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 中定义的事件唯一标识符。该属性用于跨日历系统唯一标识活动,并且必须在通过 import 方法导入事件时提供。

请注意,iCalUIDid 不完全相同,在创建事件时应仅提供其中一个。它们在语义上的一个区别是,在周期性事件中,一个事件的所有出现都具有不同的 id,而它们都具有相同的 iCalUID。如需使用事件的 iCalUID 检索事件,请使用 iCalUID 参数调用 events.list 方法。要使用事件的 id 检索事件,请调用 events.get 方法。

id string 事件的不透明标识符。在创建新的单次活动或周期性活动时,您可以指定其 ID。提供的 ID 必须遵循以下规则:
  • ID 中允许使用的字符是指采用 base32 十六进制编码的字符,即小写字母 a-v 和数字 0-9,请参阅 RFC2938 中的第 3.1.2 节
  • ID 的长度必须介于 5 到 1024 个字符之间
  • 每个日历的 ID 必须是唯一的
由于该系统的全球分布式特性,我们无法保证在创建事件时可以检测到 ID 冲突。为了最大限度地降低发生冲突的风险,我们建议您使用已建立的 UUID 算法,例如 RFC4122 中所述的算法。

如果您未指定 ID,服务器将自动生成 ID。

请注意,icalUIDid 不完全相同,在创建事件时应仅提供其中一个。它们在语义上的一个区别是,在周期性事件中,一个事件的所有出现都具有不同的 id,而它们都具有相同的 icalUID

可写入
kind string 资源的类型(“calendar#event”)。
location string 活动的地理位置,以自由格式文本表示。可选。 可写入
locked boolean 指明这是锁定的活动副本,无法对主要活动字段“摘要”“说明”“位置”“开始”“结束”或“重复周期”进行任何更改。默认值为 False。只读。
organizer object 活动的组织者。如果组织者同时也是参加者,则会在 attendees 中通过一个单独的条目来指示这种情况,并将 organizer 字段设置为 True。如需更改组织者,请使用移动操作。只读(导入事件时除外)。 可写入
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 不在办公室的活动数据。如果 eventTypeoutOfOffice,使用此属性。 可写入
outOfOfficeProperties.autoDeclineMode string 是否拒绝与“不在办公室”活动重叠的会议邀请。有效值为 declineNone(表示所有会议邀请均被拒绝);declineAllConflictingInvitations(表示与活动冲突的所有冲突会议邀请都会被拒绝);declineOnlyNewConflictingInvitations(表示只有在“不在办公室”活动期间收到的新冲突会议邀请)才会被拒绝。
outOfOfficeProperties.declineMessage string 用于设置 Google 日历是否自动拒绝现有活动或新邀请的响应消息。
privateCopy boolean 如果此政策设为 True,系统会停用事件传播。请注意,它与私人活动媒体资源不同。可选。不可变。默认值为 False。
recurrence[] list RFC5545 中指定的周期性事件的 RRULE、EXRULE、RDATE 和 EXDATE 行列表。请注意,此字段中不允许使用 DTSTART 和 DTEND 行,而要在 startend 字段中指定事件的开始时间和结束时间。单个活动或周期性活动实例将省略此字段。 可写入
recurringEventId string 对于周期性活动的实例,这是此实例所属周期性事件的 id。固定不变。
reminders object 向经过身份验证的用户发送的活动提醒相关信息。
reminders.overrides[] list 如果活动未使用默认提醒,则会列出专门针对该活动的提醒;如果未设置提醒,则表示没有为此活动设置提醒。替换提醒数量上限为 5 个。 可写入
reminders.overrides[].method string 此提醒使用的方法。可能的值有:
  • email”- 提醒通过电子邮件发送。
  • popup”- 通过界面弹出式窗口发送提醒。

添加提醒时必填。

可写入
reminders.overrides[].minutes integer 活动开始前多少分钟,提醒应触发。有效值介于 0 到 40320 之间(即 4 周,以分钟为单位)。

添加提醒时必填。

可写入
reminders.useDefault boolean 日历的默认提醒是否适用于活动。 可写入
sequence integer iCalendar 中的序列号。 可写入
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”- 活动已取消(已删除)。只有在执行增量同步时(指定 syncTokenupdatedMin 时)或 showDeleted 标志设置为 true 时,list 方法才会返回已取消的事件。get 方法始终会返回这些属性。

    “已取消”状态表示两种不同的状态,具体取决于事件类型:

    1. 已取消取消的周期性活动的异常表示不应再向用户显示此实例。客户端应在父级周期性事件的生命周期内存储这些事件。

      对于已取消的异常,系统只会保证填充 idrecurringEventIdoriginalStartTime 字段的值。其他字段可能为空。

    2. 所有其他已取消的活动均表示已删除的活动。客户端应移除其本地同步的副本。此类取消的事件最终会消失,因此请不要指望它们无限期可用。

      对于已删除的活动,只能保证填充 id 字段。

    。在组织者的日历中,已取消的活动会继续显示活动详细信息(摘要、地点等),以便您恢复(取消删除)这些活动。同样,用户受邀参与但用户手动移除的活动仍会提供详细信息。但是,showDeleted 设置为 false 的增量同步请求不会返回这些详细信息。

    如果某个活动更改了组织者(例如通过移动操作),而原组织者不在参加者列表中,则该活动留下已取消的活动,而系统保证只填充 id 字段。

可写入
summary string 活动的标题。 可写入
transparency string 活动是否会在日历上占用时间。可选。可能的值有:
  • opaque”- 默认值。此活动会占用日历上的时间。效果相当于在 Google 日历界面中将状态显示为设置为忙碌
  • transparent”- 此活动不会阻止日历上的时间。这相当于在日历界面中将显示为设置为有空
可写入
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。 可写入
workingLocationProperties.officeLocation.deskId string 可选的桌面标识符。 可写入
workingLocationProperties.officeLocation.floorId string 可选的楼层标识符。 可写入
workingLocationProperties.officeLocation.floorSectionId string 可选的楼层分区标识符。 可写入
workingLocationProperties.officeLocation.label string 在 Google 日历网页版和移动客户端中显示的 Office 名称。我们建议您在组织的资源数据库中引用建筑物名称。 可写入
workingLocationProperties.type string 工作地点类型。可能的值有:
  • homeOffice”- 用户在家工作。
  • officeLocation”- 用户在办公室工作。
  • customLocation”- 用户正在自定义位置工作。
。所有详细信息均在指定名称的子字段中指定,但如果为空,此字段可能会缺失。所有其他字段均会被忽略。

添加工作地点属性时必填。

可写入

方法

删除
删除活动。
get
根据活动的 Google 日历 ID 返回活动。如要使用 iCalendar ID 检索活动,请使用 iCalUID 参数调用 events.list 方法
import
导入事件。此操作用于将现有活动的不公开副本添加到日历。只能导入 eventTypedefault 的事件。

已弃用的行为:如果导入了非 default 事件,其类型将更改为 default,并且它可能具有的任何事件类型特定属性都将被丢弃。

insert
创建事件。
实例
返回指定周期性活动的实例。
list
返回指定日历上的活动。
移动
将活动移至其他日历,例如更改活动的组织者。请注意,只能移动 default 事件;无法移动 outOfOfficefocusTimeworkingLocation 事件。
patch
更新活动。此方法支持补丁语义。请注意,每个补丁请求使用三个配额单元;建议您先使用 get,然后再使用 update。您指定的字段值会替换现有值。您未在请求中指定的字段保持不变。数组字段(如果指定)会覆盖现有数组;这会舍弃之前的所有数组元素。
quickAdd
根据简单的文本字符串创建事件。
update
更新活动。此方法不支持补丁语义,并且会始终更新整个事件资源。如需执行部分更新,请使用 etag 执行 get,后跟 update,以确保原子性。
观看
留意活动资源的更改。