Use wide Google Calendar integration

With Ants & Apps platform you can connect Google Calendar with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • acl

    • Return an access control rule

      This action returns an access control rule.

      GETCalendarAclGet

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • ruleId*string

        ACL rule identifier.

    • Return the rules in the access control list for the calendar

      This action returns the rules in the access control list for the calendar.

      GETCalendarAclList

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • showDeletedboolean

        Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

    • Create an access control rule

      This action creates an access control rule.

      POSTCalendarAclInsert

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • sendNotificationsboolean

        Whether to send notifications about the calendar sharing change. Optional. The default is True.

      Request body

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the ACL rule.

      • kindstring

        Type of the resource ("calendar#aclRule").

      • rolestring

        The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • scopeobject

        The scope of the rule.

    • Watch for changes to ACL resources

      This action watch for changes to ACL resources.

      POSTCalendarAclWatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • showDeletedboolean

        Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

    • Update an access control rule

      This action updates an access control rule.

      PUTCalendarAclUpdate

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • ruleId*string

        ACL rule identifier.

      • sendNotificationsboolean

        Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

      Request body

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the ACL rule.

      • kindstring

        Type of the resource ("calendar#aclRule").

      • rolestring

        The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • scopeobject

        The scope of the rule.

    • Update an access control rule

      This action updates an access control rule. This method supports patch semantics.

      PATCHCalendarAclPatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • ruleId*string

        ACL rule identifier.

      • sendNotificationsboolean

        Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.

      Request body

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the ACL rule.

      • kindstring

        Type of the resource ("calendar#aclRule").

      • rolestring

        The role assigned to the scope. Possible values are: - "none" - Provides no access. - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • scopeobject

        The scope of the rule.

    • Delete an access control rule

      This action deletes an access control rule.

      DELETECalendarAclDelete

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • ruleId*string

        ACL rule identifier.

  • calendarList

    • Return a calendar from the user's calendar list

      This action returns a calendar from the user's calendar list.

      GETCalendarCalendarListGet

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

    • Return the calendars on the user's calendar list

      This action returns the calendars on the user's calendar list.

      GETCalendarCalendarListList

      Request parameters

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • minAccessRolestring

        The minimum access role for the user in the returned entries. Optional. The default is no restriction.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • showDeletedboolean

        Whether to include deleted calendar list entries in the result. Optional. The default is False.

      • showHiddenboolean

        Whether to show hidden entries. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

    • Insert an existing calendar into the user's calendar list

      This action inserts an existing calendar into the user's calendar list.

      POSTCalendarCalendarListInsert

      Request parameters

      • colorRgbFormatboolean

        Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

      Request body

      • accessRolestring

        The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • backgroundColorstring

        The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • colorIdstring

        The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • defaultRemindersarray

        The default reminders that the authenticated user has for this calendar.

      • deletedboolean

        Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

      • descriptionstring

        Description of the calendar. Optional. Read-only.

      • etagstring

        ETag of the resource.

      • foregroundColorstring

        The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • hiddenboolean

        Whether the calendar has been hidden from the list. Optional. The default is False.

      • idstring

        Identifier of the calendar.

      • kindstring

        Type of the resource ("calendar#calendarListEntry").

      • locationstring

        Geographic location of the calendar as free-form text. Optional. Read-only.

      • notificationSettingsobject

        The notifications that the authenticated user is receiving for this calendar.

      • primaryboolean

        Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

      • selectedboolean

        Whether the calendar content shows up in the calendar UI. Optional. The default is False.

      • summarystring

        Title of the calendar. Read-only.

      • summaryOverridestring

        The summary that the authenticated user has set for this calendar. Optional.

      • timeZonestring

        The time zone of the calendar. Optional. Read-only.

    • Watch for changes to CalendarList resources

      This action watch for changes to CalendarList resources.

      POSTCalendarCalendarListWatch

      Request parameters

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • minAccessRolestring

        The minimum access role for the user in the returned entries. Optional. The default is no restriction.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • showDeletedboolean

        Whether to include deleted calendar list entries in the result. Optional. The default is False.

      • showHiddenboolean

        Whether to show hidden entries. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

    • Update an existing calendar on the user's calendar list

      This action updates an existing calendar on the user's calendar list.

      PUTCalendarCalendarListUpdate

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • colorRgbFormatboolean

        Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

      Request body

      • accessRolestring

        The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • backgroundColorstring

        The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • colorIdstring

        The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • defaultRemindersarray

        The default reminders that the authenticated user has for this calendar.

      • deletedboolean

        Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

      • descriptionstring

        Description of the calendar. Optional. Read-only.

      • etagstring

        ETag of the resource.

      • foregroundColorstring

        The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • hiddenboolean

        Whether the calendar has been hidden from the list. Optional. The default is False.

      • idstring

        Identifier of the calendar.

      • kindstring

        Type of the resource ("calendar#calendarListEntry").

      • locationstring

        Geographic location of the calendar as free-form text. Optional. Read-only.

      • notificationSettingsobject

        The notifications that the authenticated user is receiving for this calendar.

      • primaryboolean

        Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

      • selectedboolean

        Whether the calendar content shows up in the calendar UI. Optional. The default is False.

      • summarystring

        Title of the calendar. Read-only.

      • summaryOverridestring

        The summary that the authenticated user has set for this calendar. Optional.

      • timeZonestring

        The time zone of the calendar. Optional. Read-only.

    • Update an existing calendar on the user's calendar list

      This action updates an existing calendar on the user's calendar list. This method supports patch semantics.

      PATCHCalendarCalendarListPatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • colorRgbFormatboolean

        Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False.

      Request body

      • accessRolestring

        The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: - "freeBusyReader" - Provides read access to free/busy information. - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.

      • backgroundColorstring

        The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • colorIdstring

        The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • defaultRemindersarray

        The default reminders that the authenticated user has for this calendar.

      • deletedboolean

        Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.

      • descriptionstring

        Description of the calendar. Optional. Read-only.

      • etagstring

        ETag of the resource.

      • foregroundColorstring

        The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.

      • hiddenboolean

        Whether the calendar has been hidden from the list. Optional. The default is False.

      • idstring

        Identifier of the calendar.

      • kindstring

        Type of the resource ("calendar#calendarListEntry").

      • locationstring

        Geographic location of the calendar as free-form text. Optional. Read-only.

      • notificationSettingsobject

        The notifications that the authenticated user is receiving for this calendar.

      • primaryboolean

        Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.

      • selectedboolean

        Whether the calendar content shows up in the calendar UI. Optional. The default is False.

      • summarystring

        Title of the calendar. Read-only.

      • summaryOverridestring

        The summary that the authenticated user has set for this calendar. Optional.

      • timeZonestring

        The time zone of the calendar. Optional. Read-only.

    • Remove a calendar from the user's calendar list

      This action removes a calendar from the user's calendar list.

      DELETECalendarCalendarListDelete

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • calendars

    • Return metadata for a calendar

      This action returns metadata for a calendar.

      GETCalendarCalendarsGet

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

    • Clear a primary calendar

      This action clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.

      POSTCalendarCalendarsClear

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

    • Create a secondary calendar

      This action creates a secondary calendar.

      POSTCalendarCalendarsInsert

      Request body

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • descriptionstring

        Description of the calendar. Optional.

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the calendar. To retrieve IDs call the calendarList.list() method.

      • kindstring

        Type of the resource ("calendar#calendar").

      • locationstring

        Geographic location of the calendar as free-form text. Optional.

      • summarystring

        Title of the calendar.

      • timeZonestring

        The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

    • Update metadata for a calendar

      This action updates metadata for a calendar.

      PUTCalendarCalendarsUpdate

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      Request body

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • descriptionstring

        Description of the calendar. Optional.

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the calendar. To retrieve IDs call the calendarList.list() method.

      • kindstring

        Type of the resource ("calendar#calendar").

      • locationstring

        Geographic location of the calendar as free-form text. Optional.

      • summarystring

        Title of the calendar.

      • timeZonestring

        The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

    • Update metadata for a calendar

      This action updates metadata for a calendar. This method supports patch semantics.

      PATCHCalendarCalendarsPatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      Request body

      • conferencePropertiesobject

        Conferencing properties for this calendar, for example what types of conferences are allowed.

      • descriptionstring

        Description of the calendar. Optional.

      • etagstring

        ETag of the resource.

      • idstring

        Identifier of the calendar. To retrieve IDs call the calendarList.list() method.

      • kindstring

        Type of the resource ("calendar#calendar").

      • locationstring

        Geographic location of the calendar as free-form text. Optional.

      • summarystring

        Title of the calendar.

      • timeZonestring

        The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional.

    • Delete a secondary calendar

      This action deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.

      DELETECalendarCalendarsDelete

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

  • channels

    • Stop watching resources through this channel

      This action stop watching resources through this channel

      POSTCalendarChannelsStop

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

  • colors

    • Return the color definitions for calendars and events

      This action returns the color definitions for calendars and events.

      GETCalendarColorsGet
  • events

    • Return an event

      This action returns an event.

      GETCalendarEventsGet

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • eventId*string

        Event identifier.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • timeZonestring

        Time zone used in the response. Optional. The default is the time zone of the calendar.

    • Return instances of the specified recurring event

      This action returns instances of the specified recurring event.

      GETCalendarEventsInstances

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • eventId*string

        Recurring event identifier.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • maxResultsinteger

        Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

      • originalStartstring

        The original start time of the instance in the result. Optional.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • showDeletedboolean

        Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events will still be included if singleEvents is False. Optional. The default is False.

      • timeMaxstring

        Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.

      • timeMinstring

        Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.

      • timeZonestring

        Time zone used in the response. Optional. The default is the time zone of the calendar.

    • Return events on the specified calendar

      This action returns events on the specified calendar.

      GETCalendarEventsList

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • iCalUIDstring

        Specifies event ID in the iCalendar format to be included in the response. Optional.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • maxResultsinteger

        Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

      • orderBystring

        The order of the events returned in the result. Optional. The default is an unspecified, stable order.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • privateExtendedPropertystring

        Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

      • qstring

        Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

      • sharedExtendedPropertystring

        Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

      • showDeletedboolean

        Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

      • showHiddenInvitationsboolean

        Whether to include hidden invitations in the result. Optional. The default is False.

      • singleEventsboolean

        Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

      • timeMaxstring

        Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

      • timeMinstring

        Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

      • timeZonestring

        Time zone used in the response. Optional. The default is the time zone of the calendar.

      • updatedMinstring

        Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

    • Import an event

      This action imports an event. This operation is used to add a private copy of an existing event to a calendar.

      POSTCalendarEventsImport

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • conferenceDataVersioninteger

        Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

      • supportsAttachmentsboolean

        Whether API client performing operation supports event attachments. Optional. The default is False.

      Request body

      • anyoneCanAddSelfboolean

        Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

      • attachmentsarray

        File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

      • attendeesarray

        The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

      • attendeesOmittedboolean

        Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

      • colorIdstring

        The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

      • conferenceDataobject

        The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.

      • createdstring

        Creation time of the event (as a RFC3339 timestamp). Read-only.

      • creatorobject

        The creator of the event. Read-only.

      • descriptionstring

        Description of the event. Optional.

      • endobject

        The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

      • endTimeUnspecifiedboolean

        Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

      • etagstring

        ETag of the resource.

      • extendedPropertiesobject

        Extended properties of the event.

      • gadgetobject

        A gadget that extends this event.

      • guestsCanInviteOthersboolean

        Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

      • guestsCanModifyboolean

        Whether attendees other than the organizer can modify the event. Optional. The default is False.

      • guestsCanSeeOtherGuestsboolean

        Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

      • hangoutLinkstring

        An absolute link to the Google+ hangout associated with this event. Read-only.

      • htmlLinkstring

        An absolute link to this event in the Google Calendar Web UI. Read-only.

      • iCalUIDstring

        Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • idstring

        Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • kindstring

        Type of the resource ("calendar#event").

      • locationstring

        Geographic location of the event as free-form text. Optional.

      • lockedboolean

        Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

      • organizerobject

        The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

      • originalStartTimeobject

        For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.

      • privateCopyboolean

        If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

      • recurrencearray

        List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

      • recurringEventIdstring

        For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

      • remindersobject

        Information about the event's reminders for the authenticated user.

      • sequenceinteger

        Sequence number as per iCalendar.

      • sourceobject

        Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

      • startobject

        The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

      • statusstring

        Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

      • summarystring

        Title of the event.

      • transparencystring

        Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

      • updatedstring

        Last modification time of the event (as a RFC3339 timestamp). Read-only.

      • visibilitystring

        Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

      • metadataobject

        Metadata about the event.

      • typestring

        The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

      • dateobject

        The date of the event.

      • formattedTypestring

        The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

    • Create an event

      This action creates an event.

      POSTCalendarEventsInsert

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • conferenceDataVersioninteger

        Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the new event. Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false.

      • supportsAttachmentsboolean

        Whether API client performing operation supports event attachments. Optional. The default is False.

      Request body

      • anyoneCanAddSelfboolean

        Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

      • attachmentsarray

        File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

      • attendeesarray

        The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

      • attendeesOmittedboolean

        Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

      • colorIdstring

        The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

      • conferenceDataobject

        The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.

      • createdstring

        Creation time of the event (as a RFC3339 timestamp). Read-only.

      • creatorobject

        The creator of the event. Read-only.

      • descriptionstring

        Description of the event. Optional.

      • endobject

        The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

      • endTimeUnspecifiedboolean

        Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

      • etagstring

        ETag of the resource.

      • extendedPropertiesobject

        Extended properties of the event.

      • gadgetobject

        A gadget that extends this event.

      • guestsCanInviteOthersboolean

        Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

      • guestsCanModifyboolean

        Whether attendees other than the organizer can modify the event. Optional. The default is False.

      • guestsCanSeeOtherGuestsboolean

        Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

      • hangoutLinkstring

        An absolute link to the Google+ hangout associated with this event. Read-only.

      • htmlLinkstring

        An absolute link to this event in the Google Calendar Web UI. Read-only.

      • iCalUIDstring

        Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • idstring

        Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • kindstring

        Type of the resource ("calendar#event").

      • locationstring

        Geographic location of the event as free-form text. Optional.

      • lockedboolean

        Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

      • organizerobject

        The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

      • originalStartTimeobject

        For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.

      • privateCopyboolean

        If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

      • recurrencearray

        List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

      • recurringEventIdstring

        For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

      • remindersobject

        Information about the event's reminders for the authenticated user.

      • sequenceinteger

        Sequence number as per iCalendar.

      • sourceobject

        Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

      • startobject

        The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

      • statusstring

        Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

      • summarystring

        Title of the event.

      • transparencystring

        Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

      • updatedstring

        Last modification time of the event (as a RFC3339 timestamp). Read-only.

      • visibilitystring

        Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

      • metadataobject

        Metadata about the event.

      • typestring

        The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

      • dateobject

        The date of the event.

      • formattedTypestring

        The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

    • Move an event to another calendar, i

      This action moves an event to another calendar, i.e. changes an event's organizer.

      POSTCalendarEventsMove

      Request parameters

      • calendarId*string

        Calendar identifier of the source calendar where the event currently is on.

      • destination*string

        Calendar identifier of the target calendar where the event is to be moved to.

      • eventId*string

        Event identifier.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the change of the event's organizer. Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Guests who should receive notifications about the change of the event's organizer.

    • Create an event based on a simple text string

      This action creates an event based on a simple text string.

      POSTCalendarEventsQuickAdd

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • text*string

        The text describing the event to be created.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the creation of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Guests who should receive notifications about the creation of the new event.

    • Watch for changes to Events resources

      This action watch for changes to Events resources.

      POSTCalendarEventsWatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • iCalUIDstring

        Specifies event ID in the iCalendar format to be included in the response. Optional.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • maxResultsinteger

        Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.

      • orderBystring

        The order of the events returned in the result. Optional. The default is an unspecified, stable order.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • privateExtendedPropertystring

        Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints.

      • qstring

        Free text search terms to find events that match these terms in any field, except for extended properties. Optional.

      • sharedExtendedPropertystring

        Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints.

      • showDeletedboolean

        Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False.

      • showHiddenInvitationsboolean

        Whether to include hidden invitations in the result. Optional. The default is False.

      • singleEventsboolean

        Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. There are several query parameters that cannot be specified together with nextSyncToken to ensure consistency of the client state. These are: - iCalUID - orderBy - privateExtendedProperty - q - sharedExtendedProperty - timeMin - timeMax - updatedMin If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

      • timeMaxstring

        Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin.

      • timeMinstring

        Lower bound (exclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax.

      • timeZonestring

        Time zone used in the response. Optional. The default is the time zone of the calendar.

      • updatedMinstring

        Lower bound for an event's last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

    • Update an event

      This action updates an event.

      PUTCalendarEventsUpdate

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • eventId*string

        Event identifier.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • conferenceDataVersioninteger

        Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Guests who should receive notifications about the event update (for example, title changes, etc.).

      • supportsAttachmentsboolean

        Whether API client performing operation supports event attachments. Optional. The default is False.

      Request body

      • anyoneCanAddSelfboolean

        Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

      • attachmentsarray

        File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

      • attendeesarray

        The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

      • attendeesOmittedboolean

        Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

      • colorIdstring

        The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

      • conferenceDataobject

        The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.

      • createdstring

        Creation time of the event (as a RFC3339 timestamp). Read-only.

      • creatorobject

        The creator of the event. Read-only.

      • descriptionstring

        Description of the event. Optional.

      • endobject

        The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

      • endTimeUnspecifiedboolean

        Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

      • etagstring

        ETag of the resource.

      • extendedPropertiesobject

        Extended properties of the event.

      • gadgetobject

        A gadget that extends this event.

      • guestsCanInviteOthersboolean

        Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

      • guestsCanModifyboolean

        Whether attendees other than the organizer can modify the event. Optional. The default is False.

      • guestsCanSeeOtherGuestsboolean

        Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

      • hangoutLinkstring

        An absolute link to the Google+ hangout associated with this event. Read-only.

      • htmlLinkstring

        An absolute link to this event in the Google Calendar Web UI. Read-only.

      • iCalUIDstring

        Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • idstring

        Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • kindstring

        Type of the resource ("calendar#event").

      • locationstring

        Geographic location of the event as free-form text. Optional.

      • lockedboolean

        Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

      • organizerobject

        The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

      • originalStartTimeobject

        For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.

      • privateCopyboolean

        If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

      • recurrencearray

        List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

      • recurringEventIdstring

        For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

      • remindersobject

        Information about the event's reminders for the authenticated user.

      • sequenceinteger

        Sequence number as per iCalendar.

      • sourceobject

        Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

      • startobject

        The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

      • statusstring

        Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

      • summarystring

        Title of the event.

      • transparencystring

        Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

      • updatedstring

        Last modification time of the event (as a RFC3339 timestamp). Read-only.

      • visibilitystring

        Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

      • metadataobject

        Metadata about the event.

      • typestring

        The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

      • dateobject

        The date of the event.

      • formattedTypestring

        The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

    • Update an event

      This action updates an event. This method supports patch semantics.

      PATCHCalendarEventsPatch

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • eventId*string

        Event identifier.

      • alwaysIncludeEmailboolean

        Whether to always include a value in the email field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.

      • conferenceDataVersioninteger

        Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.

      • maxAttendeesinteger

        The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Guests who should receive notifications about the event update (for example, title changes, etc.).

      • supportsAttachmentsboolean

        Whether API client performing operation supports event attachments. Optional. The default is False.

      Request body

      • anyoneCanAddSelfboolean

        Whether anyone can invite themselves to the event (currently works for Google+ events only). Optional. The default is False.

      • attachmentsarray

        File attachments for the event. Currently only Google Drive attachments are supported. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,

      • attendeesarray

        The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users.

      • attendeesOmittedboolean

        Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False.

      • colorIdstring

        The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional.

      • conferenceDataobject

        The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests.

      • createdstring

        Creation time of the event (as a RFC3339 timestamp). Read-only.

      • creatorobject

        The creator of the event. Read-only.

      • descriptionstring

        Description of the event. Optional.

      • endobject

        The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance.

      • endTimeUnspecifiedboolean

        Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False.

      • etagstring

        ETag of the resource.

      • extendedPropertiesobject

        Extended properties of the event.

      • gadgetobject

        A gadget that extends this event.

      • guestsCanInviteOthersboolean

        Whether attendees other than the organizer can invite others to the event. Optional. The default is True.

      • guestsCanModifyboolean

        Whether attendees other than the organizer can modify the event. Optional. The default is False.

      • guestsCanSeeOtherGuestsboolean

        Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True.

      • hangoutLinkstring

        An absolute link to the Google+ hangout associated with this event. Read-only.

      • htmlLinkstring

        An absolute link to this event in the Google Calendar Web UI. Read-only.

      • iCalUIDstring

        Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • idstring

        Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs.

      • kindstring

        Type of the resource ("calendar#event").

      • locationstring

        Geographic location of the event as free-form text. Optional.

      • lockedboolean

        Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only.

      • organizerobject

        The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event.

      • originalStartTimeobject

        For an instance of a recurring event, this is the time at which this event would start according to the recurrence data in the recurring event identified by recurringEventId. It uniquely identifies the instance within the recurring event series even if the instance was moved to a different time. Immutable.

      • privateCopyboolean

        If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False.

      • recurrencearray

        List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events.

      • recurringEventIdstring

        For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable.

      • remindersobject

        Information about the event's reminders for the authenticated user.

      • sequenceinteger

        Sequence number as per iCalendar.

      • sourceobject

        Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event.

      • startobject

        The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance.

      • statusstring

        Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated.

      • summarystring

        Title of the event.

      • transparencystring

        Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI.

      • updatedstring

        Last modification time of the event (as a RFC3339 timestamp). Read-only.

      • visibilitystring

        Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons.

      • metadataobject

        Metadata about the event.

      • typestring

        The type of the event. The type can be custom or one of these predefined values: * `anniversary` * `other`

      • dateobject

        The date of the event.

      • formattedTypestring

        The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.

    • Delete an event

      This action deletes an event.

      DELETECalendarEventsDelete

      Request parameters

      • calendarId*string

        Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.

      • eventId*string

        Event identifier.

      • sendNotificationsboolean

        Deprecated. Please use sendUpdates instead. Whether to send notifications about the deletion of the event. Note that some emails might still be sent even if you set the value to false. The default is false.

      • sendUpdatesstring

        Guests who should receive notifications about the deletion of the event.

  • freebusy

    • Return free/busy information for a set of calendars

      This action returns free/busy information for a set of calendars.

      POSTCalendarFreebusyQuery

      Request body

      • calendarExpansionMaxinteger

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

      • groupExpansionMaxinteger

        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.

      • itemsarray

        List of calendars and/or groups to query.

      • timeMaxstring

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

      • timeMinstring

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

      • timeZonestring

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

  • settings

    • Return a single user setting

      This action returns a single user setting.

      GETCalendarSettingsGet

      Request parameters

      • setting*string

        The id of the user setting.

    • Return all user settings for the authenticated user

      This action returns all user settings for the authenticated user.

      GETCalendarSettingsList

      Request parameters

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

    • Watch for changes to Settings resources

      This action watch for changes to Settings resources.

      POSTCalendarSettingsWatch

      Request parameters

      • maxResultsinteger

        Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional.

      • pageTokenstring

        Token specifying which result page to return. Optional.

      • syncTokenstring

        Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries.

      Request body

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.

      • addressstring

        The address where notifications are delivered for this channel.

      • expirationstring

        Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.

      • idstring

        A UUID or similar unique string that identifies this channel.

      • kindstring

        Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".

      • paramsobject

        Additional parameters controlling delivery channel behavior. Optional.

      • payloadboolean

        A Boolean value to indicate whether payload is wanted. Optional.

      • resourceIdstring

        An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.

      • resourceUristring

        A version-specific identifier for the watched resource.

      • tokenstring

        An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.

      • typestring

        The type of delivery mechanism used for this channel.