Query

Returns free/busy information for a set of calendars

7 variables
17 variables

Returns free/busy information for a set of calendars

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • See, edit, share, and permanently delete all the calendars you can access using Google Calendar
  • View your calendars

Input

This building block consumes 7 input parameters

  = Parameter name
  = Format

calendarExpansionMax INTEGER

Maximal number of calendars for which FreeBusy information is to be provided. Optional. Maximum value is 50

groupExpansionMax INTEGER

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[] OBJECT

items[].id STRING

The identifier of a calendar or a group

timeMax DATE_TIME

The end of the interval for the query formatted as per RFC3339

timeMin DATE_TIME

The start of the interval for the query formatted as per RFC3339

timeZone STRING

Time zone used in the response. Optional. The default is UTC

Output

This building block provides 17 output parameters

  = Parameter name
  = Format

calendars OBJECT

List of free/busy information for calendars

calendars.customKey OBJECT

Add additional named properties

calendars.customKey.busy[] OBJECT

calendars.customKey.busy[].end DATE_TIME

The (exclusive) end of the time period

calendars.customKey.busy[].start DATE_TIME

The (inclusive) start of the time period

calendars.customKey.errors[] OBJECT

calendars.customKey.errors[].domain STRING

Domain, or broad category, of the error

calendars.customKey.errors[].reason 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 OBJECT

Expansion of groups

groups.customKey OBJECT

Add additional named properties

groups.customKey.calendars[] STRING

groups.customKey.errors[] OBJECT

groups.customKey.errors[].domain STRING

Domain, or broad category, of the error

groups.customKey.errors[].reason 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 STRING

Type of the resource ("calendar#freeBusy")

timeMax DATE_TIME

The end of the interval

timeMin DATE_TIME

The start of the interval