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. Freebusy
  8. Einstellungen

Acl

Weitere Informationen zu ACL-Ressourcen finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
Delete DELETE  /calendars/calendarId/acl/ruleId Löscht eine Zugriffssteuerungsregel.
get GET  /calendars/calendarId/acl/ruleId Gibt eine Zugriffssteuerungsregel zurück.
insert POST  /calendars/calendarId/acl Erstellt eine Zugriffssteuerungsregel.
list GET  /calendars/calendarId/acl Gibt die Regeln in der Zugriffssteuerungsliste für den Kalender zurück.
patch PATCH  /calendars/calendarId/acl/ruleId Aktualisiert eine Zugriffssteuerungsregel. Diese Methode unterstützt die Patch-Semantik. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen.
aktualisieren PUT  /calendars/calendarId/acl/ruleId Aktualisiert eine Zugriffssteuerungsregel.
watch POST  /calendars/calendarId/acl/watch Achten Sie auf Änderungen an ACL-Ressourcen.

CalendarList

Weitere Informationen zur Kalenderliste finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu 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 Ein vorhandener Kalender wird in die Kalenderliste des Nutzers eingefügt.
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. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen.
aktualisieren PUT  /users/me/calendarList/calendarId Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers.
watch POST  /users/me/calendarList/watch Achten Sie auf Änderungen an CalendarList-Ressourcen.

Kalender

Weitere Informationen zu Kalenderressourcen finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
klarer POST  /calendars/calendarId/clear Löscht einen primären Kalender. Bei diesem 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. Verwenden Sie „calendars.clear“, um alle Termine in primären Kalendern zu löschen.
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 für einen Kalender. Diese Methode unterstützt die Patch-Semantik. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen.
aktualisieren PUT  /calendars/calendarId Aktualisiert die Metadaten für einen Kalender.

Kanäle

Weitere Informationen zu Kanalressourcen findest du auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
stop POST  /channels/stop Sie können sich die Ressourcen nicht mehr über diesen Kanal ansehen.

Farben

Weitere Informationen zur Ressourcendarstellung für Farben finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
get GET  /colors Gibt die Farbdefinitionen für Kalender und Termine zurück.

Ereignisse

Weitere Informationen zur Ereignisressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu 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 anhand seiner Google Kalender-ID zurück. Wenn Sie einen Termin anhand seiner iCalendar-ID abrufen möchten, rufen Sie die Methode „events.list“ mit dem Parameter „iCalUID auf.
import POST  /calendars/calendarId/events/import Importiert einen Termin. Mit dieser Aktion wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einer eventType von default importiert werden.

Eingestelltes Verhalten:Wenn ein Ereignis importiert wird, das nicht default ist, wird sein Typ in default geändert und alle ereignisspezifischen Properties werden verworfen.

insert POST  /calendars/calendarId/events Erstellt einen Termin.
instances 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.
move POST  /calendars/calendarId/events/eventId/move Verschiebt einen Termin in einen anderen Kalender, d.h. ändert den Organisator eines Termins. Hinweis: Nur default-Ereignisse können verschoben werden. birthday-, focusTime-, fromGmail-, outOfOffice- und workingLocation-Ereignisse können nicht verschoben werden.

Erforderliche Suchparameter:destination

patch PATCH  /calendars/calendarId/events/eventId Aktualisiert ein Ereignis. Diese Methode unterstützt die Patch-Semantik. Hinweis: Jede Patchanfrage belegt drei Kontingenteinheiten. Verwenden Sie daher vorzugsweise get gefolgt von update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht angeben, bleiben unverändert. Wenn Arrayfelder angegeben werden, werden die vorhandenen Arrays überschrieben. Alle vorherigen Arrayelemente werden dabei verworfen.
quickAdd POST  /calendars/calendarId/events/quickAdd Erstellt ein Ereignis basierend auf einem einfachen Textstring.

Erforderliche Suchparameter:text

aktualisieren PUT  /calendars/calendarId/events/eventId Aktualisiert ein Ereignis. Diese Methode unterstützt keine Patch-Semantik und aktualisiert immer die gesamte Ereignisressource. Führen Sie für eine teilweise Aktualisierung eine get gefolgt von einer update mit ETags aus, um für Atomarität zu sorgen.
watch POST  /calendars/calendarId/events/watch Behalten Sie Änderungen an den Ressourcen für Google Kalender im Auge.

Verfügbar/Beschäftigt

Weitere Informationen zu Ressourcen mit dem Status „Liegt nicht vor“ finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
query POST  /freeBusy Gibt Informationen zur Verfügbarkeit für eine Reihe von Kalendern zurück.

Einstellungen

Weitere Informationen zur Einstellungsressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs sind relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben.
get GET  /users/me/settings/setting Gibt eine Einstellung für einen einzelnen Nutzer zurück.
list GET  /users/me/settings Gibt alle Nutzereinstellungen für den authentifizierten Nutzer zurück.
watch POST  /users/me/settings/watch Achten Sie auf Änderungen an den Ressourcen für Einstellungen.