Get Calendar Events into your Spreadsheet using the Calendar API and Google Apps Script

July 07, 2021
Get Calendar Events into your Spreadsheet using the Calendar API and Google Apps Script
Table of Contents
Table of Contents

Welcome to the Calendar API Tutorial Series.

What is the Google Calendar API?


The Google Calendar API lets you integrate Google Sheets with Google Calendar.
In this series you will be learning how to do the following actions with Google Apps Script:
          (1)  Importing events from your Google Calendar into your Google Sheets
          (2)  Add Google Meet links to Calendar Events

Welcome to the first part of the Calendar API Tutorial Series.

In this blog, I am going to show you how to create calendar events from a Google Sheet using the Calendar API and Google Apps Script.

So let’s get started.

If you prefer to watch a video instead of read, we've got you covered:

Step 1: Sample Google Sheet

The Google Sheet that I will be using in this blog, contains the following details. If you prefer working with the sheet click here.

  1. Name of the Event
  2. Start date/time of the Event
  3. End date/time of the Event
  4. Location of the Event
  5. Description of the Event
  6. Visibility of the Event
  7. Start Date/Time
  8. End Date/Time
  9. Calendar ID

Step 2: Add the Google Calendar API

  1. To add the Google Calendar API, follow these steps:
    Open the Script Editor. To open the Script Editor, follow these steps :
     
    (1) Click on the Tools button next to the Add-ons button.

(2) Next click on the Script Editor option. This brings up the Script Editor as
      shown below.

We have reached the Script Editor.

(3) Go to the left side of the Script Editor and click on the Add a Service button.

On clicking on Add a Service, you will see the following Services you can add to your Google Apps Script Project.

Scroll down to Google Calendar API and select it.

After selecting the Google Calendar API, click on Add.

The Google Calendar API has successfully been added to the Project.

Step 3: Write the Automation Script

We have already opened the Script Editor, it’s time to write the script.

function create_Events(){
(1)  var ss = SpreadsheetApp.getActiveSpreadsheet();
(2)  var sheet = ss.getSheetByName("GetEvents");
(3)  var id_cal = sheet.getRange(“C2”).getValue();
(4)  var cal= CalendarApp.getCalendarById(id_cal);

Declaring the function :

  1. Get the Active Spreadsheet
  2. Get the sheet by name
  3. Get the Calendar ID from the sheet using the getRange function followed by getting the value
  4. Next using the CalendarApp and the calendar ID we have got the calendar.

To get the Calendar ID, follow these steps :

  1. Open your Google Calendar
  2. Select the Calendar that you are going to use and click on the three dots next to it.

3. Click on Settings and Sharing

4. Scroll down to Integrate Calendar.

Copy the Calendar ID and paste it into the getCalendarById function.

(1)   var start_time = sheet.getRange(“G2”).getValue();
(2)   var end_time  = sheet.getRange(“H2”).getValue();
(3)   var events = cal.getEvents(new Date(start_time), new Date(end_time));	

Here we have got the start and end time from the sheet, between which we want all the events. To do that we have used the getRange function and specified the range followed by getting the values using the getValue function.

Now, whenever the user wants to change the start and end time all he has to do is change the details in the sheet and run the script.

These values will be stored in the events variable. We are going to do this using the getEvents function followed by the start date and end date.

for(var i = 0;i<events.length;i++){
    var title = events[i].getTitle();
    var start_time = events[i].getStartTime();
    var end_time = events[i].getEndTime();
    var loc = events[i].getLocation();
    var des = events[i].getDescription();
    var vis = events[i].getVisibility(); 

Here we have created a for loop that will go through all the events that we created in the Google Calendar. Using the for loop we are going to get the following details from the events in the Google Calendar :

  1. Title of the event
  2. Start time of the event
  3. End time of the event
  4. Location of the event
  5. Description of the event
  6. Visibility of the Event
sheet.getRange(i+5,1).setValue(title);
sheet.getRange(i+5,2).setValue(start_time);
sheet.getRange(i+5,3).setValue(end_time);
sheet.getRange(i+5,4).setValue(loc);
sheet.getRange(i+5,5).setValue(des);
sheet.getRange(i+5,6).setValue(vis);
   }
Logger.log("Events have been added to the Spreadsheet");
     }

Now that we have got all the calendar events in the variables. It's time to send the data back to the sheet. To do that we are going to start by getting the range followed by setting the values using the setValue command, followed by the variable that you want to set. Here the i+5 denotes the 5th row in the sheet and the 1 specifies the column. The column number keeps increasing with new values.

After we set the values we print a confirmatory message using the Logger.log function that says “Events have been added to the Spreadsheet”.

We are done with our code.

Step 4: Check the Output

Our code is complete. Select the correct function (getEvents) as shown below and run the program. Or you can run the code using a trigger, macros and more. Check out the link below to know more.

On successful execution, the script will add all the events to the Spreadsheet.

Here you can see all the details have come into the sheet :

  1. Title of the event
  2. Start and End time of the event
  3. Location and Description of the event
  4. Visibility of the Event

Summary

We saw how you can get events into your Spreadsheet using the Calendar API and Google Apps Script. To sum up :

  1. Created the spreadsheet
  2. Added some events to the Google Calendar
  3. Accessed the sheet by name
  4. Got the Calendar by ID
  5. Specified the start date and end date between which we want the events
  6. Created a for loop to go through each of the events in the Google Calendar
  7. Stored all the event details into variables
  8. Set the values back into the sheet

I hope you have understood how to add Calendar Events into your spreadsheet using the Google Calendar API and Google Apps Script. In the next blog, I am going to show you how to Create Calendar Events in Google Calendar using the Google Calendar API and Google Apps Script. You can send your feedback to aryanirani123@gmail.com.




Great! Next, complete checkout for full access to The Yet Another Mail Merge Blog
Welcome back! You've successfully signed in
You've successfully subscribed to The Yet Another Mail Merge Blog
Success! Your account is fully activated, you now have access to all content
Success! Your billing info has been updated
Your billing was not updated