1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.freebusy.html">freebusy</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#query">query(body=None)</a></code></p>
<p class="firstline">Returns free/busy information for a set of calendars.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="query">query(body=None)</code>
<pre>Returns free/busy information for a set of calendars.
Args:
body: object, The request body.
The object takes the form of:
{
"calendarExpansionMax": 42, # Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
"groupExpansionMax": 42, # Maximal number of calendar identifiers to be provided for a single group. Optional. An error is returned for a group with more members than this value. Maximum value is 100.
"items": [ # List of calendars and/or groups to query.
{
"id": "A String", # The identifier of a calendar or a group.
},
],
"timeMax": "A String", # The end of the interval for the query formatted as per RFC3339.
"timeMin": "A String", # The start of the interval for the query formatted as per RFC3339.
"timeZone": "UTC", # Time zone used in the response. Optional. The default is UTC.
}
Returns:
An object of the form:
{
"calendars": { # List of free/busy information for calendars.
"a_key": { # Free/busy expansions for a single calendar.
"busy": [ # List of time ranges during which this calendar should be regarded as busy.
{
"end": "A String", # The (exclusive) end of the time period.
"start": "A String", # The (inclusive) start of the time period.
},
],
"errors": [ # Optional error(s) (if computation for the calendar failed).
{
"domain": "A String", # Domain, or broad category, of the error.
"reason": "A String", # Specific reason for the error. Some of the possible values are:
# - "groupTooBig" - The group of users requested is too large for a single query.
# - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
# - "notFound" - The requested resource was not found.
# - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
},
],
},
},
"groups": { # Expansion of groups.
"a_key": { # List of calendars that are members of this group.
"calendars": [ # List of calendars' identifiers within a group.
"A String",
],
"errors": [ # Optional error(s) (if computation for the group failed).
{
"domain": "A String", # Domain, or broad category, of the error.
"reason": "A String", # Specific reason for the error. Some of the possible values are:
# - "groupTooBig" - The group of users requested is too large for a single query.
# - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
# - "notFound" - The requested resource was not found.
# - "internalError" - The API service has encountered an internal error. Additional error types may be added in the future, so clients should gracefully handle additional error statuses not included in this list.
},
],
},
},
"kind": "calendar#freeBusy", # Type of the resource ("calendar#freeBusy").
"timeMax": "A String", # The end of the interval.
"timeMin": "A String", # The start of the interval.
}</pre>
</div>
</body></html>
|
