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ügbarkeitsstatus
  8. Einstellungen

Acl

Ausführliche Informationen zu ACL-Ressourcen 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/acl/ruleId Löscht eine Regel zur Zugriffssteuerung.
get GET  /calendars/calendarId/acl/ruleId Gibt eine Regel zur Zugriffssteuerung zurück.
insert 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 sollte get gefolgt von update verwendet werden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Array-Felder überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
Update 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 "KalenderList" 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  /users/me/calendarList/calendarId Entfernt einen Kalender aus der Kalenderliste des Nutzers.
get GET  /users/me/calendarList/calendarId Gibt einen Kalender aus der Kalenderliste des Nutzers zurück.
insert POST  /users/me/calendarList Fügt einen vorhandenen 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 Dadurch wird ein bestehender Kalender in der Kalenderliste des Nutzers aktualisiert. Diese Methode unterstützt die Patch-Semantik. Jede Patchanfrage verbraucht drei Kontingenteinheiten. Idealerweise sollte get gefolgt von update verwendet werden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Array-Felder überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
Update PUT  /users/me/calendarList/calendarId Dadurch wird ein bestehender Kalender in der Kalenderliste des Nutzers aktualisiert.
Smartwatch POST  /users/me/calendarList/watch Achten Sie auf Änderungen an Kalenderlistenressourcen.

Kalender

Ausführliche Informationen zu Kalenderressourcen 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.
klarer POST  /calendars/calendarId/clear Löscht einen Hauptkalender. Durch diesen Vorgang werden alle Termine gelöscht, die mit dem Hauptkalender 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.
get GET  /calendars/calendarId Gibt Metadaten für einen Kalender zurück.
insert 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 sollte get gefolgt von update verwendet werden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Array-Felder überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
Update 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 Das Ansehen von Ressourcen über diesen Kanal beenden.

Farben

Ausführliche Informationen zu Ressourcen vom Typ „Farben“ 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.
get GET  /colors Gibt die Farbdefinitionen für Kalender und Termine zurück.

Veranstaltungen

Ausführliche 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.
get GET  /calendars/calendarId/events/eventId Gibt einen Termin basierend auf seiner Google Kalender-ID zurück. Wenn Sie einen Termin über seine iKalender-ID abrufen möchten, rufen Sie die events.list-Methode mit dem iCalUID-Parameter auf.
import POST  /calendars/calendarId/events/import Importiert ein Ereignis. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Termine mit einem eventType von default importiert werden.

Veraltetes Verhalten:Wenn ein anderes Ereignis als default importiert wird, wird sein Typ in default geändert und alle ereignistypspezifischen Eigenschaften des Ereignisses werden entfernt.

insert POST  /calendars/calendarId/events Erstellt einen Termin.
Instanzen GET  /calendars/calendarId/events/eventId/instances Gibt Instanzen des angegebenen wiederkehrenden Ereignisses 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. Nur default-Ereignisse können verschoben werden. outOfOffice-, focusTime-, workingLocation- und fromGmail-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 sollte get gefolgt von update verwendet werden. Die vorhandenen Werte werden durch die von Ihnen angegebenen Feldwerte ersetzt. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Sofern angegeben, werden die vorhandenen Array-Felder überschrieben. Dadurch werden alle vorherigen Array-Elemente verworfen.
quickAdd POST  /calendars/calendarId/events/quickAdd Erstellt ein Ereignis basierend auf einer einfachen Textzeichenfolge.

Erforderliche Abfrageparameter: text

Update PUT  /calendars/calendarId/events/eventId Aktualisiert einen Termin. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Für eine teilweise Aktualisierung führen Sie einen get gefolgt von einem update mit ETags aus, um die Atomarität sicherzustellen.
Smartwatch POST  /calendars/calendarId/events/watch Achten Sie auf Änderungen an Ereignisressourcen.

Verfügbar/Beschäftigt

Ausführliche Informationen zu Ressourcen vom Typ "Verfügbar" 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 zum Verfügbar/Beschäftigt-Status für eine Reihe von Kalendern zurück.

Einstellungen

Ausführliche Informationen zu Ressourcen vom Typ "Einstellungen" 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.
get 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 Einstellungen.