Connectors Reference

Google Calendar

Google Calendar lets you organize your schedule and share events with co-workers and friends. With Google's free online calendar, it's easy to keep track of your daily schedule.

 

Status: Production

Tier: Standard

Version: 1.1

 

Actions:

Name

Summary

ListCalendars ([advanced][Optional]string minAccessRole)

List calendars

ListWritableCalendars ([internal][Optional]string minAccessRole)

List writable calendars

ListEvents (string calendarId, [Optional]string timeMin, [Optional]string timeMax, [advanced][Optional]string q)

List the events on a calendar

CreateEvent (string calendarId, RequestEvent newEvent)

Create an event

GetEvent (string calendarId, string eventId)

Get an event

DeleteEvent (string calendarId, string eventId)

Delete an event

UpdateEvent (string calendarId, string eventId, PatchEvent updatedEvent)

Update an event

 

Triggers:

Name

Summary

OnNewEventInCalendar (string calendar_id)

When an event is added to a calendar

OnUpdatedEventInCalendar (string calendar_id)

When an event is updated in a calendar

OnDeletedEventInCalendar (string calendar_id)

When an event is deleted from a calendar

OnChangedEventInCalendar (string calendar_id, [advanced][Optional]boolean singleEvents)

When an event is added, updated or deleted from a calendar

OnEventStarted (string calendar_id)

When an event starts

 

Objects:

Name

Summary

CalendarEventChangedList

Changed Event List

CalendarEventList

Event List

CalendarList

Calendar List

CalendarListEntry

Calendar

Object

 

PatchEvent

 

RequestEvent

 

ResponseEvent

Event

ResponseEventWithActionType

 

 

Actions:

ListCalendars

Summary: List calendars

Description: This operation is used to list all calendars in your Google account.

 

Syntax:

GoogleCalendar.ListCalendars ([advanced][Optional]string minAccessRole)

 

Parameters:

Name

Type

Summary

Required

Related Action

minAccessRole

string

(Minimum Access Role)Values: [freeBusyReader, reader, writer, owner]

The minimum access role users must have to view calendars.

False

 

Returns:

          Type:CalendarList

          Summary: Calendar List

          Description: List of one or multiple calendars.

 

ListWritableCalendars

Summary: List writable calendars

Description: This operation is used to list all calendars in your Google account that you can write to.

 

Syntax:

GoogleCalendar.ListWritableCalendars ([internal][Optional]string minAccessRole)

 

Parameters:

Name

Type

Summary

Required

Related Action

minAccessRole

string

(Minimum Access Role)

The minimum access role required to view all available calendars.

False

 

Returns:

          Type:CalendarList

          Summary: Calendar List

          Description: List of one or multiple calendars.

 

ListEvents

Summary: List the events on a calendar

Description: This operation is used to return the first page of arbitrarily ordered events on the selected calendar.

 

Syntax:

GoogleCalendar.ListEvents (string calendarId, [Optional]string timeMin, [Optional]string timeMax, [advanced][Optional]string q)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

timeMin

string(date-time)

(Min Time)

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z).

False

timeMax

string(date-time)

(Max time)

Time format: yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T09:00:59.000Z).

False

q

string

(Search query)

Text search terms to find events that match these terms in any fields

False

 

Returns:

          Type:CalendarEventList

          Summary: Event List

          Description: List of events in a calendar.

 

CreateEvent

Summary: Create an event

Description: This operation is used to create an event on a specific calendar.

 

Syntax:

GoogleCalendar.CreateEvent (string calendarId, RequestEvent newEvent)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListWritableCalendars

newEvent

RequestEvent

 

An event to upload to Google Calendar

True

 

Returns:

          Type:ResponseEvent

          Summary: Event

          Description: Details of a single calendar event.

 

GetEvent

Summary: Get an event

Description: This operation is used to get the details of a specific event from a calendar.

 

Syntax:

GoogleCalendar.GetEvent (string calendarId, string eventId)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

eventId

string

(Event ID)

Unique ID of the event to get.

True

 

Returns:

          Type:ResponseEvent

          Summary: Event

          Description: Details of a single calendar event.

 

DeleteEvent

Summary: Delete an event

Description: This operation is used to delete an event from a calendar.

 

Syntax:

GoogleCalendar.DeleteEvent (string calendarId, string eventId)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListWritableCalendars

eventId

string

(Event ID)

Unique ID of the event to update.

True

 

Returns:

          Type:Object

 

UpdateEvent

Summary: Update an event

Description: This operation is used to update an existing event on a calendar.

 

Syntax:

GoogleCalendar.UpdateEvent (string calendarId, string eventId, PatchEvent updatedEvent)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendarId

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListWritableCalendars

eventId

string

(Event ID)

Unique ID of the event to get.

True

updatedEvent

PatchEvent

 

Event changes to upload to Google Calendar.

True

 

Returns:

          Type:ResponseEvent

          Summary: Event

          Description: Details of a single calendar event.

 

Triggers:

Trigger OnNewEventInCalendar

Summary: When an event is added to a calendar

Description: This operation triggers when a new event is added to a calendar.

 

Syntax:

