Коннектор календаря Google

Коннектор Google Calendar

Интеграция Tulip с Google Calendar

Введение

Google Calendar API позволяет пользователям создавать, читать и редактировать события календаря Google, имея соответствующий доступ к своим учетным записям google. Целью данного коннектора является использование аутентификации OAuth и интеграция с Google Calendar V3 Api с Tulip с помощью HTTP-коннекторов, а также предоставление нашим клиентам готового коннектора, который можно импортировать в их экземпляр.

Назначение

В этом документе описаны различные функции HTTP-коннектора, которые можно построить путем выполнения HTTP-вызовов к конечным точкам Google Calendar V3 API для взаимодействия с календарем Google, чтобы опробовать различные действия чтения и записи в календарь, которые могут быть использованы для различных сценариев использования.

API Doc

1. Календарь Google

Предварительные требования

1. Создайте учетную запись в облачной консоли Google и настройте учетные данные OAuth 2.0. Более подробную информацию можно найти в документации Google по API.
2. Активируйте Google Calendar API в Google API Console.

Детали подключения Tulip

Для коннекторов Tulip необходимо настроить следующую информацию.

1. Running On: Cloud Connector Host
2. Хост:www.googleapis.com
3. Порт:443
4. TLS: Да
5. Аутентификация коннектора: OAuth2.0(Admin/Operator)
6. Ниже приведены диапазоны, которые необходимо передать:
7. https://www.googleapis.com/auth/calendar
8. https://www.googleapis.com/auth/calendar.events

Функции коннектора

Получить все календари

Назначение

Данный коннектор позволяет получить все календари, имеющиеся в календаре google пользователя.

Конечная точка

HTTP GET вызов конечной точки https://www.googleapis.com:443/calendar/v3/users/me/calendarList.

Требуемый ввод

Входы не требуются

Требуемый выходной экстрактор

1. Calendar Id: Уникальный идентификатор календаря, который будет использоваться для выполнения других задач
2. Title (Название): Название календаря
3. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Получить все события

Назначение

Данный коннектор позволяет получить все события определенного календаря.

Конечная точка

HTTP GET вызов конечной точки -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events

Необходимые параметры

Ниже перечислены параметры URL, которые необходимо передать

1. Calendar Id - идентификатор календаря/ В качестве значения параметра Calendar ID передается "primary". При указании "Primary" будут получены все события основного календаря пользователя.

Требуемый выходной экстрактор

1. Calendar Id: Уникальный идентификатор календаря, который будет использоваться для выполнения других задач
2. Event ID: Уникальный идентификатор события, который будет использоваться для получения подробной информации о конкретном событии.
3. Title (Название): Название события.
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Получить события по фильтру

Назначение

Данный коннектор получает все события, которые попадают в указанный диапазон дат, заданный параметрами запроса.

Конечная точка

HTTP GET вызов конечной точки -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events?maxResults={MaxResults}&orderBy=updated&timeMax={MaxTime}&timeMin={MinTime}&singleEvents=true

Требуемый ввод

Ниже перечислены параметры URL, которые необходимо передать

1. ID календаря: ID календаря
2. MaxResults: Количество записей для выборки
3. MinTime: Время начальной даты событий для выборки
4. MaxTime: Время конечной даты событий для выборки

Требуемый выходной экстрактор

1. Calendar Id: Уникальный идентификатор календаря, который будет использоваться для выполнения других задач
2. Event ID: Уникальный идентификатор события, который будет использоваться для выполнения других задач
3. Title: Название события.
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Создание нового события для одного/группы/многих пользователей

Назначение

1. Пользователи могут передать в качестве входных данных название события, описание, время начала и окончания события, и Tulip создаст новое событие с указанным названием. Ответом API будут метаданные и различные свойства файла.
2. Информация, полученная из Google Calendar V3 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP POST вызов конечной точки https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events.

Необходимые параметры

Ниже перечислены параметры, которые передаются в теле запроса

1. ID календаря - идентификатор выбранного календаря
2. Название события - название события
3. Start Date Time - Время начала события
4. End Date Time - Время окончания события
5. Time Zone - часовой пояс события
6. Attendees- Участники мероприятия
7. Location - Место проведения мероприятия
8. Description - Описание события

Требуемый выходной экстрактор

1. Event Id: Уникальный идентификатор события, который будет использоваться для выполнения других задач
2. Event Title - Название события: Название события
3. Организатор: Имя организатора мероприятия
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Создание нового повторяющегося события для одного/группы/многих пользователей

Назначение

1. Пользователи могут передать в качестве входных данных название события, описание, время начала, время окончания, время окончания повтора, тип повтора и другие параметры, и Tulip создаст новое событие с указанным названием. Ответом API будут метаданные и различные свойства файла.
2. Информация, полученная из Google Calendar V3 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP POST вызов конечной точки https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events.

Необходимые параметры

Ниже перечислены параметры, которые передаются в теле запроса

