The CData Sync App provides a straightforward way to continuously pipeline your Google Calendar data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Google Calendar connector can be used from the CData Sync application to pull data from Google Calendar and move it to any of the supported destinations.
The Sync App defaults to version 3 of the Google Calendar API.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Sync App supports using user accounts and GCP instance accounts for authentication.
The following sections discuss the available authentication schemes for Google Calendar:
AuthScheme must be set to OAuth in all user account flows.
Get an OAuth Access Token
Set the following connection properties to obtain the OAuthAccessToken:
Then call stored procedures to complete the OAuth exchange:
Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.
Automatic Refresh of the OAuth Access Token
To have the driver automatically refresh the OAuth access token, set the following on the first data connection:
Manual Refresh of the OAuth Access Token
The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.
Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:
Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.
Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
Option 1: Obtain and Exchange a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL.
Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, you need to re-set the following properties to connect:
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties to connect to data:
When running on a GCP virtual machine, the Sync App can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Google Calendar Sync App.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
| Scope | Description |
| googleapis.com/auth/calendar | While Google Calendar provides read-only scopes, the driver only surfaces the full one. This scope is required for full access to read and write permissions. |
| googleapis.com/auth/calendar.events | This scope is required for read-only access. |
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
| Domain | Always Required | Description |
| accounts.google.com | TRUE | The subdomain used for OAuth. |
| googleapis.com | TRUE | The domain used for accessing various services. |
This section details a selection of advanced features of the Google Calendar Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App models Google Calendar APIs as relational tables, views, and stored procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
The Sync App dynamically retrieves table definitions for the calendars accessible to your account. Tables describes the columns for a sample calendar as well as the Calendars table, which can be used to list, create, modify, and delete calendars.
Views offer additional metadata information from Google Calendar to surface other aspects of a calendar.
Stored Procedures are function-like interfaces to the data source.
When working with events and their related entities through: EventsAttachments, AllCalendars, or dynamic event tables, only single events and recurring events (with their exceptions) are included by default, but not recurring event instances. To change this behavior, you can use EventsScope.
Note: Exceptions are recurring event instances that differ from their parent recurring event in any way.
Note: Single events are non-recurring events.
When working with events and their related entities through: EventsAttachments, AllCalendars, or dynamic event tables, deleted/canceled events are not included by default. To change this behavior, you can enable ShowDeleted or use the pseudo-column in the corresponding table/view. In that case, events with the status 'canceled' are included in the results. The value specified in the pseudo-column takes higher precedence than the value specified in ShowDeleted.
The Sync App models the data in Google Calendar as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| AccessControlRules | Create, update, delete, and query access control rules to calendars' resources. |
| AllCalendars | Create, update, delete, and query all calendar events in your Google Account. |
| Calendars | Create, update, delete, and query calendars in Google. |
| MyCalendar | Create, update, delete, and query events of the calendar. |
Create, update, delete, and query access control rules to calendars' resources.
To query access control rules of all calendars you can execute a query as below.
SELECT * FROM [AccessControlRules]
The CalendarId, and Id and CalendarId (both specified at the same time) columns support server side filtering only for the = operator.
To query the access control rules of a certain calendar you will need to specify the CalendarId as a WHERE clause criterion.
SELECT * FROM [AccessControlRules] WHERE CalendarId = '[email protected]'
To query a specific access control rule of a certain calendar you will need to specify the CalendarId and Id as WHERE clause criteria.
SELECT * FROM [AccessControlRules] WHERE CalendarId = '[email protected]' AND Id = 'domain:cdatatest.page'
To add a new access control rule to a specific calendar, for example to share the calendar with a user, group or domain, or to make the calendar publicly available (ScopeType='default'), you will need to at least specify the CalendarId, Role, ScopeType and optionally the ScopeValue (required if you haven't specified the default ScopeType).
For example, to share a calendar with a specific user you can execute a query as below.
INSERT INTO [AccessControlRules] (CalendarId, Role, ScopeType, ScopeValue) VALUES ('[email protected]', 'writer', 'user', '[email protected]')
For example, to share a calendar with a specific domain you can execute a query as below.
INSERT INTO [AccessControlRules] (calendarId, Role, ScopeType, ScopeValue, SendNotification) VALUES ('[email protected]', 'writer', 'domain', 'cdatatest.page', 'true')
Note: Sharing a calendar with a user no longer automatically inserts the calendar into their CalendarList. If the user should be able to perform CRUD operations on the shared calendar, they will need to execute an INSERT statement by specifying at least the existing CalendarId in the statement. For more information, refer to the Calendars table section.
To update an access control rule of a specific calendar, you will need to specify the CalendarId along with the Id in the WHERE clause criteria.
UPDATE [AccessControlRules] SET Role = 'writer', ScopeType = 'user' WHERE Id = 'user:[email protected]' AND CalendarId = '[email protected]'
To delete an access control rule from a specific calendar, you will need to specify the CalendarId along with the Id in the WHERE clause criteria.
DELETE FROM [AccessControlRules] WHERE Id = 'user:[email protected]' AND CalendarId = '[email protected]'
| Name | Type | ReadOnly | Description |
| CalendarId [KEY] | String | False |
The calendar identifier. |
| Id [KEY] | String | True |
The identifier of the ACL rule. |
| Etag | String | True |
The ETag of the resource. |
| Kind | String | True |
The type of the resource. |
| Role | String | False |
The role assigned to the scope. Possible values are: none, freeBusyReader, reader, writer and owner. |
| ScopeType | String | False |
The type of the scope. Possible values are: default, user, group and domain. |
| ScopeValue | String | False |
The email address of a user or group, or the name of a domain, depending on the scope type. Not applicable for type 'default'. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SendNotification | String |
This value sets whether or not to send notifications about the calendar sharing change. The default value is True. |
Create, update, delete, and query all calendar events in your Google Account.
This is an example on how all calendar events in your account are exposed in a single table.
Query events of all calendars.
SELECT * FROM [AllCalendars]
Create a new event in a certain calendar. At least StartDateTime, EndDateTime and CalendarId must be specified.
INSERT INTO [AllCalendars] (Summary, Description, StartDateTime, EndDateTime, CalendarId) VALUES ('Great Event', 'Description for event', '8/27/2017', '8/28/2017', '[email protected]')
You can create an All-Day event by setting the StartDate and EndDate columns to the actual start and end dates of the event.
INSERT INTO [AllCalendars] (Summary, Description, StartDate, EndDate, CalendarId) VALUES ('Google Cal Test Event 1', 'Example All Day Event', '2017-01-01', '2017-01-09', '[email protected]')
You can create a Time Limited event by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event.
INSERT INTO [AllCalendars] (Summary, Description, StartDateTime, EndDateTime, CalendarId) VALUES ('Google Cal Test Event 2', 'Example Time Limited Event', '2017-09-05T22:13:03', '2017-09-11T13:24:10', '[email protected]')
Update details of a specific event. At least the Id of the event being updated must be specified.
UPDATE AllCalendars SET Summary = 'Test Event' WHERE id = '6bjelf33p0al4d8ei5ft5ghqjs' AND CalendarId = '[email protected]'
You can update a Time Limited event to an All-Day one by setting the StartDate and EndDate columns to the actual start and end dates of the event, and the StartDateTime and EndDateTime columns to Null-s.
UPDATE [AllCalendars] SET StartDate = '2017-09-05', EndDate = '2017-09-11', StartDateTime = NULL, EndDateTime = NULL WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'
You can update an All-Day event to a Time Limited one by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event, and the StartDate and EndDate columns to Null-s.
UPDATE [AllCalendars] SET StartDate = NULL, EndDate = NULL, StartDateTime = '2017-09-05T22:13:03', EndDateTime = '2017-09-11T13:24:10' WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'
Delete an event from AllCalendars by specifying at least its Id.
DELETE FROM [AllCalendars] WHERE Id = '8ba774m3anenroqcepfi7ka6ok' AND CalendarId = '[email protected]'
When you query from AllCalendars table, the events will not be ordered by the StartDate, but rather by the CalendarId. You can order the calendars by either the StartDate or StartDateTime column, depending if the event is an AllDayEvent or not. Alternatively, you can order both Event types using the example query below.
SELECT CalendarId, Id, Summary,
CASE
WHEN StartDateTime IS NULL THEN startDate
ELSE StartDateTime
END AS EventDate
FROM AllCalendars ORDER BY EventDate ASC
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Id of the event. |
| CalendarId [KEY] | String | True |
Calendar Id. |
| Summary | String | False |
The title of the event. |
| Description | String | False |
The description of the event. |
| Location | String | False |
The geographic location of the event as free-form text. |
| AllDayEvent | Boolean | True |
This value indicates whether or not the event is an all-day event. |
| StartDate | Date | False |
The start date if this is an all-day event. |
| StartDateTime | Datetime | False |
The (inclusive) start time of the event. For a recurring event, this value is the start time of the first instance. |
| StartDateTimeZone | String | False |
The time zone in which the start date time is specified. |
| EndDate | Datet | False |
The end date if this is an all-day event. |
| EndDateTime | Datetime | False |
The (exclusive) end time of the event. For a recurring event, this value is the end time of the first instance. |
| EndDateTimeZone | String | False |
The time zone in which the end date time is specified. |
| OriginalStartTimeDateTime | Datetime | False |
For an instance of a recurring event, this value is the time when the event would start according to the recurrence data in the recurring event identified by RecurringEventId. |
| SendNotification | Boolean | False |
This value sets whether to send a notification when performing an insert or update. |
| Kind | String | True |
The type of the resource, returned in the format calendar#event. |
| ETag | String | True |
The ETag of the resource. |
| Status | String | False |
The status of the event. |
| HTML_Link | String | True |
The absolute link to the event in the Google Calendar Web UI. |
| Created | Datetime | True |
The creation time of the event. |
| Updated | Datetime | True |
The latest modification time of the event. |
| ColorId | Integer | False |
The color of the event. This value is an Id referring to an entry in the event section of the colors definitions. |
| CreatorEmail | String | True |
The creator's email address, if available. |
| CreatorDisplayName | String | True |
The creator's name, if available. |
| OrganizerEmail | String | False |
The organizer's email address, if available. |
| OrganizerDisplayName | String | False |
The organizer's name, if available. |
| Recurrences | String | False |
A pipe-separated list of RRULE, EXRULE, RDATE, and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events. OriginalStartTimeDateTime must be set in order to modify this value. |
| RecurringEventId | String | True |
For an instance of a recurring event, this value is the event Id of the recurring event itself. |
| Transparency | String | False |
This value sets whether the event blocks time on the calendar. If set to transparent, the event does not block time on the calendar. If set to opaque, the event blocks time; this is the default value. |
| Visibility | String | False |
The visibility of the event. |
| ICalUid | String | True |
The event Id in the iCalendar format. |
| Sequence | String | False |
The sequence number as per iCalendar. |
| AttendeesEmails | String | False |
A comma-separated list of attendee's email addresses, if available. |
| AttendeesDisplayNames | String | False |
A comma-separated list of attendee's names, if available. |
| AttendeesOmitted | Boolean | True |
This field sets whether attendees have been omitted from the event's representation. When updating an event, this field can be used to update only the participant's response. When retrieving an event, the attendees that are returned are restricted to only the participant by the MaxAttendees query parameter. |
| ExtendedPropertiesPrivateKey | String | False |
This field contains properties that are private to the copy of the event that appears on the calendar. |
| ExtendedPropertiesPrivateValue | String | False |
This field contains properties that are private to the copy of the event that appears on the calendar. |
| ExtendedPropertiesSharedKey | String | False |
This field contains properties that are shared between copies of the event on other attendees' calendars. |
| ExtendedPropertiesSharedValue | String | False |
This field contains properties that are shared between copies of the event on other attendees' calendars. |
| GuestsCanInviteOthers | Boolean | False |
This value sets whether attendees other than the organizer can invite others to the event. |
| GuestsCanSeeOtherGuests | Boolean | False |
This value sets whether attendees other than the organizer can see who the event's attendees are. |
| GuestsCanModify | Boolean | False |
Whether attendees other than the organizer can modify the event. |
| PrivateCopy | Boolean | True |
This value sets whether this is a private event copy where changes are not shared with other copies on other calendars. |
| RemindersUseDefault | Boolean | False |
This value sets whether the default reminders of the calendar apply to the event. |
| ReminderOverrideMethods | String | False |
A comma-separated list of the methods used by the reminder. The possible values are EMAIL, SMS, and POPUP. |
| ConferenceId | String | False |
The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. |
| ConferenceNotes | String | False |
Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. |
| ConferenceSignature | String | False |
The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| ConferenceSolutionName | String | False |
The user-visible name of this solution. Not localized. |
| ConferenceSolutionKeyType | String | False |
The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers. |
| ConferenceSolutionIconUri | String | False |
The user-visible icon for this solution. |
| ConferenceRequestId | String | False |
The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. |
| ConferenceRequestKey | String | False |
The conference solution, such as Hangouts or Hangouts Meet. |
| ConferenceRequestKeyType | String | False |
The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers. |
| ConferenceRequestStatus | String | False |
The status of the conference create request. |
| ConferenceRequestStatusCode | String | True |
The current status of the conference create request. The possible values are: (1) |
| ConferenceEntryPointsAggregate | String | False |
Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. |
| ReminderOverrideMinutes | String | False |
A comma-separated list of the minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger. |
| EventType | String | False |
Specific type of the event. Read-only. Possible values are: 'default' - A regular event or not further specified. 'outOfOffice' - An out-of-office event. 'focusTime' - A focus-time event. 'workingLocation' - A working-location event. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SearchTerms | String |
Free text search terms to find events that match these terms in any field, except for extended properties. |
| ShowDeleted | Boolean |
Whether to list cancelled events. |
Create, update, delete, and query calendars in Google.
When selecting calendars no fields are required. In addition an Id can be specified for filtering the result. For example:
SELECT Id, Summary, Description FROM Calendars
To insert a new calendar, issue an INSERT statement and specify a value for at least the Summary column. For example:
INSERT INTO Calendars (Summary) VALUES ('My Custom Calendar')
To insert an existing calendar, a shared one or a global/domain public one, into the user's calendars list, you will need to execute an INSERT statement by specifying at least the existing CalendarId in the statement.
For example, to add a shared calendar from a specific user, you can execute a query as below.
INSERT INTO Calendars (Id) VALUES ('[email protected]')
For example, to add a public calendar, you can execute a query as below.
INSERT INTO Calendars (id, SummaryOverride) VALUES ('en.usa#[email protected]', 'Official Holidays in the US')
To update a calendar, the Id column must be specified. Only the Description, Location, Summary, and Timezone columns are updateable. For example:
UPDATE Calendars SET Description = 'Updated Description' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'
Delete a calendar by specifying its Id. For example:
DELETE FROM Calendars WHERE Id = '123456789'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The calendar identifier. |
| Summary | String | False |
The title of the calendar. |
| Description | String | False |
The description of the calendar. |
| Kind | String | True |
The type of the resource. |
| ETag | String | True |
The ETag of the resource. |
| Location | String | False |
The geographic location of the calendar as free-form text. |
| Timezone | String | False |
The time zone of the calendar. |
| SummaryOverride | String | False |
The summary that the authenticated user has set for the calendar. |
| ColorId | Integer | False |
The color of the calendar. This is an Id referring to an entry in the 'calendar' section of the colors definition. |
| Hidden | Boolean | False |
This field sets whether the calendar has been hidden from the list. |
| Selected | Boolean | False |
This field sets whether the calendar content shows up in the calendar UI. |
| AccessRole | String | True |
The effective access role that the authenticated user has on the calendar. |
| ReminderMethods | String | False |
A semicolon-separated list of the methods used by the reminder. Possible values are: EMAIL, SMS, and POPUP. |
| ReminderMinutes | String | False |
A semicolon-separated list of minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ShowHidden | Boolean |
This value sets whether to show hidden calendars. The default value is False. |
Create, update, delete, and query events of the calendar.
This is an example on how a calendar is exposed as table.
Query events of the specified calendar.
SELECT * FROM [MyCalendar]
Create a new event in the calendar. At least StartDateTime and EndDateTime must be specified.
INSERT INTO [MyCalendar] (Summary, Description, StartDateTime, EndDateTime) VALUES ('Great Event', 'Description for event', '8/27/2017', '8/28/2017')
You can create an All-Day event by setting the StartDate and EndDate columns to the actual start and end dates of the event.
INSERT INTO [MyCalendar] (Summary, Description, StartDate, EndDate) VALUES ('Google Cal Test Event 1', 'Example All Day Event', '2017-01-01', '2017-01-09')
You can create a Time Limited event by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event.
INSERT INTO [MyCalendar] (Summary, Description, StartDateTime, EndDateTime) VALUES ('Google Cal Test Event 2', 'Example Time Limited Event', '2017-09-05T22:13:03', '2017-09-11T13:24:10')
When inserting a new event, multiple values can be specified for AttendeesEmails and AttendeesDisplayNames.
INSERT INTO [MyCalendar] (StartDateTime, EndDateTime, AttendeesEmails) VALUES ('2017-03-15 15:00', '2017-03-15 20:00', '[email protected],[email protected]')
Update details of a specific event. The Id of the event being updated must be specified.
UPDATE [MyCalendar] SET Summary = 'Updated Summary 2' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'
You can update a Time Limited event to an All-Day one by setting the StartDate and EndDate columns to the actual start and end dates of the event, and the StartDateTime and EndDateTime columns to Null-s.
UPDATE [MyCalendar] SET StartDate = '2017-09-05', EndDate = '2017-09-11', StartDateTime = NULL, EndDateTime = NULL WHERE Id = '8ba774m3anenroqcepfi7ka6ok'
You can update an All-Day event to a Time Limited one by setting the StartDateTime and EndDateTime columns to the actual start and end dates and times of the event, and the StartDate and EndDate columns to Null-s.
UPDATE [MyCalendar] SET StartDate = NULL, EndDate = NULL, StartDateTime = '2017-09-05T22:13:03', EndDateTime = '2017-09-11T13:24:10' WHERE Id = '8ba774m3anenroqcepfi7ka6ok'
Delete an event by specifying its Id.
DELETE FROM [MyCalendar] WHERE Id = '8ba774m3anenroqcepfi7ka6ok'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The Id of the event. |
| CalendarId | String | False |
Calendar Id. This can be used to override the Calendar Id for which you are querying events. |
| Summary | String | False |
The title of the event. |
| Description | String | False |
The description of the event. |
| Location | String | False |
The geographic location of the event as free-form text. |
| AllDayEvent | Boolean | True |
This value indicates whether or not the event is an all-day event. |
| StartDate | Date | False |
The start date if this is an all-day event. |
| StartDateTime | Datetime | False |
The (inclusive) start time of the event. For a recurring event, this value is the start time of the first instance. |
| StartDateTimeZone | String | False |
The time zone in which the start date time is specified. |
| EndDate | Date | False |
The end date if this is an all-day event. |
| EndDateTime | Datetime | False |
The (exclusive) end time of the event. For a recurring event, this value is the end time of the first instance. |
| EndDateTimeZone | String | False |
The time zone in which the end date time is specified. |
| OriginalStartTimeDateTime | Datetime | False |
For an instance of a recurring event, this value is the time when the event would start according to the recurrence data in the recurring event identified by RecurringEventId. |
| SendNotification | Boolean | False |
This value sets whether to send a notification when performing an insert or update. |
| Kind | String | True |
The type of the resource, returned in the format calendar#event. |
| ETag | String | True |
The ETag of the resource. |
| Status | String | False |
The status of the event. |
| HTML_Link | String | True |
The absolute link to the event in the Google Calendar Web UI. |
| Locked | Boolean | True |
Whether this is a locked event copy where no changes can be made to the main event fields |
| SourceTitle | String | False |
Title of the source; for example a title of a web page or an email subject. |
| SourceURL | String | False |
URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS. |
| HangoutLink | String | True |
An absolute link to the Google+ hangout associated with this event, if there is any. |
| Created | Datetime | True |
The creation time of the event. |
| Updated | Datetime | True |
The latest modification time of the event. |
| ColorId | Integer | False |
The color of the event. This value is an Id referring to an entry in the event section of the colors definitions. |
| CreatorEmail | String | True |
The creator's email address, if available. |
| CreatorDisplayName | String | True |
The creator's name, if available. |
| OrganizerEmail | String | True |
The organizer's email address, if available. |
| OrganizerDisplayName | String | True |
The organizer's name, if available. |
| Recurrences | String | False |
A pipe-separated list of RRULE, EXRULE, RDATE, and EXDATE lines for a recurring event. This field is omitted for single events or instances of recurring events. OriginalStartTimeDateTime must be set in order to modify this value. |
| RecurringEventId | String | True |
For an instance of a recurring event, this value is the event Id of the recurring event itself. |
| Transparency | String | False |
This value sets whether the event blocks time on the calendar. If set to transparent, the event does not block time on the calendar. If set to opaque, the event blocks time; this is the default value. |
| Visibility | String | False |
The visibility of the event. |
| ICalUid | String | True |
The event Id in the iCalendar format. |
| Sequence | String | False |
The sequence number as per iCalendar. |
| AttendeesEmails | String | False |
A comma-separated list of attendee's email addresses, if available. |
| AttendeesDisplayNames | String | False |
A comma-separated list of attendee's names, if available. |
| AttendeesResponseStatus | String | False |
A comma-separated list of attendee's response status, if available. |
| AttendeesOmitted | Boolean | True |
This field sets whether attendees have been omitted from the event's representation. When updating an event, this field can be used to update only the participant's response. When retrieving an event, the attendees that are returned are restricted to only the participant by the MaxAttendees query parameter. |
| ExtendedPropertiesPrivateKey | String | False |
This field contains properties that are private to the copy of the event that appears on the calendar. |
| ExtendedPropertiesPrivateValue | String | False |
This field contains properties that are private to the copy of the event that appears on the calendar. |
| ExtendedPropertiesSharedKey | String | False |
This field contains properties that are shared between copies of the event on other attendees' calendars. |
| ExtendedPropertiesSharedValue | String | False |
This field contains properties that are shared between copies of the event on other attendees' calendars. |
| GuestsCanInviteOthers | Boolean | False |
This value sets whether attendees other than the organizer can invite others to the event. |
| GuestsCanSeeOtherGuests | Boolean | False |
This value sets whether attendees other than the organizer can see who the event's attendees are. |
| GuestsCanModify | Boolean | False |
Whether attendees other than the organizer can modify the event. |
| PrivateCopy | Boolean | True |
This value sets whether this is a private event copy where changes are not shared with other copies on other calendars. |
| RemindersUseDefault | Boolean | False |
This value sets whether the default reminders of the calendar apply to the event. |
| ReminderOverrideMethods | String | False |
A comma-separated list of the methods used by the reminder. The possible values are EMAIL, SMS, and POPUP. |
| ReminderOverrideMinutes | String | False |
A comma-separated list of the minutes before the start of the event when the corresponding ReminderOverrideMethod should trigger. |
| ConferenceId | String | False |
The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. |
| ConferenceNotes | String | False |
Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. |
| ConferenceSignature | String | False |
The signature of the conference data. Generated on server side. Must be preserved while copying the conference data between events, otherwise the conference data will not be copied. |
| ConferenceSolutionName | String | False |
The user-visible name of this solution. Not localized. |
| ConferenceSolutionKeyType | String | False |
The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers. |
| ConferenceSolutionIconUri | String | False |
The user-visible icon for this solution. |
| ConferenceRequestId | String | False |
The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored. |
| ConferenceRequestKey | String | False |
The conference solution, such as Hangouts or Hangouts Meet. |
| ConferenceRequestKeyType | String | False |
The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. Valid values are: (1) 'eventHangout' for Hangouts for consumers (http://hangouts.google.com) -- (2) 'eventNamedHangout' for classic Hangouts for G Suite users (http://hangouts.google.com) -- (3) 'hangoutsMeet' for Hangouts Meet (http://meet.google.com) -- (4) 'addOn' for 3P conference providers. |
| ConferenceRequestStatus | String | False |
The status of the conference create request. |
| ConferenceRequestStatusCode | String | True |
The current status of the conference create request. The possible values are: (1) |
| ConferenceEntryPointsAggregate | String | False |
Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. |
| EventType | String | False |
Specific type of the event. Read-only. Possible values are: 'default' - A regular event or not further specified. 'outOfOffice' - An out-of-office event. 'focusTime' - A focus-time event. 'workingLocation' - A working-location event. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| SearchTerms | String |
Free text search terms to find events that match these terms in any field, except for extended properties. |
| ShowDeleted | Boolean |
Whether to list canceled events. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Colors | Query colors for Google calendars and events. |
| EventsAttachments | Query the attachments metadata from the events in your Google calendar. |
Query colors for Google calendars and events.
Returns the color definitions for calendars and events.
SELECT * FROM Colors
| Name | Type | Description |
| Id [KEY] | String | The unique color identifier composed of the color type and Id separated by the pipe character. |
| EntityType [KEY] | String | The type of the entity the color is specified for. It can be either Calendar or Event |
| ColorBackground | String | The background color for the calendar color. |
| ColorForeground | String | The foreground color for the calendar color. |
| Updated | Datetime | The last time the list of colors was updated. |
Query the attachments metadata from the events in your Google calendar.
To query attachments metadata of all events in a certain calendar you will need to specify the CalendarId as a WHERE clause criterion.
SELECT * FROM EventsAttachments WHERE CalendarId = 'df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com'
To query attachments metadata for only a specific recurring event in a certain calendar you will need to specify the CalendarId and the ParentEventId (the recurring event's Id) as WHERE clause criteria.
SELECT * FROM EventsAttachments WHERE CalendarId = 'df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com' AND ParentEventId = '4fbitolj1eb2ilbspcm2l5jcvc'
To query attachments metadata of all events in multiple calendars you will need to specify their CalendarIds by using an IN clause criterion.
SELECT * FROM EventsAttachments WHERE CalendarId IN ('df5bf39459e666e1f6835a287923a083f83bfbe21113051b2759a9f2fa40a7c9@group.calendar.google.com', '8aab717ee7e6fca501e1e178e590f3ac4ac0c2660361fdff47b8c341eb379559@group.calendar.google.com')
| Name | Type | Description |
| CalendarId | String | The calendar identifier. |
| EventId [KEY] | String | The event identifier. |
| ParentEventId | String | The event instance identifier of a recurring event instance. |
| EventStatus | String | The status of the event. |
| FileId | String | The Google Drive file identifier of the attachment, if the attachment is located in a GoogleDrive. |
| FileURL [KEY] | String | The URL link to the attachment. |
| Title | String | The name of the attachment. |
| MimeType | String | The internet media type (MIME type) of the attachment. |
| IconLink | String | The URL link to the attachment's icon. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ShowDeleted | Boolean | Whether to list cancelled events. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Google Calendar. |
| Property | Description |
| EventsScope | Specifies the event types to expose in the Data Model. |
| ShowDeleted | Whether to include deleted events when listing events. |
| SupportsAllDrives | Determines whether or not to retrieve items from shared Drives. |
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| DelegatedServiceAccounts | A space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | A service account email to make a delegated request. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Google Calendar. |
The type of authentication to use when connecting to Google Calendar.
This section provides a complete list of the Connection properties you can configure in the connection string for this provider.
| Property | Description |
| EventsScope | Specifies the event types to expose in the Data Model. |
| ShowDeleted | Whether to include deleted events when listing events. |
| SupportsAllDrives | Determines whether or not to retrieve items from shared Drives. |
Specifies the event types to expose in the Data Model.
| UNIQUE | Includes single events and recurring events (with their exceptions), but not recurring event instances. |
| SINGLE | Includes single events and recurring events, but not recurring event instances and their exceptions. |
| ALL | Includes single events and all recurring event instances (but not their underlying parent events). |
Whether to include deleted events when listing events.
When set to True, events with the status 'canceled' are included in query results. Otherwise, they are omitted.
Determines whether or not to retrieve items from shared Drives.
If you set this property to 'true', you can download attachments from any Drive.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| DelegatedServiceAccounts | A space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | A service account email to make a delegated request. |
The client Id assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
A space-delimited list of service account emails for delegated requests.
The service account emails must be specified in a space-delimited list.
Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.
The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.
Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.
A service account email to make a delegated request.
The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.
You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
This property can take one of the following values:
| USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
| BCFKSFILE | The certificate store is the name of a file that contains an Bouncy Castle keystore. |
| BCFKSBLOB | The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore. |
| GOOGLEJSON | The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service. |
| GOOGLEJSONBLOB | The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service. |
The password for the OAuth JWT certificate.
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.
The subject of the OAuth JWT certificate.
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
The issuer of the Java Web Token.
The issuer of the Java Web Token. Enter the value of the service account email address.
This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.
The user subject for which the application is requesting delegated access.
The user subject for which the application is requesting delegated access. Enter the email address of the user for which the application is requesting delegated access.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Sync App opens a connection to Google Calendar and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server.
This connection property takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to False in order to use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port that the proxy server (specified in the ProxyServer connection property) is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connnection property.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
The password associated with the user specified in the ProxyUser connection property.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\GoogleCalendar Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows. |
| Other | These hidden properties are used only in specific use cases. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |
Configuration properties to provide when using Workload Identity Federation via AWS.
The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted.
For example, this setting authenticates in AWS using a user's root keys:
AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. LIMIT clauses take precedence over the limit specified in MaxRows.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specify a set of pseudocolumns to expose as columns.
The value of this connection setting is of the format "Table1=Column1;Table1=Column2;Table2=Column3".
You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM MyCalendar WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.
Boolean determining if simple names should be used for tables and columns.
Google Calendar tables and columns can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the Sync App easier to use with traditional database tools.
Setting UseSimpleNames to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
The ID of your Workload Identity Federation pool.
The ID of your Workload Identity Federation pool.
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
The ID of your Workload Identity Federation pool provider.
The ID of your Workload Identity Federation pool provider.