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. Channels
  5. Farben
  6. Ereignisse
  7. Freebusy
  8. Einstellungen

Acl

Weitere Informationen zur Acl-Ressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs 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 Access Control List für den Kalender zurück.
patch PATCH  /calendars/calendarId/acl/ruleId Aktualisiert eine Zugriffssteuerungsregel. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein get gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht 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 Zugriffssteuerungsregel.
Smartwatch POST  /calendars/calendarId/acl/watch Auf Änderungen an ACL-Ressourcen achten.

CalendarList

Weitere Informationen zur CalendarList-Ressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs 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 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 Aktualisiert einen vorhandenen Kalender in der Kalenderliste des Nutzers. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein get gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht 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 Nach Änderungen an CalendarList-Ressourcen suchen

Kalender

Weitere Informationen zur Kalenderressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs 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.

Der authentifizierte Nutzer für die Anfrage wird zum Dateninhaber des neuen Kalenders.
patch PATCH  /calendars/calendarId Aktualisiert die Metadaten für einen Kalender. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein get gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht 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 für einen Kalender.

Kanäle

Weitere Informationen zur Channels-Ressource finden Sie auf der Seite Ressourcendarstellung.

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

Farben

Weitere Informationen zur Colors-Ressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs 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 Events-Ressource finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs 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 basierend auf 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 diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt. Es können nur Ereignisse mit einem 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 ereignistyp-spezifischen Eigenschaften werden entfernt.
insert 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 eines Termins. Nur default-Ereignisse können verschoben werden. birthday-, focusTime-, fromGmail-, outOfOffice- 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. Beachten Sie, dass für jede Patch-Anfrage drei Kontingenteinheiten verbraucht werden. Verwenden Sie daher lieber ein get gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie in der Anfrage nicht 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 einem einfachen Textstring.

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ür eine partielle Aktualisierung führen Sie ein get und dann ein update mit ETags aus, um die Atomizität zu gewährleisten.
Smartwatch POST  /calendars/calendarId/events/watch Nach Änderungen an Ereignisressourcen suchen

Verfügbar/Beschäftigt

Weitere Informationen zu Ressourcen für die Verfügbarkeit finden Sie auf der Seite Ressourcendarstellung.

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

Einstellungen

Weitere Informationen zur Ressource „Settings“ finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu 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 Nach Änderungen an Einstellungen-Ressourcen suchen