GoogleCalendar.OnNewEventInCalendar (string calendar_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar_id

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

 

Returns:

          Type:CalendarEventList

          Summary: Event List

          Description: List of events in a calendar.

 

Trigger OnUpdatedEventInCalendar

Summary: When an event is updated in a calendar

Description: This operation triggers when an event is updated in a calendar.

 

Syntax:

GoogleCalendar.OnUpdatedEventInCalendar (string calendar_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar_id

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

 

Returns:

          Type:CalendarEventList

          Summary: Event List

          Description: List of events in a calendar.

 

Trigger OnDeletedEventInCalendar

Summary: When an event is deleted from a calendar

Description: This operation triggers when a new event is deleted from a calendar.

 

Syntax:

GoogleCalendar.OnDeletedEventInCalendar (string calendar_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar_id

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

 

Returns:

          Type:CalendarEventList

          Summary: Event List

          Description: List of events in a calendar.

 

Trigger OnChangedEventInCalendar

Summary: When an event is added, updated or deleted from a calendar

Description: This operation triggers when a new event is added, updated or deleted from a calendar.

 

Syntax:

GoogleCalendar.OnChangedEventInCalendar (string calendar_id, [advanced][Optional]boolean singleEvents)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar_id

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

singleEvents

boolean

(Expand Recurring Events?)

Whether to expand recurring events into instances.

False

 

Returns:

          Type:CalendarEventChangedList

          Summary: Changed Event List

          Description: List of events in a calendar.

 

Trigger OnEventStarted

Summary: When an event starts

Description: This operation triggers when an event starts.

 

Syntax:

GoogleCalendar.OnEventStarted (string calendar_id)

 

Parameters:

Name

Type

Summary

Required

Related Action

calendar_id

string

(Calendar ID)

Unique ID of the calendar to fetch events from.

True

ListCalendars

 

Returns:

          Type:CalendarEventList

          Summary: Event List

          Description: List of events in a calendar.

 


 

CalendarEventChangedList

Summary: Changed Event List

Description: List of events in a calendar.

 

          Properties:

Name

Type

Summary

items

array of (ResponseEventWithActionType)

Items

Changed events in the calendar.


 

CalendarEventList

Summary: Event List

Description: List of events in a calendar.

 

          Properties:

Name

Type

Summary

items

array of (ResponseEvent)

Items

Events in the calendar.


 

CalendarList

Summary: Calendar List

Description: List of one or multiple calendars.

 

          Properties:

Name

Type

Summary

items

array of (CalendarListEntry)

Items

Calendars in the list.


 

CalendarListEntry

Summary: Calendar

Description: Details about a single Google calendar.

 

          Properties:

Name

Type

Summary

id

string

Calendar ID

Identifier of the calendar.

summary

string

Summary

Title of the calendar.

description

string

Description

Description of the calendar.

location

string

Location

Geographic location of the calendar as free-form text.

timeZone

string

Time Zone

The time zone of the calendar.


 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

PatchEvent

Summary:

Description: Event changes to upload to Google Calendar.

 

          Properties:

Name

Type

Summary

summary

string

Title

A summary of the event.

start

string(date-time)

Start time

The (inclusive) start time of the event.

end

string(date-time)

End time

The (exclusive) end time of the event.

description

string

Description

Description of the event.

location

string

Location

Geographic location of the event as free-form text.

attendees

string

Attendees

Enter a comma-separated list of attendee emails.

status

string

Status

Status of the event. Possible values are "confirmed", "tentative", or "cancelled.  Values: [confirmed, tentative, cancelled]


 

RequestEvent

Summary:

Description: An event to upload to Google Calendar

 

          Properties:

Name

Type

Summary

summary

string

Title

A summary of the event.

start

string(date-time)

Start time

The (inclusive) start time of the event.

end

string(date-time)

End time

The (exclusive) end time of the event.

description

string

Description

Description of the event.

location

string

Location

Geographic location of the event as free-form text.

attendees

string

Attendees

Enter a comma-separated list of attendee emails.

status

string

Status

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".  Values: [confirmed, tentative, cancelled]


 

ResponseEvent

Summary: Event

Description: Details of a single calendar event.

 

          Properties:

Name

Type

Summary

summary

string

Title

A summary of the event.

start

string(date-time)

Start Date-Time

The (inclusive) start time of the event.

end

string(date-time)

End Date-time

The (exclusive) end time of the event.

description

string

Description

Description of the event.

location

string

Location

Geographic location of the event as free-form text.

status

string

Status

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".

htmlLink

string

HTML link

Unique ID of the list.

id

string

Event ID

Opaque identifier of the event.

attendees

string

Attendees

The event's attendees.

creator

string

Creator

The creator of the event.

organizer

string

Organizer

The organizer of the event.

created

string(date-time)

Created Date-Time

Creation time of the event.

updated

string(date-time)

Updated Date-Time

Last modification time of the event.

endTimeUnspecified

boolean

End Time Unspecified

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


 

ResponseEventWithActionType

Summary:

Description: Details of a single calendar event and what action changes the event.

 

          Properties:

Name

Type

Summary

actionType

string

Action Type

Type of action which changed the event in change trigger.  Values: [added, updated, deleted]

summary

string

Title

A summary of the event.

start

string(date-time)

Start Date-Time

The (inclusive) start time of the event.

end

string(date-time)

End Date-time

The (exclusive) end time of the event.

description

string

Description

Description of the event.

location

string

Location

Geographic location of the event as free-form text.

status

string

Status

Status of the event. Possible values are "confirmed", "tentative", or "cancelled".

htmlLink

string

HTML link

Unique ID of the list.

id

string

Event ID

Opaque identifier of the event.

attendees

string

Attendees

The event's attendees.

creator

string

Creator

The creator of the event.

organizer

string

Organizer

The organizer of the event.

created

string(date-time)

Created Date-Time

Creation time of the event.

updated

string(date-time)

Updated Date-Time

Last modification time of the event.

endTimeUnspecified

boolean

End Time Unspecified

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