API Reference

Die API-Referenz ist nach Ressourcentypen gegliedert. Jeder Ressourcentyp verfügt über eine oder mehrere Datendarstellungen und eine oder mehrere Ressourcen.

Ressourcentypen

  1. ACL
  2. CalendarList
  3. Kalender
  4. Kanäle
  5. Farben
  6. Ereignisse
  7. Verfügbarkeit
  8. Einstellungen

Acl

Ausführliche Informationen zu ACL-Ressourcen finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
delete DELETE  /calendars/calendarId/acl/ruleId Löscht eine Regel zur Zugriffssteuerung.
Erhalten GET  /calendars/calendarId/acl/ruleId Gibt eine Regel zur Zugriffssteuerung zurück.
einfügen POST  /calendars/calendarId/acl Erstellt eine Regel zur Zugriffssteuerung.
list GET  /calendars/calendarId/acl Gibt die Regeln in der Access Control List für den Kalender zurück
Patch PATCH  /calendars/calendarId/acl/ruleId Aktualisiert eine Regel zur Zugriffssteuerung. Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise solltest du get gefolgt von update verwenden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
aktualisieren PUT  /calendars/calendarId/acl/ruleId Aktualisiert eine Regel zur Zugriffssteuerung.
Smartwatch POST  /calendars/calendarId/acl/watch Achten Sie auf Änderungen an ACL-Ressourcen.

CalendarList

Ausführliche Informationen zu Ressourcen vom Typ "CalendarList" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
delete DELETE  /users/me/calendarList/calendarId Der Kalender wird aus der Kalenderliste des Nutzers entfernt.
Erhalten GET  /users/me/calendarList/calendarId Gibt einen Kalender aus der Kalenderliste des Nutzers zurück
einfügen POST  /users/me/calendarList Fügt einen bestehenden Kalender in die Kalenderliste des Nutzers ein.
list GET  /users/me/calendarList Gibt die Kalender in der Kalenderliste des Nutzers zurück
Patch PATCH  /users/me/calendarList/calendarId Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise solltest du get gefolgt von update verwenden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
aktualisieren PUT  /users/me/calendarList/calendarId Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers
Smartwatch POST  /users/me/calendarList/watch Achten Sie auf Änderungen an CalendarList-Ressourcen.

Kalender

Ausführliche Informationen zu Ressourcen vom Typ "Kalender" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
klarer POST  /calendars/calendarId/clear Löscht einen primären Kalender Mit diesem Vorgang werden alle Termine gelöscht, die mit dem primären Kalender eines Kontos verknüpft sind.
delete DELETE  /calendars/calendarId Löscht einen sekundären Kalender Mit „calendar.clear“ werden alle Termine in primären Kalendern gelöscht.
Erhalten GET  /calendars/calendarId Gibt Metadaten für einen Kalender zurück.
einfügen POST  /calendars Erstellt einen sekundären Kalender.
Patch PATCH  /calendars/calendarId Aktualisiert die Metadaten eines Kalenders Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise solltest du get gefolgt von update verwenden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
aktualisieren PUT  /calendars/calendarId Aktualisiert die Metadaten eines Kalenders

Kanäle

Ausführliche Informationen zu Ressourcen vom Typ "Channels" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
Haltestelle POST  /channels/stop Ressourcen nicht mehr auf diesem Kanal ansehen.

Farben

Ausführliche Informationen zu Ressourcen vom Typ "Colors" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
Erhalten GET  /colors Gibt die Farbdefinitionen für Kalender und Termine zurück

Veranstaltungen

Weitere Informationen zu Ereignisressourcen erhalten Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
delete DELETE  /calendars/calendarId/events/eventId Löscht einen Termin
Erhalten GET  /calendars/calendarId/events/eventId Gibt einen Termin basierend auf seiner Google Kalender-ID zurück Wenn Sie einen Termin mit seiner iCalendar-ID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf.
import POST  /calendars/calendarId/events/import Importiert ein Ereignis. Dieser Vorgang wird verwendet, um einem Kalender eine private Kopie eines vorhandenen Termins hinzuzufügen.
einfügen POST  /calendars/calendarId/events Erstellt einen Termin.
Instanzen GET  /calendars/calendarId/events/eventId/instances Gibt Instanzen des angegebenen wiederkehrenden Termins zurück
list GET  /calendars/calendarId/events Gibt Termine im angegebenen Kalender zurück
verschieben POST  /calendars/calendarId/events/eventId/move Verschiebt einen Termin in einen anderen Kalender, d. h. ändert den Organisator des Termins Es können nur default-Ereignisse verschoben werden. outOfOffice-, focusTime- und workingLocation-Ereignisse können nicht verschoben werden.

Erforderliche Abfrageparameter: destination

Patch PATCH  /calendars/calendarId/events/eventId Aktualisiert einen Termin. Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise solltest du get gefolgt von update verwenden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder überschreiben, sofern angegeben, die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
quickAdd POST  /calendars/calendarId/events/quickAdd Erstellt ein Ereignis basierend auf einer einfachen Textzeichenfolge.

Erforderliche Abfrageparameter: text

aktualisieren PUT  /calendars/calendarId/events/eventId Aktualisiert einen Termin. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Führen Sie für ein teilweises Update einen get gefolgt von einem update mit ETags durch, um die Atomarität zu gewährleisten.
Smartwatch POST  /calendars/calendarId/events/watch Achten Sie auf Änderungen an Veranstaltungsressourcen.

Verfügbar/Beschäftigt

Weitere Informationen zu Ressourcen, die sich auf den Verfügbarkeitsstatus beziehen, finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
query POST  /freeBusy Gibt Informationen zur Verfügbarkeit für einen Satz von Kalendern zurück.

Einstellungen

Ausführliche Informationen zu Ressourcen vom Typ "Settings" finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
Die URIs beziehen sich auf https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
Erhalten GET  /users/me/settings/setting Gibt eine einzelne Nutzereinstellung zurück.
list GET  /users/me/settings Gibt alle Nutzereinstellungen für den authentifizierten Nutzer zurück
Smartwatch POST  /users/me/settings/watch Achten Sie auf Änderungen an den Einstellungsressourcen.