1<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">
78  <code><a href="#query">query(body)</a></code></p>
79<p class="firstline">Returns free/busy information for a set of calendars.</p>
80<h3>Method Details</h3>
81<div class="method">
82    <code class="details" id="query">query(body)</code>
83  <pre>Returns free/busy information for a set of calendars.
84
85Args:
86  body: object, The request body. (required)
87    The object takes the form of:
88
89{
90    "calendarExpansionMax": 42, # Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
91    "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.
92    "timeMax": "A String", # The end of the interval for the query formatted as per RFC3339.
93    "items": [ # List of calendars and/or groups to query.
94      {
95        "id": "A String", # The identifier of a calendar or a group.
96      },
97    ],
98    "timeMin": "A String", # The start of the interval for the query formatted as per RFC3339.
99    "timeZone": "UTC", # Time zone used in the response. Optional. The default is UTC.
100  }
101
102
103Returns:
104  An object of the form:
105
106    {
107    "timeMax": "A String", # The end of the interval.
108    "kind": "calendar#freeBusy", # Type of the resource ("calendar#freeBusy").
109    "calendars": { # List of free/busy information for calendars.
110      "a_key": { # Free/busy expansions for a single calendar.
111        "busy": [ # List of time ranges during which this calendar should be regarded as busy.
112          {
113            "start": "A String", # The (inclusive) start of the time period.
114            "end": "A String", # The (exclusive) end of the time period.
115          },
116        ],
117        "errors": [ # Optional error(s) (if computation for the calendar failed).
118          {
119            "domain": "A String", # Domain, or broad category, of the error.
120            "reason": "A String", # Specific reason for the error. Some of the possible values are:
121                # - "groupTooBig" - The group of users requested is too large for a single query.
122                # - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
123                # - "notFound" - The requested resource was not found.
124                # - "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.
125          },
126        ],
127      },
128    },
129    "timeMin": "A String", # The start of the interval.
130    "groups": { # Expansion of groups.
131      "a_key": { # List of calendars that are members of this group.
132        "errors": [ # Optional error(s) (if computation for the group failed).
133          {
134            "domain": "A String", # Domain, or broad category, of the error.
135            "reason": "A String", # Specific reason for the error. Some of the possible values are:
136                # - "groupTooBig" - The group of users requested is too large for a single query.
137                # - "tooManyCalendarsRequested" - The number of calendars requested is too large for a single query.
138                # - "notFound" - The requested resource was not found.
139                # - "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.
140          },
141        ],
142        "calendars": [ # List of calendars' identifiers within a group.
143          "A String",
144        ],
145      },
146    },
147  }</pre>
148</div>
149
150</body></html>