Google Cloud | Calendar

The Google Calendar API lets you integrate your app with Google Calendar, creating new ways for you to engage your users. The Calendar API lets you display, create and modify calendar events as well as work with many other calendar-related objects, such as calendars or access controls.

API Resources

Google Calendar uses the following resources:

 

• Event: An event on a calendar containing information such as the title, start and end times, and attendees. Events can be either single events or recurring events. An event is represented by an Event resource. The Events collection for a given calendar contains all event resources for that calendar.
• Calendar: A calendar is a collection of events. Each calendar has associated metadata, such as calendar description or default calendar time zone. The metadata for a single calendar is represented by a Calendar resource. The Calendars collection contains Calendar resources for all existing calendars.
• CalendarList: A list of all calendars on a user's calendar list in the Calendar UI. The metadata for a single calendar that appears on the calendar list is represented by a CalendarListEntry resource. This metadata includes user-specific properties of the calendar, such as its color or notifications for new events. The CalendarList collection contains all CalendarListEntry resources for a given user. For a further explanation of the difference betweeen the Calendars and CalendarList collections, see Calendar and Calendar List
• Setting: A user preference from the Calendar UI, such as the user's time zone. A single user preference is represented by a Setting Resource. The Settings collection contains all Setting resources for a given user.
• ACL: An access control rule granting a user (or a group of users) a specified level of access to a calendar. A single access control rule is represented by an ACL resource. The ACL collection for a given calendar contains all ACL resources that grant access to that calendar.
• Color: A color presented in the Calendar UI. The Colors resource represents the set of all colors available in the Calendar UI, in two groups: colors available for events and colors available for calendars.
• Free/busy: A time when a calendar has events scheduled is considered "busy", a time when a calendar has no events is considered "free". The Freebusy resource allows querying for the set of busy times for a given calendar or set of calendars.

 

Main Features

• Fully Featured Google Calendar Client API V3.
• All Methods supported by API can be called using client API.
• Client requests using HTTP/2 protocol (*only Enterprise Edition).
• Automatic Handling of partial responses using PageNextToken.
• Easy access to Calendar and Event data properties.
• Authentication methods:
  • OAuth2: requires user interaction.
  • Service Accounts (requires Domain-Wide Delegation): for windows services, daemons...

 

Configuration

Google Calendar component client has the following properties:

 

OAuth2

 

