此页面由 Cloud Translation API 翻译。

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`”- 提供日历的所有权。此角色具有写入者角色的所有权限，还可以查看和处理 ACL。
`backgroundColor`	`string`	日历的主颜色，采用十六进制格式“`#0088aa`”。此属性会取代基于索引的 `colorId` 属性。要设置或更改此属性，您需要在 insert、update 和 patch 方法的参数中指定 `colorRgbFormat=true`。可选。	可写入
`colorId`	`string`	日历的颜色。这是引用颜色定义的 `calendar` 部分中的条目的 ID（请参阅颜色端点）。此属性已被 `backgroundColor` 和 `foregroundColor` 属性所取代，使用这些属性时可以忽略。可选。	可写入
`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` 属性。要设置或更改此属性，您需要在 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: 从用户的日历列表中返回日历。
插入: 将现有日历插入用户的日历列表。
list: 返回用户的日历列表中的日历。
补丁程序: 更新用户日历列表中的现有日历。此方法支持补丁语义。请注意，每个修补请求消耗三个配额单元；首选使用 get，后跟 update。您指定的字段值会替换现有值。未在请求中指定的字段保持不变。如果指定数组字段，则覆盖现有数组；这会舍弃之前的所有数组元素。
update: 更新用户日历列表中的现有日历。
手表: 留意 CalendarList 资源的更改。