Google Calendar Component
Manage calendars and events in Google Calendar
Component key: google-calendar#
DescriptionGoogle Calendar is a time-management and scheduling calendar service developed by Google. This component allows you to create, read, update and delete events and calendars connected to your Google account.
#
Google Calendar Connections#
Google Calendar OAuth 2.0The Google Calendar component authenticates requests through Google's OAuth service. To create a Google Calendar developer account and authenticate using Google OAuth, follow the directions here Now, you will have to configure OAuth 2.0 settings in Prismatic. Create a new Google Calendar connection of type OAuth 2.0.
- For Client ID and Client Secret enter the values that you got from the Google Cloud Platform auth settings.
- For Scopes choose from the list found on the Google docs
Input | Default | Notes |
---|---|---|
Input Authorize URL string / Required Hidden Field | Default https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent | Notes The OAuth 2.0 Authorization URL for Google Calendar |
Input Client ID string / Required | Default | Notes Provide a string value for the client Id of your OAuth 2.0 application. |
Input Client Secret password / Required | Default | Notes Provide a string value for the client secret of your OAuth 2.0 application. |
Input Scopes string | Default https://www.googleapis.com/auth/calendar | Notes A space-delimited set of one or more scopes to get the user's permission to access. |
Input Token URL string / Required Hidden Field | Default https://oauth2.googleapis.com/token | Notes The OAuth 2.0 Token URL for Google Calendar |
#
Actions#
Create CalendarCreate a new calendar | key: createCalendar
Input | Notes | Example |
---|---|---|
Input Description string / Required | Notes Provide a string value for the description. | Example This is an example description |
Input Connection connection / Required | Notes | Example |
Input Summary string / Required | Notes Provide a string value for the summary. | Example This is an example summary. |
Input Time Zone string / Required | Notes Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs. | Example America/Chicago |
#
Create EventCreate a new event in a given calendar | key: createEvent
Input | Default | Notes | Example |
---|---|---|---|
Input Attendees code Value List | Default | Notes For each item, provide a JavaScript Object with an email property. | Example
|
Input Calendar Id string / Required | Default | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Default | Notes | Example |
Input Description string / Required | Default | Notes Provide a string value for the description. | Example This is an example description |
Input End Time string / Required | Default | Notes Provide a date time value for the ending time of the event. | Example 2015-05-28T17:00:00-07:00 |
Input Event Location string / Required | Default | Notes Provide a string value for the location of the event. | Example The Rec Center |
Input Remind Method string | Default | Notes This field is only required if useDefaultReminder is set to false. | Example |
Input Remind Before (minutes) string | Default | Notes This field is only required if useDefaultReminder is set to false. | Example 30 |
Input Start Time string / Required | Default | Notes Provide a date time value for the starting time of the event. | Example 2015-05-28T17:00:00-07:00 |
Input Summary string / Required | Default | Notes Provide a string value for the summary. | Example This is an example summary. |
Input Time Zone string / Required | Default | Notes Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs. | Example America/Chicago |
Input Default Reminder boolean / Required | Default false | Notes If this field is true, the event will use the default reminder settings. | Example |
#
Delete CalendarDelete an existing calendar by Id | key: deleteCalendar
Input | Notes | Example |
---|---|---|
Input Calendar Id string / Required | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Notes | Example |
#
Delete EventDelete an event by an Id | key: deleteEvent
Input | Notes | Example |
---|---|---|
Input Calendar Id string / Required | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Notes | Example |
Input Event Id string / Required | Notes Provide the unique identifier of the event. | Example The Rec Center |
#
Get CalendarGet the information and metadata of a calendar by Id | key: getCalendar
Input | Notes | Example |
---|---|---|
Input Calendar Id string / Required | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Notes | Example |
#
Get EventGet the information and metadata of an event by Id | key: getEvent
Input | Notes | Example |
---|---|---|
Input Calendar Id string / Required | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Notes | Example |
Input Event Id string / Required | Notes Provide the unique identifier of the event. | Example The Rec Center |
#
List CalendarsList all calendars | key: listCalendar
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Max Results string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 50. | Example 20 |
Input Page Token string | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
#
List EventsList all events in a given calendar | key: listEvents
Input | Notes | Example |
---|---|---|
Input Calendar Id string / Required | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Notes | Example |
Input Max Results string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 50. | Example 20 |
Input Page Token string | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Sync Token string | Notes Specify the token for syncing the latest resources that have been modified since the last sync request | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
#
Update EventUpdate the information and metadata of an existing event | key: updateEvent
Input | Default | Notes | Example |
---|---|---|---|
Input Attendees code Value List | Default | Notes For each item, provide a JavaScript Object with an email property. | Example
|
Input Calendar Id string / Required | Default | Notes Provide a string value for the id of the calendar. | Example exampleId |
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description. | Example This is an example description |
Input End Time string / Required | Default | Notes Provide a date time value for the ending time of the event. | Example 2015-05-28T17:00:00-07:00 |
Input Event Id string / Required | Default | Notes Provide the unique identifier of the event. | Example The Rec Center |
Input Event Location string | Default | Notes Provide a string value for the location of the event. | Example The Rec Center |
Input Remind Method string | Default | Notes This field is only required if useDefaultReminder is set to false. | Example |
Input Remind Before (minutes) string | Default | Notes This field is only required if useDefaultReminder is set to false. | Example 30 |
Input Start Time string / Required | Default | Notes Provide a date time value for the starting time of the event. | Example 2015-05-28T17:00:00-07:00 |
Input Summary string | Default | Notes Provide a string value for the summary. | Example This is an example summary. |
Input Time Zone string / Required | Default | Notes Provide a valid value for the timezone of the event. For a complete list of timezones refer to the google docs. | Example America/Chicago |
Input Default Reminder boolean / Required | Default false | Notes If this field is true, the event will use the default reminder settings. | Example |