CalendarList

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

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

资源表示法

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": 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”- 提供日历的所有权。此角色拥有 writer 角色的所有权限,并且还具有查看和操作 ACL 的额外权限。
backgroundColor string 日历的主颜色,采用十六进制格式“#0088aa”。此属性会取代基于索引的 colorId 属性。如需设置或更改此属性,您需要在 insertupdatepatch 方法的参数中指定 colorRgbFormat=true。可选。 可写
colorId string 日历的颜色。这是一个 ID,用于引用颜色定义的 calendar 部分中的条目(请参阅颜色端点)。此属性已被 backgroundColorforegroundColor 属性取代,在使用这些属性时可以忽略。可选。 可写
conferenceProperties nested object 此日历的会议属性,例如允许举行哪些类型的会议。
conferenceProperties.allowedConferenceSolutionTypes[] list 此日历支持的会议解决方案类型。

可能的值包括:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
选填。

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 属性。如需设置或更改此属性,您需要在 insertupdatepatch 方法的参数中指定 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 日历的时区。可选。只读。

方法

删除
从用户的日历列表中移除日历。
get
从用户的日历列表中返回日历。
insert
将现有日历插入用户的日历列表。
list
返回用户日历列表中的日历。
patch
更新用户日历列表中的现有日历。此方法支持补丁语义。请注意,每个补丁请求消耗三个配额单元;最好先使用 get,后跟 update。您指定的字段值会替换现有值。您未在请求中指定的字段将保持不变。数组字段(如果指定)会覆盖现有的数组;这会舍弃之前的所有数组元素。
update
更新用户日历列表中的现有日历。
观看
留意 CalendarList 资源的更改。