Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuhong90/node-google-calendar
Simple node module that supports Google Calendar API
https://github.com/yuhong90/node-google-calendar
calendar events google-api google-calendar promises service-account
Last synced: about 2 months ago
JSON representation
Simple node module that supports Google Calendar API
- Host: GitHub
- URL: https://github.com/yuhong90/node-google-calendar
- Owner: yuhong90
- License: isc
- Created: 2016-05-11T00:08:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-04T00:32:57.000Z (over 4 years ago)
- Last Synced: 2024-07-21T06:51:28.488Z (2 months ago)
- Topics: calendar, events, google-api, google-calendar, promises, service-account
- Language: JavaScript
- Homepage:
- Size: 94.7 KB
- Stars: 83
- Watchers: 10
- Forks: 32
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: License.txt
Awesome Lists containing this project
README
# node-google-calendar
[](https://travis-ci.org/yuhong90/node-google-calendar)
[](https://snyk.io/test/github/yuhong90/node-google-calendar)
Simple node module that supports Google Calendar API
This module does server to server authentication with Google APIs without any users being involved.
When using Google APIs from the server (or any non-browser based application), authentication is performed through a Service Account, which is a special account representing your application.
Find out more about [preparations needed](https://github.com/yuhong90/node-google-calendar/wiki#preparations-needed) to setting up the [service account](https://github.com/yuhong90/node-google-calendar/wiki#setup-service-accounts), grant calendar access, [auth key to google](https://github.com/yuhong90/node-google-calendar/wiki#providing-key-or-keyfile-for-google-oauth) and the configurations needed to start using node-google-calendar.
## Getting Started
First, install the [npm package](https://www.npmjs.com/package/node-google-calendar) with: `npm i node-google-calendar --save`.
Provide in a `settings.js` config file with serviceAcctId, calendarIds, timezone & keyfile location.
Check out [preparations needed](https://github.com/yuhong90/node-google-calendar/wiki#preparations-needed) if you have trouble supplying these configurations. Sample config file [here](https://github.com/yuhong90/node-google-calendar/blob/master/config/Settings.js).
Your config file should look something like this:
```javascript
const KEYFILE = '';
const SERVICE_ACCT_ID = '@.iam.gserviceaccount.com';
const CALENDAR_ID = {
'primary': '@gmail.com',
'calendar-1': '[email protected]',
'calendar-2': '[email protected]'
};
const TIMEZONE = 'UTC+08:00';
module.exports.keyFile = KEYFILE; //or if using json keys - module.exports.key = key;
module.exports.serviceAcctId = SERVICE_ACCT_ID;
module.exports.calendarId = CALENDAR_ID;
module.exports.timezone = TIMEZONE;
```
To use, require this module in your application and pass in the necessary config file.
```javascript
const CONFIG = require('./config/Settings');
const CalendarAPI = require('node-google-calendar');
let cal = new CalendarAPI(CONFIG);
```
You should now be able to query your specified calendar and try out the following examples.
## APIs
Most [Google Calendar APIs v3](https://developers.google.com/google-apps/calendar/concepts/) are now supported! This includes APIs in resource types of [Calendars](https://developers.google.com/google-apps/calendar/v3/reference/calendars),
[CalendarList](https://developers.google.com/google-apps/calendar/v3/reference/calendarList),
[Acl](https://developers.google.com/google-apps/calendar/v3/reference/acl),
[Events](https://developers.google.com/google-apps/calendar/v3/reference/events),
[FreeBusy](https://developers.google.com/google-apps/calendar/v3/reference/freebusy),
[Settings](https://developers.google.com/google-apps/calendar/v3/reference/settings),
[Colors](https://developers.google.com/google-apps/calendar/v3/reference/colors) &
[Channels](https://developers.google.com/google-apps/calendar/v3/reference/channels).
You can refer to Google's documentation on what parameters to supply, and choose to include or exclude the parameters that you need.
Some examples are as follows:
### [CalendarList](https://github.com/yuhong90/node-google-calendar/blob/master/src/CalendarList.js) Examples
CalendarList.list - Returns a promise of a CalendarList of calendar entries and their metadata that the service account has visibility to.
```javascript
let params = {
showHidden: true
};
cal.CalendarList.list(params)
.then(resp => {
console.log(resp);
}).catch(err => {
console.log(err.message);
});
```
### [Acl](https://github.com/yuhong90/node-google-calendar/blob/master/src/Acl.js) Examples
Acl.insert - Granting a user `owner` permission of to a calendar. Calendar entry should be automatically added to user's CalendarList after success. (Appear on calendarlist on left side of Google Calendar's WebUI)
```javascript
let params = {
scope: {
type: 'user',
value: '[email protected]'
},
role: 'owner'
};
cal.Acl.insert(calendarId, params)
.then(resp => {
console.log(resp);
}).catch(err => {
console.log(err.message);
});
```
### [Events](https://github.com/yuhong90/node-google-calendar/blob/master/src/Events.js) Examples
Events.list - To get a promise of all single events in calendar within a time period.
```javascript
let params = {
timeMin: '2017-05-20T06:00:00+08:00',
timeMax: '2017-05-25T22:00:00+08:00',
q: 'query term',
singleEvents: true,
orderBy: 'startTime'
}; //Optional query parameters referencing google APIs
cal.Events.list(calendarId, params)
.then(json => {
//Success
console.log('List of events on calendar within time-range:');
console.log(json);
}).catch(err => {
//Error
console.log('Error: listSingleEvents -' + err.message);
});
```
Events.insert - Insert an event on a specified calendar. Returns promise of details of new event.
```javascript
let params = {
'start': { 'dateTime': '2017-05-20T07:00:00+08:00' },
'end': { 'dateTime': '2017-05-20T08:00:00+08:00' },
'location': 'Coffeeshop',
'summary': 'Breakfast',
'status': 'confirmed',
'description': '',
'colorId': 1
};
cal.Events.insert(calendarId, params)
.then(resp => {
console.log('inserted event:');
console.log(resp);
})
.catch(err => {
console.log('Error: insertEvent-' + err.message);
});
```
Events.delete - Deletes an Event on a specified Calendar with EventId. Returns promise of results.
```javascript
let params = {
sendNotifications: true
};
cal.Events.delete(calendarId, eventId, params)
.then(results => {
console.log('delete Event:' + JSON.stringify(results));
}).catch(err => {
console.log('Error deleteEvent:' + JSON.stringify(err.message));
});
```
Events.patch - Specify part of an **existing** event to modify. Returns promise of results.
Must specify the eventId (the "id" of an event) and any fields you'd like to modify. All other fields remain untouched.
```javascript
cal.Events.patch(calendarId, eventId, {
summary: "updated summary",
...
...
})
.then(results => {
console.log("patched Event:" + JSON.stringify(results));
})
.catch(err => {
console.log("Error patchedEvent:" + JSON.stringify(err.message));
});
})
```
### [FreeBusy](https://github.com/yuhong90/node-google-calendar/blob/master/src/FreeBusy.js) Examples
FreeBusy.query - Checks if queried calendar slot is busy during selected period. Returns promise of list of events at specified slot.
```javascript
let params = {
"timeMin": '2017-05-20T08:00:00+08:00',
"timeMax": '2017-05-20T09:00:00+08:00',
"items": [{ "id": calendarId }]
};
cal.FreeBusy.query(calendarId, params)
.then(resp => {
console.log('List of busy timings with events within defined time range: ');
console.log(resp);
})
.catch(err => {
console.log('Error: checkBusy -' + err.message);
});
```
### [Settings](https://github.com/yuhong90/node-google-calendar/blob/master/src/Settings.js) Examples
Settings.list - List user settings
```javascript
let params = {};
cal.Settings.list(params)
.then(resp => {
console.log('List settings: ');
console.log(resp);
})
.catch(err => {
console.log('Error: listSettings -' + err.message);
});
```
More code examples of the various APIs [here](https://github.com/yuhong90/node-google-calendar/tree/master/example).