- Nyomtat
Google Calendar Connector
A Tulip és a Google Naptár integrálása
Bevezetés
A Google Calendar API lehetővé teszi a felhasználók számára, hogy a Google naptár eseményeit létrehozzák, olvassák és szerkesszék a Google-fiókjukhoz beállított megfelelő hozzáféréssel. Ennek a csatlakozónak a célja az OAuth hitelesítés használata és a Google Calendar V3 Api integrálása a Tulip segítségével a HTTP csatlakozók segítségével, és ügyfeleink számára egy olyan out-of-box csatlakozót biztosít, amelyet be lehet importálni a példányukba.
Cél
Ez a dokumentum kiemeli a különböző HTTP-konnektor funkciókat, amelyek a Google Calendar V3 API végpontok HTTP-hívásaival építhetők a Google Calendarral való interakcióhoz, hogy kipróbálhassuk a különböző olvasási és írási műveleteket a naptáron, amelyeket különböző felhasználási esetekben lehet kihasználni.
API-dokumentum
Előfeltételek
- Hozzon létre egy fiókot a Google felhő konzolján és konfigurálja az OAuth 2.0 hitelesítő adatokat. További információ a Google API dokumentációjában található.
- Aktiválja a Google Calendar API-t a Google API Console-ban.
Tulip kapcsolat részletei
A következő információkat kellene konfigurálni a Tulip csatlakozókon.
- Futtatás: Cloud Connector Host
- Host:www.googleapis.com
- Port:443
- TLS: Igen
- Csatlakozó hitelesítés: OAuth2.0(admin/üzemeltető)
- Az alábbiakban a szükséges hatóköröket kell átadni:
- https://www.googleapis.com/auth/calendar
- https://www.googleapis.com/auth/calendar.events
Csatlakozó funkciók
Minden naptár lekérdezése
Cél
Ez a csatlakozó lekérdezi a felhasználó Google naptárában meglévő összes naptárat.
Végpont
HTTP GET hívás a https://www.googleapis.com:443/calendar/v3/users/me/calendarList végpontra.
Kötelező bemenet
Nincs szükség bemenetre
Kötelező kimenet Extractor
- Naptár azonosító: A naptár egyedi azonosítója, amelyet a többi feladat végrehajtásához használnak.
- Cím: A naptár címe
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Összes esemény lekérdezése
Cél
Ez a csatlakozó egy adott naptár összes eseményét lekérdezi.
Végpont
HTTP GET hívás a -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events végponthoz.
Kötelező bemenet
A következő URL-paramétereket kell átadni
- Calendar Id- Calendar Id/ a calendar ID paraméterben a "primary" értéket kell megadni. Az "Primary" megadása a felhasználó elsődleges naptárának összes eseményét megkapja.
Kötelező kimenet Kivonat
- Naptár Id: A naptár egyedi azonosítója, amelyet a többi feladat végrehajtásához használunk.
- Eseményazonosító: Az esemény egyedi azonosítója, amely egy adott esemény részleteinek kinyerésére szolgál.
- Cím: Az esemény címe
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Események lekérdezése szűrő szerint
Cél
Ez a csatlakozó az összes olyan eseményt lekérdezi, amely a lekérdezési paraméterek által megadott dátumtartományba esik.
Végpont
HTTP GET hívás a végponthoz -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events?maxResults={MaxResults}&orderBy=updated&timeMax={MaxTime}&timeMin={MinTime}&singleEvents=true
Kötelező bemenet
A következő URL paramétereket kell átadni
- Naptár azonosító: Naptár ID
- MaxResults: A lekérdezendő rekordok száma
- MinTime: A lekérdezendő események kezdő dátuma és ideje.
- MaxTime: A lekérdezendő események végdátumának időpontja
Szükséges kimeneti kivonatoló
- Naptár Id: A naptár egyedi azonosítója, amelyet a többi feladat elvégzéséhez használnak.
- Eseményazonosító: Az esemény egyedi azonosítója, amelyet a többi feladat végrehajtásához használnak.
- Cím: Az esemény címe
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Új esemény létrehozása egyetlen/csoportos/több felhasználó számára
Cél
- A felhasználók megadhatják az esemény címét, leírását, kezdő és befejező időpontját, és a Tulip létrehoz egy új eseményt a megadott eseménycímmel. Az API válasza a fájl metaadatai és különböző tulajdonságai lesznek.
- A Google Calendar V3 API-ból származó információk a továbbiakban felhasználhatók a Tulip alkalmazásokban, a Tulip táblázatokban vagy a Tulip változókban, amelyek más csatlakozó funkciókba kerülnek.
Végpont
HTTP POST hívás a https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events végpontra.
Kötelező bemenet
A következő paraméterek a kérés testeként elküldendő paraméterek
- Naptár ID- A kiválasztott naptár azonosítója
- Esemény címe - Az esemény címe
- Start Date Time - Az esemény kezdőnapjának időpontja
- End Date Time - Az esemény végdátuma - Az esemény végdátumának időpontja
- Időzóna - Esemény időzóna
- Résztvevők- Az esemény résztvevői
- Helyszín - A rendezvény helyszíne
- Leírás - Az esemény leírása
Szükséges kimeneti kivonat
- Esemény azonosító: Az esemény egyedi azonosítója, amely a többi feladat elvégzéséhez használatos.
- Esemény címe: Az esemény címe
- Szervező: Az esemény szervezőjének neve
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Új ismétlődő esemény létrehozása egyetlen/csoportos/több felhasználó számára
Cél
- A felhasználók megadhatják az esemény címét, leírását, kezdeti időpontját, befejezési időpontját, ismétlődés végének időpontját, ismétlődés típusát és egyéb paramétereket bemenetként, és a Tulip létrehoz egy új eseményt a megadott eseménycímmel. Az API válasza a fájl metaadatai és különböző tulajdonságai lesznek.
- A Google Calendar V3 API-ból származó információk ezután tovább használhatók a Tulip alkalmazásokban, a Tulip táblázatokban vagy a Tulip változókban, amelyeket más csatlakozó funkciókba vezetnek.
Végpont
HTTP POST hívás a https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events végpontra.
Kötelező bemenet
A következő paraméterek a kérés testeként elküldendő paraméterek
- Naptár ID- A kiválasztott naptár azonosítója
- Esemény címe - Az esemény címe
- Start Date Time - Az esemény kezdőnapjának időpontja
- End Date Time - Az esemény végdátumának időpontja
- Időzóna - Esemény időzóna
- Résztvevők- Az esemény résztvevői
- Leírás - Az esemény leírása
- Helyszín - A rendezvény helyszíne
- Ismétlődési szabály - Az ismétlődési szabály tartalmazza az esemény ismétlődésének minden részletét, hogy hogyan és mikor ismétlődjön az esemény. Az alábbiakban néhány, az alkalmazáson belül hozzáadott ismétlődési szabály listáját mutatjuk be (lásd RFC5545).
szakasz-3.8.5) dokumentumban található részletes ismétlődési szabályok) :
Naponta a eseményekhez:
RRULE:FREQ=DAILY;COUNT=
Például: RRULE:FREQ=DAILY;COUNT=5
Az esemény az esemény kezdeti dátumától számított 5 napon keresztül ugyanazon kezdő és befejező időpontban fordul elő.
Naponta a címig:
RRULE:FREQ=DAILY;UNTIL=
Ex: RRULE:FREQ=DAILY;UNTIL=20210924T000000Z
Az esemény naponta bekövetkezik az esemény kezdő dátumától számítva "2021. szeptember 24-ig", ugyanarra a kezdő és befejező időpontra.
Heti rendszerességgel a események esetén:
RRULE:FREQ=WEEKLY;COUNT=
Például: RRULE:FREQ=WEEKLY;COUNT=3
Az esemény 3 héten keresztül hetente fordul elő az esemény kezdőnapjának ugyanazon a hétköznapján, ugyanarra a kezdő- és végidőre.
Heti rendszerességgel, amíg :
RRULE:FREQ=WEEKLY;UNTIL=
Ex: RRULE:FREQ=WEEKLY;UNTIL=20210924T000000Z
Az esemény hetente történik "2021. szeptember 24-ig" az esemény kezdőnapjának ugyanazon a hétköznapján, ugyanarra a kezdő és befejező időpontra.
Minden kedden, minden második hónapban:(this)
RRULE:FREQ=HAVONTA;INTERVAL=;BYDAY=
Például: RRULE:FREQ=MONTHLY;INTERVAL=2;BYDAY=TU
Az esemény minden második hónap keddjén történik, ugyanabban a kezdő és befejező időpontban.
Szükséges kimeneti kivonat
- Esemény azonosító: Az esemény egyedi azonosítója, amelyet a többi feladat végrehajtásához használnak.
- Esemény címe: Az esemény címe
- Szervező: Az esemény szervezőjének neve
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Esemény metaadatok frissítése
Cél
- A felhasználók megadhatják az esemény címét, leírását, kezdő és befejező időpontját és egyéb paramétereket bemenetként, és a Tulip frissíti a meglévő eseményt a megadott adatokkal. Az API válasza a metaadatok és a fájl különböző tulajdonságai lesznek.
- A Google Calendar V3 API-ból származó információk ezután tovább használhatók a Tulip alkalmazásokban, a Tulip táblázatokban vagy a Tulip változókban, amelyeket más csatlakozó funkciókba lehet továbbítani.
Végpont
HTTP PATCH hívás a https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*
végponthoz.
Kötelező bemenet
A következő paraméterek a kérés testeként elküldött paraméterek
- Naptár ID- A kiválasztott naptár azonosítója
- Esemény azonosító - kiválasztott esemény azonosítója
- Esemény címe - Az esemény címe
- Kezdeti időpont - Az esemény kezdeti időpontjának időpontja
- End Date Time - Az esemény végdátuma - Az esemény végdátumának időpontja
- Időzóna - Esemény időzóna
- Hely - Az esemény helye
- Leírás - Az esemény leírása
Szükséges kimeneti kivonat
- Esemény azonosító: Az esemény egyedi azonosítója, amelyet a többi feladat végrehajtásához használnak.
- Esemény címe: Az esemény címe
- Esemény leírása: Az esemény címe
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Ismétlődő esemény frissítése
Cél
- A felhasználók megadhatják az esemény címét, leírását, kezdő és befejező időpontját, ismétlődési szabályát és egyéb paramétereket, és a Tulip frissíti a meglévő eseményt a megadott adatokkal. Az API válasza a fájl metaadatai és különböző tulajdonságai lesznek.
- A Google Calendar V3 API-ból származó információk a továbbiakban felhasználhatók a Tulip alkalmazásokban, a Tulip táblázatokban vagy a Tulip változókban, amelyek más csatlakozó funkciókba kerülnek.
Végpont
HTTP PATCH hívás a https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*
végponthoz.
Kötelező bemenet
A következő paraméterek a kérés testeként elküldött paraméterek
- Naptár ID- A kiválasztott naptár azonosítója
- Esemény azonosító - kiválasztott esemény azonosítója
- Esemény címe - Az esemény címe
- Kezdeti időpont - Az esemény kezdeti időpontjának időpontja
- End Date Time - Az esemény végdátuma - Az esemény végdátumának időpontja
- Időzóna - Esemény időzóna
- Hely - Az esemény helye
- Leírás- Az esemény leírása
- Ismétlődési szabály- Az ismétlődési szabály tartalmazza az esemény ismétlődésének minden részletét, hogy hogyan és mikor kell ismétlődnie. A részletes ismétlődési szabályokért lásd az alkalmazásban hozzáadott néhány ismétlődési szabály listáját (lásd a fent említett dokumentumot).
Szükséges kimeneti kivonat
- Esemény azonosító: Az esemény egyedi azonosítója, amelyet a többi feladat végrehajtásához használnak.
- Esemény címe: Az esemény címe
- Esemény leírása: Az esemény címe
- A válasszal együtt visszaküldött további paraméterek a kimeneti paraméterek részeként szerepelhetnek.
Esemény törlése
Cél
- A felhasználók megadhatják a Naptár azonosítóját és az Esemény azonosítóját bemenetként, és a Tulip törli az eseményt a Google naptárból.
Végpont
HTTP DELETE hívás a -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}
végpontra.
Kötelező bemenet
A következő paraméterek a kérés testeként elküldendő paraméterek
- Naptár azonosító - A kiválasztott naptár azonosítója
- Esemény azonosító - kiválasztott esemény azonosítója