• GoogleCloudOptions.OAuth2.ClientId: is the ClientID provided by Google to Authenticate through OAuth2 protocol.
• GoogleCloudOptions.OAuth2.ClientSecret: is the Client Secret string provided by Google to Authenticate through OAuth2 protocol.
• GoogleCloudOptions.OAuth2.Scope: is the scope of OAuth2, usually there is no need to modify the default value unless you need to get more access than default.
• GoogleCloudOptions.OAuth2.LocalIP: OAuth2 protocol requires a server listening answer from Authentication server, this is the IP or DNS. By default is 127.0.0.1.
• GoogleCloudOptions.OAuth2.LocalPort: Local server listening port.
• GoogleCloudOptions.OAuth2.RedirectURL: if you need to set a redirect url different from LocalPort + LocalIP, you can set in this property (example: http://127.0.0.1:8080/oauth2).

 

You can modify the Scopes of your client API using Scopes property, just select which scopes are supported by your client.

 

JWT

 

The login is done signing the requests using a private key provided by google, these method is recommended for automated services or applications without user interaction. Requires configure the Service Account with Domain-Wide Delegation.

 

• GoogleCloudOptions.JWT.ClientEmail: is the Client Email name provided creating the new service account. "client_email" node in the JSON configuration file.
• GoogleCloudOptions.JWT.PrivateKeyId: is the Private Key Id provided by google. "private_key_id" node in the JSON configuration file.
• GoogleCloudOptions.JWT.PrivateKey: is the Private Key certificate provided by google. "private_key" node in the JSON configuration file.
• GoogleCloudOptions.JWT.Subject: is the workspace email account linked to the service account using Domain-Wide Delegation.

 

Most common uses

• Configuration

  • Google Calendar Refresh Token

  • Google Calendar Service Account

 

• Synchronization

  • Google Calendar Sync Calendars

  • Google Calendar Sync Events

 

 

Synchronize Calendars

TsgcHTTPGoogleCloud_Calendar_Client component allows to synchronize the calendars using direct Google API calls or using our easy Calendars methods to synchronize the calendars.

 

Method	Parameters	Description
NewCalendar	aSummary: the title of the calendar.	Creates a new Calendar
DeleteCalendar	aId: identifier of the calendar.	Deletes an existing Calendar.
UpdateCalendar	aResource: object with the calendar data.	Updates an existing Calendar.
LoadCalendars		Loads all calendars and Calendars property is filled with this data.
LoadCalendarsChanged	aSyncToken: last token used to update your calendar.	Loads all changes in your calendars from Token set.

 

Calendar Client has a property called Calendars, where you can access to Calendar Data after calling any of previous methods, this property is synchronized automatically.

 

 

Synchronize Events

TsgcHTTPGoogleCloud_Calendar_Client component allows to synchronize the events using direct Google API calls or using our easy Event methods to synchronize the Events.

 

Method	Parameters	Description
NewEvent	aCalendarId: id of the calendar. aResource: object with the event data.	Creates a new Event.
DeleteEvent	aCalendarId: id of the calendar. aId: identifier of the event.	Deletes an existing Event.
UpdateEvent	aCalendarId: id of the calendar. aResource: object with the event data.	Updates an existing Event.
LoadEvents	aCalendarId: id of the calendar.	Loads all events of the calendar.
LoadEventsChanged	aCalendarId: id of the calendar. aSyncToken: last token used to update your calendar.	Loads all events of the calendar from Token set.

 

You can access to events data, using the property Calendars, select any of the existing calendars of the list and accessing to Events property.

 

 

Google Calendar API Calls

Method	Description
ACL_Delete	Deletes an access control rule.
ACL_Get	Returns an access control rule.
ACL_Insert	Creates an access control rule.
ACL_List	Returns the rules in the access control list for the calendar.
ACL_Patch	Updates an access control rule. This method supports patch semantics.
ACL_Update	Updates an access control rule.
ACL_Watch	Watch for changes to ACL resources.

 

 

Method	Description
CalendarList_Delete	Removes a calendar from the user's calendar list.
CalendarList_Get	Returns a calendar from the user's calendar list.
CalendarList_Insert	Inserts an existing calendar into the user's calendar list.
CalendarList_List	Returns the calendars on the user's calendar list.
CalendarList_Patch	Updates an existing calendar on the user's calendar list. This method supports patch semantics.
CalendarList_Update	Updates an existing calendar on the user's calendar list.
CalendarList_Watch	Watch for changes to CalendarList resources.

 

 

Method	Description
Calendar_Clear	Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account.
Calendar_Delete	Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars.
Calendar_Get	Returns metadata for a calendar.
Calendar_Insert	Creates a secondary calendar.
Calendar_Patch	Updates metadata for a calendar. This method supports patch semantics.
Calendar_Update	Updates metadata for a calendar.

 

 

Method	Description
Channel_Stop	Stop watching resources through this channel.

 

 

Method	Description
Color_Get	Returns the color definitions for calendars and events.

 

 

Method	Description
Event_Delete	Deletes an event.
Event_Get	Returns an event.
Event_Import	Imports an event. This operation is used to add a private copy of an existing event to a calendar.
Event_Insert	Creates an event.
Event_Instances	Returns instances of the specified recurring event.
Event_List	Returns events on the specified calendar.
Event_Move	Moves an event to another calendar, i.e. changes an event's organizer.
Event_Patch	Updates an event. This method supports patch semantics. The field values you specify replace the existing values. Fields that you don’t specify in the request remain unchanged. Array fields, if specified, overwrite the existing arrays; this discards any previous array elements.
Event_QuickAdd	Creates an event based on a simple text string.
Event_Update	Updates an event.
Event_Watch	Watch for changes to Events resources.

 

 

Method	Description
Freebusy_Query	Returns free/busy information for a set of calendars.

 

 

Method	Description
Settings_Get	Returns a single user setting.
Settings_List	Returns all user settings for the authenticated user.
Settings_Watch	Watch for changes to Settings resources.

 

 

Switch Account

If you want to switch from one account to another, first call the method Clear, to erase the current calendar session and configure the new session.