API Connector Documentation
Import Google Calendar Data to Google Sheets
In this guide, we’ll walk through how to pull Google Calendar API data data directly into Google Sheets, using the API Connector add-on for Sheets.
Contents
- Before You Begin
- Part 1: Connect to the Google Calendar API
- Part 2: Pull Data from Google Calendar to Sheets
- Part 3: Create a Custom Request
- Part 4: Handle Pagination
- Part 5: API Documentation
Before You Begin
Click here to install the API Connector add-on from the Google Marketplace.
Part 1: Connect to the Google Calendar API
The easiest way to get started with the Google Calendar API is through API Connector's built-in integration.
- In Sheets, open API Connector and create a new request (Extensions > API Connector > Open > Create request)
- Select Google Calendar from the drop-down list of applications
- Under Authorization, click Connect to Google Calendar
- You will be directed to google.com and asked to allow API Connector to access your calendars. Click Allow.
- You'll then be returned to your Google Sheet, and can verify that your Google Calendar connection is active in the Connections screen.
Part 2: Pull Data from Google Calendar to Sheets
Now that we’re connected, let’s pull some data into Sheets.
- Select the
/calendars/{calendar_id}/eventsendpoint, , which allows us to retrieve the events on our calendars
- Under the
calendar_idparameter, enter the word primary. This will fetch data from your primary calendar (if you prefer to fetch data from a different calendar, enter the email address associated with that calendar, e.g.[email protected])
- Optionally populate other request parameters to customize your request, e.g. date ranges and keyword searches.
- Choose a destination sheet, name your request, and hit Run. A moment later you’ll see the response data in your sheet.
Part 3: Create a Custom Request
Alternatively, you can run your own custom requests instead of using API Connector’s pre-built integration, using any of the endpoints and parameters shown in the API documentation. Here's an example setup:
- Application:
Custom - Method:
GET - Request URL:
https://www.googleapis.com/calendar/v3/calendars/primary/events?timeMax=2022-07-20T07:00:00:000Z&timeMin=2022-01-01T00:00:00:000Z - OAuth:
Google Calendar
Part 4: Handle Pagination
By default, the Google Calendar API will send back just 250 events. To retrieve more, set the maxResults parameter to 2500.
If you need more than 2500 records, you can cycle through multiple pages of 2500 using API Connector's pagination handling feature, like this:
- Pagination type:
cursor - Next token parameter:
pageToken - Next token path:
nextPageToken - Run until: choose when to stop running the request
nextPageToken for requests using the timeMin or timeMax parameters. For those requests, change the start/end dates to retrieve additional records.Part 5: API Documentation
Official API documentation: https://developers.google.com/calendar/api
I'm trying to import two specific calendars into Google sheets. Under request parameters, I do not have the calendar_id field.
When I attempt to run, I get the following error:
1) : Completed with errors
- We received an error from googleapis.com (403) show response
Nevermind. Simple authorization fix.
OK, cool 🙂 Just let me know if you run into any other issues.
Is there a way to make a formula so that specific cell in google sheets generates and displays the event name that's on a specific google calendar at a specific date and time.
I'm imagining a formula that would be something
=/calendar event (calendar id) (cell with date and time)
Sure, you can use the IMPORTAPI custom function for that. Here are some steps to follow:
1) Save a custom request to
https://www.googleapis.com/calendar/v3/calendars/primary/eventswith OAuth = Google Calendar. Filter out all fields but the event name via the field editor, and tick the box to remove headers.2) Enter your date & time of interest into cell A1
3) In cell B1, convert your timestamp to Google Calendar's required format with this function:
=text(A1,"yyyy-mm-ddThh:mm:ssZ")4) In cell C1, add the following function: =
IMPORTAPI("Events","https://www.googleapis.com/calendar/v3/calendars/primary/events?timeMax="&B1&"&timeMin="&B1Now every time you enter a date into cell A1, the custom function will run and fetch the event for that time.