Source Providers
Google Calendar
Content Source based on Google Calendar.
The Google Calendar source feeds data from the Google Calendar service. Based on the multi-instance source workflow it allows connecting to multiple accounts with different configurations.
Settings
The source settings determines the content structure, every time the instance is saved the structure will be regenerated.
| Setting | Description | Required |
|---|---|---|
| Account | The Google account which to authenticate with. | ✓ |
| Calendar | The Google calendar which data to create the source with. | ✓ |
The following settings are common to all source instances.
| Setting | Default | Description |
|---|---|---|
| Name | Google Calendar | The name that will identify this source instance. |
| Default Cache Time | 3600 | The default duration in seconds before the cache is renewed, set to 0 to disable caching. This setting can be overriden in each query configuration. |
Content Structure
Be cautious, changing certain settings of an instance might affect it content structure and break existing content mappings.
Authentication
Authentication is based on the OAuth protocol driven by the Google OAuth Driver.
Content Queries
For every source instance the following content queries will be made available as Dynamic Content option.
Calendar Query
Fetches the Calendar data resolving to a Calendar Type.
| Setting | Default | Description |
|---|---|---|
| Cache | 3600 | The duration in seconds before the cache is invalidated and the query re-executed. |
Event Query
Fetches a single event from the calendar and resolves to a Event Type.
| Setting | Default | Description | Required |
|---|---|---|---|
| Event ID | The ID of the event to query. | ✓ | |
| Cache | 3600 | The duration in seconds before the cache is invalidated and the query re-executed. |
Events Query
Fetches events from the calendar and resolves to a list of Event Type.
| Setting | Default | Description |
|---|---|---|
| Query | Optionaly filter matching terms in the summary, description, location, attendee's displayName and attendee's email fields. | |
| Single Events Only | Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. | |
| Order By | The order by which to query the events, Start Time (asc) or Updated (asc). | |
| Quantity | 250 | The maximum amount of events to query. |
| Time Min / Max | Lower and Upper bounds (exclusive) for an event's start or end time to filter by. | |
| Cache | 3600 | The duration in seconds before the cache is invalidated and the query re-executed. |
Content Types
The content types define the mapping options for the source content.
Calendar Type
Defines the mapping options of a Calendar object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Unique identifier of the calendar. | String | |
| Summary | Title of the calendar. | String | Limit |
| Description | Description of the calendar. | String | Limit |
| Location | Geographic location of the event as free-form text. | String | Limit |
| Time Zone | The calendars default time zone. | String |
Event Type
Defines the mapping options of an Event object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Opaque identifier of the event. | String | |
| URL | An absolute link to the event in the Google Calendar Web UI. | String | |
| Type | Specific type of the event, default, outOfOffice, focusTime or workingLocation. | String | |
| Status | Status of the event, confirmed, tentative or cancelled. - | String | |
| Visibility | Visibility of the event, default, public, private, or confidential | String | |
| Summary | Title of the event. | String | Limit |
| Description | Description of the calendar. | String | Limit |
| Location | Geographic location of the event as free-form text. | String | Limit |
| Start | The (inclusive) start time of the event. For a recurring event, this is the start time of the first instance. | String | Date |
| End | The (exclusive) end time of the event. For a recurring event, this is the end time of the first instance. | String | Date |
| Created | Creation time of the event. | String | Date |
| Updated | Last modification time of the event. | String | Date |
| Creator | The creator of the event. | Profile Type | |
| Organizer | The organizer of the event. | Profile Type | |
| Attendees | The attendees of the event. | Attendee Type | |
| Attachments | File attachments of the event. | Attachment Type |
Profile Type
Defines the mapping options of a Profile object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Identifier of the profile. | String | |
| The profile's email. | String | ||
| Name | The profile's name. | String | Limit |
Attendee Type
Defines the mapping options of an Attendee object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Identifier of the attendee. | String | |
| The attendee's email. | String | ||
| Name | The attendee's name. | String | Limit |
| Comment | The attendee's name. | String | Limit |
| Response Status | The attendee's response status, needsAction, declined, tentative or accepted. | String | |
| Is Organizer | Whether the attendee is the organizer of the event. | Boolean | |
| Is Resource | Whether the attendee is a resource. | Boolean | |
| Is Optional | Whether this is an optional attendee. | Boolean | |
| Additional Guests Count | Number of additional guests. | Int |
Attachment Type
Defines the mapping options of an Attachment object.
| Option | Description | Type | Filters |
|---|---|---|---|
| ID | Identifier of the attached file. | String | |
| Title | Title of the attachment. | String | Limit |
| Mime Type | Internet media type (MIME type) of the attachment. | String | |
| File URL | URL link to the attachment. | String | |
| Icon URL | URL link to the attachment's icon. | String |