CalendarList

用户日历列表中的日历集合。另请参阅 日历与 CalendarList。

有关此类资源的方法列表，请参阅本页面的结尾部分。

资源表示法

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "dataOwner": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
属性名称 值 说明 备注
accessRole string 经过身份验证的用户对相应日历拥有的有效访问权限角色。只读。可能的值包括：
  • “freeBusyReader” - 提供对空闲/忙碌信息的读取权限。
  • “reader” - 提供对日历的读取权限。不公开活动会向具有读取权限的用户显示，但活动详情会被隐藏。
  • “writer” - 提供对日历的读写权限。具有写入权限的用户会看到不公开活动，并且可以查看活动详情。
  • “owner”：向主管提供日历访问权限。此角色拥有撰写者角色的所有权限，并且还能够查看和修改其他用户的访问权限级别。
backgroundColor string 日历的主要颜色，采用十六进制格式“#0088aa”。此属性取代了基于索引的 colorId 属性。如需设置或更改此属性，您需要在 insert、update 和 patch 方法的参数中指定 colorRgbFormat=true。可选。 可写入
colorId string 日历的颜色。这是指颜色定义 calendar 部分中的条目的 ID（请参阅颜色端点）。此属性已被 backgroundColor 和 foregroundColor 属性取代，在使用这些属性时可以忽略此属性。可选。 可写入
conferenceProperties nested object 相应日历的会议属性，例如允许的会议类型。
conferenceProperties.allowedConferenceSolutionTypes[] list 相应日历支持的会议解决方案类型。

可能的值包括：

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
可选。
dataOwner string 日历所有者的电子邮件地址。仅为辅助日历设置。只读。
defaultReminders[] list 经过身份验证的用户针对相应日历设置的默认提醒。 可写入
defaultReminders[].method string 相应提醒所用的方法。可能的值包括：
  • “email” - 系统会通过电子邮件发送提醒。
  • “popup” - 通过界面弹出式窗口发送提醒。

添加提醒时必须提供。

 可写入
defaultReminders[].minutes integer 提醒应在活动开始前多少分钟触发。有效值介于 0 到 40320 之间（以分钟为单位，相当于 4 周）。

添加提醒时必须提供。

 可写入
deleted boolean 相应日历列表条目是否已从日历列表中删除。只读。可选。默认值为 False。
description string 日历的说明。可选。只读。
etag etag 资源的 ETag。
foregroundColor string 日历的前景颜色，采用十六进制格式“#ffffff”。此属性取代了基于索引的 colorId 属性。如需设置或更改此属性，您需要在 insert、update 和 patch 方法的参数中指定 colorRgbFormat=true。可选。 可写入
hidden boolean 日历是否已从列表中隐藏。可选。仅当日历处于隐藏状态时才会返回此属性，此时的值为 true。 可写入
id string 日历的标识符。
kind string 资源的类型（“calendar#calendarListEntry”）。
location string 日历的地理位置（自由格式的文本）。可选。只读。
notificationSettings object 经过身份验证的用户针对相应日历接收的通知。 可写入
notificationSettings.notifications[] list 相应日历设置的通知列表。
notificationSettings.notifications[].method string 用于传递通知的方法。可能的值为：
  • “email” - 系统会通过电子邮件发送通知。

添加通知时需要。

 可写入
notificationSettings.notifications[].type string 通知的类型。可能的值包括：
  • “eventCreation” - 在日历中添加新活动时发送的通知。
  • “eventChange” - 在活动发生更改时发送通知。
  • “eventCancellation” - 在活动取消时发送的通知。
  • “eventResponse” - 当有参会者回复活动邀请时发送的通知。
  • “agenda” - 包含当天活动的日程（在早上发送）。

添加通知时需要。

 可写入
primary boolean 日历是否为已通过身份验证的用户的主日历。只读。可选。默认值为 False。
selected boolean 日历内容是否显示在日历界面中。可选。默认值为 False。 可写入
summary string 日历的名称。只读。
summaryOverride string 经过身份验证的用户为此日历设置的摘要。可选。 可写入
timeZone string 日历的时区。可选。只读。

方法

delete
从用户的日历列表中移除日历。
get
返回用户日历列表中的日历。
insert
将现有日历插入到用户的日历列表中。
list
返回用户日历列表中的日历。
patch
更新用户日历列表中的现有日历。此方法支持修补语义。请注意，每个 patch 请求会消耗 3 个配额单位；建议使用 get，然后使用 update。您指定的字段值会替换现有值。您未在请求中指定的字段将保持不变。如果指定了数组字段，则会覆盖现有数组；这会舍弃任何之前的数组元素。
update
更新用户日历列表中的现有日历。
观看
监视 CalendarList 资源的变化。