1. ID календаря - идентификатор выбранного календаря
2. Название события - название события
3. Start Date Time - Время начала события
4. End Date Time - Время окончания события
5. Time Zone - часовой пояс события
6. Attendees - Участники мероприятия
7. Description - Описание мероприятия
8. Location-Event Location - Место проведения мероприятия
9. Recurrence Rule - Правило повторения содержит все детали того, как и когда событие должно повторяться. Ниже приведен список нескольких правил повторения, добавленных в приложение (См. [RFC5545](https://tools.ietf.org/html/rfc5545

раздел-3.8.5) для получения подробной информации о правилах повторения):

Ежедневно для :

RRULE:FREQ=DAILY;COUNT=

Например: RRULE:FREQ=DAILY;COUNT=5

Событие происходит в течение 5 дней с даты начала события для того же времени начала и времени окончания.

Ежедневно до :

RRULE:FREQ=DAILY;UNTIL=

Ex: RRULE:FREQ=DAILY;UNTIL=20210924T000000Z

Событие происходит ежедневно до "24 сентября 2021 года" от даты начала события для того же времени начала и времени окончания.

Еженедельно для случая :

RRULE:FREQ=WEEKLY;COUNT=

Например: RRULE:FREQ=WEEKLY;COUNT=3

Событие происходит еженедельно в течение 3 недель в один и тот же день недели даты начала события и в одно и то же время начала и окончания.

Еженедельно до :

RRULE:FREQ=WEEKLY;UNTIL=

Ex: RRULE:FREQ=WEEKLY;UNTIL=20210924T000000Z

Событие происходит еженедельно до "24 сентября 2021 года" для одного и того же дня недели даты начала события и для одного и того же времени начала и времени окончания

Каждый вторник, каждый второй месяц:(this)

RRULE:FREQ=MONTHLY;INTERVAL=;BYDAY=

Например: RRULE:FREQ=MONTHLY;INTERVAL=2;BYDAY=TU

Событие происходит во вторник каждого второго месяца для того же времени начала и окончания.

Требуемый выходной экстрактор

1. Event Id: Уникальный идентификатор события, который будет использоваться для выполнения других задач
2. Event Title: Название события
3. Организатор: Имя организатора мероприятия
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Обновление метаданных события

Назначение

1. Пользователи могут передать в качестве входных данных название события, его описание, время начала, время окончания и другие параметры, и Tulip обновит существующее событие с учетом предоставленных данных. Ответом API будут метаданные и различные свойства файла.
2. Информация, полученная из Google Calendar V3 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP PATCH вызов конечной точки https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*.

Необходимые входные данные

Ниже перечислены параметры, которые передаются в теле запроса

1. ID календаря - выбранный идентификатор календаря
2. ID события - ID выбранного события
3. Event Title - Название события
4. Start Date Time - Время начала события
5. End Date Time- Дата окончания события Время
6. Time Zone- часовой пояс события
7. Location - Местонахождение события
8. Description - Описание события

Требуемый выходной экстрактор

1. Event Id: Уникальный идентификатор события, который будет использоваться для выполнения других задач
2. Event Title - Название события: Название события
3. Описание события: Название события
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Обновление повторяющегося события

Назначение

1. Пользователи могут передать в качестве входных данных название события, его описание, время начала, время окончания, правило повторения и другие параметры, и Tulip обновит существующее событие с учетом предоставленных данных. Ответом API будут метаданные и различные свойства файла.
2. Информация, полученная из Google Calendar V3 API, может быть использована в приложениях Tulip, таблицах Tulip или переменных Tulip, которые будут переданы в другие функции коннектора.

Конечная точка

HTTP PATCH вызов конечной точки https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*.

Необходимые входные данные

Ниже перечислены параметры, которые передаются в теле запроса

1. ID календаря - выбранный идентификатор календаря
2. ID события - ID выбранного события
3. Event Title - Название события
4. Start Date Time - Время начала события
5. End Date Time- Дата окончания события Время
6. Time Zone- часовой пояс события
7. Location-Event Location
8. Description - Описание события
9. Recurrence Rule - Правило повторения содержит все детали того, как и когда событие должно повторяться. Для получения подробной информации о правилах повторения обратитесь к списку нескольких правил повторения, добавленных в приложение, упомянутое в вышеупомянутом документе)

Необходимый экстрактор выходных данных

1. Event Id: Уникальный идентификатор события, который будет использоваться для выполнения других задач
2. Event Title: Название события
3. Описание события: Название события
4. Дополнительные параметры, возвращаемые вместе с ответом, могут быть включены в состав выходных параметров

Удалить событие

Назначение

1. Пользователи могут передать ID календаря и ID события в качестве входных данных, и Tulip удалит событие в календаре google.

Конечная точка

HTTP DELETE вызов конечной точки -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}

Необходимые входные данные

Ниже перечислены параметры, которые передаются в теле запроса

1. ID календаря - выбранный ID календаря
2. Идентификатор события - идентификатор выбранного события