docs/dyn/calendar_v3.freebusy.html

<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:

{
  &quot;calendarExpansionMax&quot;: 42, # Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50.
  &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.
  &quot;items&quot;: [ # List of calendars and/or groups to query.
    {
      &quot;id&quot;: &quot;A String&quot;, # The identifier of a calendar or a group.
    },
  ],
  &quot;timeMax&quot;: &quot;A String&quot;, # The end of the interval for the query formatted as per RFC3339.
  &quot;timeMin&quot;: &quot;A String&quot;, # The start of the interval for the query formatted as per RFC3339.
  &quot;timeZone&quot;: &quot;UTC&quot;, # Time zone used in the response. Optional. The default is UTC.
}


Returns:
  An object of the form:

    {
  &quot;calendars&quot;: { # List of free/busy information for calendars.
    &quot;a_key&quot;: { # Free/busy expansions for a single calendar.
      &quot;busy&quot;: [ # List of time ranges during which this calendar should be regarded as busy.
        {
          &quot;end&quot;: &quot;A String&quot;, # The (exclusive) end of the time period.
          &quot;start&quot;: &quot;A String&quot;, # The (inclusive) start of the time period.
        },
      ],
      &quot;errors&quot;: [ # Optional error(s) (if computation for the calendar failed).
        {
          &quot;domain&quot;: &quot;A String&quot;, # Domain, or broad category, of the error.
          &quot;reason&quot;: &quot;A String&quot;, # Specific reason for the error. Some of the possible values are:
              # - &quot;groupTooBig&quot; - The group of users requested is too large for a single query.
              # - &quot;tooManyCalendarsRequested&quot; - The number of calendars requested is too large for a single query.
              # - &quot;notFound&quot; - The requested resource was not found.
              # - &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.
        },
      ],
    },
  },
  &quot;groups&quot;: { # Expansion of groups.
    &quot;a_key&quot;: { # List of calendars that are members of this group.
      &quot;calendars&quot;: [ # List of calendars&#x27; identifiers within a group.
        &quot;A String&quot;,
      ],
      &quot;errors&quot;: [ # Optional error(s) (if computation for the group failed).
        {
          &quot;domain&quot;: &quot;A String&quot;, # Domain, or broad category, of the error.
          &quot;reason&quot;: &quot;A String&quot;, # Specific reason for the error. Some of the possible values are:
              # - &quot;groupTooBig&quot; - The group of users requested is too large for a single query.
              # - &quot;tooManyCalendarsRequested&quot; - The number of calendars requested is too large for a single query.
              # - &quot;notFound&quot; - The requested resource was not found.
              # - &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.
        },
      ],
    },
  },
  &quot;kind&quot;: &quot;calendar#freeBusy&quot;, # Type of the resource (&quot;calendar#freeBusy&quot;).
  &quot;timeMax&quot;: &quot;A String&quot;, # The end of the interval.
  &quot;timeMin&quot;: &quot;A String&quot;, # The start of the interval.
}</pre>
</div>

</body></html>