Google Calendar
SDK reference for google calendar operations
Overview
Google Calendar event management and scheduling
- Category:
productivity - Auth Required: Yes
- Supported Modes: standard, delegated
Operations
createEvent
Create a new calendar event
Arguments:
summary(string, required): Event title/summarystart(object, required): Start time object with dateTime and optional timeZoneend(object, required): End time object with dateTime and optional timeZonedescription(string, optional): Event descriptionlocation(string, optional): Event locationattendees(array, optional): Array of attendee email addresses
Returns:
AdapterOperationResult - Created event information
Response Fields:
| Field | Type | Description |
|---|---|---|
eventId | string | Created event ID |
summary | string | Event title |
start | object | Event start time |
end | object | Event end time |
htmlLink | string | Link to view event in Google Calendar |
Example:
listEvents
List calendar events
Arguments:
timeMin(string, optional): Start time for events to list (ISO 8601)timeMax(string, optional): End time for events to list (ISO 8601)maxResults(number, optional): Maximum number of events to return (default: 50, max: 100)query(string, optional): Search query to filter events
Returns:
AdapterOperationResult - List of calendar events
Response Fields:
| Field | Type | Description |
|---|---|---|
count | number | Number of events returned |
query | string | Search query used (optional) |
timeMin | string | Start of time range (optional) |
timeMax | string | End of time range (optional) |
events | GoogleCalendarEventSummary[] | List of calendar events |
events item fields (GoogleCalendarEventSummary)
| Field | Type | Description |
|---|---|---|
id | string | Calendar event ID |
summary | string | Event title |
location | string | Event location |
startTime | string | Start time (ISO 8601) |
endTime | string | End time (ISO 8601) |
isAllDay | boolean | Whether this is an all-day event |
status | string | Event status: confirmed, tentative, cancelled |
htmlLink | string | Link to view event in Google Calendar |
isRecurring | boolean | Whether this is a recurring event |
attendeeCount | number | Number of attendees |
Example:
getEvents
Get calendar events (alias for listEvents)
Arguments:
timeMin(string, optional): Start time for events to list (ISO 8601)timeMax(string, optional): End time for events to list (ISO 8601)maxResults(number, optional): Maximum number of events to return (default: 50, max: 100)query(string, optional): Search query to filter events
Returns:
AdapterOperationResult - List of calendar events
Response Fields:
| Field | Type | Description |
|---|---|---|
count | number | Number of events returned |
query | string | Search query used (optional) |
timeMin | string | Start of time range (optional) |
timeMax | string | End of time range (optional) |
events | GoogleCalendarEventSummary[] | List of calendar events |
events item fields (GoogleCalendarEventSummary)
| Field | Type | Description |
|---|---|---|
id | string | Calendar event ID |
summary | string | Event title |
location | string | Event location |
startTime | string | Start time (ISO 8601) |
endTime | string | End time (ISO 8601) |
isAllDay | boolean | Whether this is an all-day event |
status | string | Event status: confirmed, tentative, cancelled |
htmlLink | string | Link to view event in Google Calendar |
isRecurring | boolean | Whether this is a recurring event |
attendeeCount | number | Number of attendees |
Example:
getEvent
Get a specific calendar event by ID
Arguments:
eventId(string, required): Calendar event ID
Returns:
AdapterOperationResult - Calendar event details
Response Fields:
| Field | Type | Description |
|---|---|---|
id | string | Calendar event ID |
summary | string | Event title |
description | string | Event description |
location | string | Event location |
startTime | string | Start time (ISO 8601) |
endTime | string | End time (ISO 8601) |
isAllDay | boolean | Whether this is an all-day event |
timeZone | string | Event timezone |
creator | GoogleCalendarAttendee | Event creator |
creator item fields (GoogleCalendarAttendee)
| Field | Type | Description |
|---|---|---|
email | string | Attendee email address |
name | string | Attendee display name (optional) |
responseStatus | string | Response status: needsAction, declined, tentative, accepted (optional) |
isOrganizer | boolean | Whether this attendee is the organizer (optional) |
isSelf | boolean | Whether this is the authenticated user (optional) |
| organizer | GoogleCalendarAttendee | Event organizer |
organizer item fields (GoogleCalendarAttendee)
| Field | Type | Description |
|---|---|---|
email | string | Attendee email address |
name | string | Attendee display name (optional) |
responseStatus | string | Response status: needsAction, declined, tentative, accepted (optional) |
isOrganizer | boolean | Whether this attendee is the organizer (optional) |
isSelf | boolean | Whether this is the authenticated user (optional) |
| attendees | GoogleCalendarAttendee[] | List of attendees |
attendees item fields (GoogleCalendarAttendee)
| Field | Type | Description |
|---|---|---|
email | string | Attendee email address |
name | string | Attendee display name (optional) |
responseStatus | string | Response status: needsAction, declined, tentative, accepted (optional) |
isOrganizer | boolean | Whether this attendee is the organizer (optional) |
isSelf | boolean | Whether this is the authenticated user (optional) |
| attendeeCount | number | Number of attendees |
| status | string | Event status: confirmed, tentative, cancelled |
| htmlLink | string | Link to view event in Google Calendar |
| isRecurring | boolean | Whether this is a recurring event |
| recurringEventId | string | ID of the recurring event series (optional) |
| created | string | When the event was created (ISO 8601) |
| updated | string | When the event was last updated (ISO 8601) |
Example:
updateEvent
Update an existing calendar event
Arguments:
eventId(string, required): Calendar event ID to updatesummary(string, optional): Updated event title/summarydescription(string, optional): Updated event descriptionlocation(string, optional): Updated event locationstart(object, optional): Updated start time object with dateTime and optional timeZoneend(object, optional): Updated end time object with dateTime and optional timeZone
Returns:
AdapterOperationResult - Updated event information
Response Fields:
| Field | Type | Description |
|---|---|---|
eventId | string | Updated event ID |
summary | string | Event title |
updated | boolean | Whether the update succeeded |
Example:
deleteEvent
Delete a calendar event
Arguments:
eventId(string, required): Calendar event ID to delete
Returns:
AdapterOperationResult - Deletion confirmation
Response Fields:
| Field | Type | Description |
|---|---|---|
eventId | string | Deleted event ID |
deleted | boolean | Whether the deletion succeeded |
Example:
searchEvents
Search calendar events by text query
Arguments:
query(string, required): Search query to filter eventstimeMin(string, optional): Start time for events to search (ISO 8601)timeMax(string, optional): End time for events to search (ISO 8601)maxResults(number, optional): Maximum number of events to return (default: 50, max: 100)
Returns:
AdapterOperationResult - List of matching calendar events
Response Fields:
| Field | Type | Description |
|---|---|---|
count | number | Number of events returned |
query | string | Search query used |
timeMin | string | Start of time range (optional) |
timeMax | string | End of time range (optional) |
events | GoogleCalendarEventSummary[] | List of matching calendar events |
events item fields (GoogleCalendarEventSummary)
| Field | Type | Description |
|---|---|---|
id | string | Calendar event ID |
summary | string | Event title |
location | string | Event location |
startTime | string | Start time (ISO 8601) |
endTime | string | End time (ISO 8601) |
isAllDay | boolean | Whether this is an all-day event |
status | string | Event status: confirmed, tentative, cancelled |
htmlLink | string | Link to view event in Google Calendar |
isRecurring | boolean | Whether this is a recurring event |
attendeeCount | number | Number of attendees |
Example: