blob: 8912ca31cbafbd49f9e2588bf99aa3ef1a8a5052 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="calendar_v3.html">Calendar API</a> . <a href="calendar_v3.freebusy.html">freebusy</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#query">query(body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040079<p class="firstline">Returns free/busy information for a set of calendars.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -070082 <code class="details" id="query">query(body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -040083 <pre>Returns free/busy information for a set of calendars.
84
85Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070086 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -040087 The object takes the form of:
88
89{
Bu Sun Kim65020912020-05-20 12:08:20 -070090 &quot;calendarExpansionMax&quot;: 42, # Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
91 &quot;groupExpansionMax&quot;: 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.
92 &quot;items&quot;: [ # List of calendars and/or groups to query.
John Asmuth614db982014-04-24 15:46:26 -040093 {
Bu Sun Kim65020912020-05-20 12:08:20 -070094 &quot;id&quot;: &quot;A String&quot;, # The identifier of a calendar or a group.
John Asmuth614db982014-04-24 15:46:26 -040095 },
96 ],
Bu Sun Kim65020912020-05-20 12:08:20 -070097 &quot;timeMax&quot;: &quot;A String&quot;, # The end of the interval for the query formatted as per RFC3339.
98 &quot;timeMin&quot;: &quot;A String&quot;, # The start of the interval for the query formatted as per RFC3339.
99 &quot;timeZone&quot;: &quot;UTC&quot;, # Time zone used in the response. Optional. The default is UTC.
John Asmuth614db982014-04-24 15:46:26 -0400100 }
101
102
103Returns:
104 An object of the form:
105
106 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;calendars&quot;: { # List of free/busy information for calendars.
108 &quot;a_key&quot;: { # Free/busy expansions for a single calendar.
109 &quot;busy&quot;: [ # List of time ranges during which this calendar should be regarded as busy.
John Asmuth614db982014-04-24 15:46:26 -0400110 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700111 &quot;end&quot;: &quot;A String&quot;, # The (exclusive) end of the time period.
112 &quot;start&quot;: &quot;A String&quot;, # The (inclusive) start of the time period.
John Asmuth614db982014-04-24 15:46:26 -0400113 },
114 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700115 &quot;errors&quot;: [ # Optional error(s) (if computation for the calendar failed).
John Asmuth614db982014-04-24 15:46:26 -0400116 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 &quot;domain&quot;: &quot;A String&quot;, # Domain, or broad category, of the error.
118 &quot;reason&quot;: &quot;A String&quot;, # Specific reason for the error. Some of the possible values are:
119 # - &quot;groupTooBig&quot; - The group of users requested is too large for a single query.
120 # - &quot;tooManyCalendarsRequested&quot; - The number of calendars requested is too large for a single query.
121 # - &quot;notFound&quot; - The requested resource was not found.
122 # - &quot;internalError&quot; - 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.
John Asmuth614db982014-04-24 15:46:26 -0400123 },
124 ],
125 },
126 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;groups&quot;: { # Expansion of groups.
128 &quot;a_key&quot;: { # List of calendars that are members of this group.
129 &quot;calendars&quot;: [ # List of calendars&#x27; identifiers within a group.
130 &quot;A String&quot;,
John Asmuth614db982014-04-24 15:46:26 -0400131 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700132 &quot;errors&quot;: [ # Optional error(s) (if computation for the group failed).
133 {
134 &quot;domain&quot;: &quot;A String&quot;, # Domain, or broad category, of the error.
135 &quot;reason&quot;: &quot;A String&quot;, # Specific reason for the error. Some of the possible values are:
136 # - &quot;groupTooBig&quot; - The group of users requested is too large for a single query.
137 # - &quot;tooManyCalendarsRequested&quot; - The number of calendars requested is too large for a single query.
138 # - &quot;notFound&quot; - The requested resource was not found.
139 # - &quot;internalError&quot; - 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.
140 },
John Asmuth614db982014-04-24 15:46:26 -0400141 ],
142 },
143 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &quot;kind&quot;: &quot;calendar#freeBusy&quot;, # Type of the resource (&quot;calendar#freeBusy&quot;).
145 &quot;timeMax&quot;: &quot;A String&quot;, # The end of the interval.
146 &quot;timeMin&quot;: &quot;A String&quot;, # The start of the interval.
John Asmuth614db982014-04-24 15:46:26 -0400147 }</pre>
148</div>
149
150</body></html>