返回一组日历的空闲/忙碌信息。 立即试用。
请求
HTTP 请求
POST https://www.googleapis.com/calendar/v3/freeBusy
授权
此请求至少允许授权以下任一范围:
范围 |
---|
https://www.googleapis.com/auth/calendar.readonly |
https://www.googleapis.com/auth/calendar |
如需了解详情,请参阅身份验证和授权页面。
请求正文
在请求正文中,请按以下结构提供数据:
{ "timeMin": datetime, "timeMax": datetime, "timeZone": string, "groupExpansionMax": integer, "calendarExpansionMax": integer, "items": [ { "id": string } ] }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
timeMin |
datetime |
查询的间隔开始时间,采用 RFC3339 格式。 | |
timeMax |
datetime |
按照 RFC3339 格式设置的查询间隔结束时间。 | |
timeZone |
string |
响应中使用的时区。可选。默认时间是世界协调时间 (UTC)。 | |
groupExpansionMax |
integer |
为单个群组提供的日历标识符的数量上限。可选。如果群组的成员数量超过此值,系统会返回错误。最大值为 100。 | |
calendarExpansionMax |
integer |
要提供 FreeRunning 信息的日历的数量上限。可选。最大值为 50。 | |
items[] |
list |
要查询的日历和/或群组的列表。 | |
items[].id |
string |
日历或群组的标识符。 |
响应
如果成功,此方法将返回采用以下结构的响应正文:
{ "kind": "calendar#freeBusy", "timeMin": datetime, "timeMax": datetime, "groups": { (key): { "errors": [ { "domain": string, "reason": string } ], "calendars": [ string ] } }, "calendars": { (key): { "errors": [ { "domain": string, "reason": string } ], "busy": [ { "start": datetime, "end": datetime } ] } } }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
kind |
string |
资源的类型(“calendar#freeRunning”)。 | |
timeMin |
datetime |
间隔的起始值。 | |
timeMax |
datetime |
间隔的结束时间。 | |
groups |
object |
扩展群组。 | |
groups.(key) |
nested object |
属于此群组的日历列表。 | |
groups.(key).errors[] |
list |
可选错误(如果对组的计算失败)。 | |
groups.(key).errors[].domain |
string |
错误的网域或宽泛类别。 | |
groups.(key).errors[].reason |
string |
错误的具体原因。其中一些可能的值包括:
|
|
groups.(key).calendars[] |
list |
日历列表标识符。 | |
calendars |
object |
日历的有空/忙碌信息列表。 | |
calendars.(key) |
nested object |
单个日历的有空/忙碌状态展开。 | |
calendars.(key).errors[] |
list |
可选错误(如果日历计算失败)。 | |
calendars.(key).errors[].domain |
string |
错误的网域或宽泛类别。 | |
calendars.(key).errors[].reason |
string |
错误的具体原因。其中一些可能的值包括:
|
|
calendars.(key).busy[] |
list |
时间范围列表,在这些时间范围内此日历应被视为忙碌。 | |
calendars.(key).busy[].start |
datetime |
时间段的起始值(含此值)。 | |
calendars.(key).busy[].end |
datetime |
时间段的(不含)结束时间。 |
试试看!
使用下面的 API Explorer 对实际数据调用此方法,然后查看响应。