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. Kalenderliste
  3. Kalender
  4. Kanäle
  5. Farben
  6. Ereignisse
  7. Frei/Belegt
  8. Einstellungen

ACL

Weitere Informationen zu ACL-Ressourcen 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.
erhalten GET  /calendars/calendarId/acl/ruleId Gibt eine Zugriffssteuerungsregel zurück.
Einfügen 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 Regel für die Zugriffssteuerung. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass jede Patchanfrage drei Kontingenteinheiten verbraucht. Verwenden Sie vorzugsweise ein get, gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
Aktualisieren PUT  /calendars/calendarId/acl/ruleId Aktualisiert eine Regel für die Zugriffssteuerung.
ansehen POST  /calendars/calendarId/acl/watch Achten Sie auf Änderungen an ACL-Ressourcen.

Kalenderliste

Ausführliche Informationen zu Ressourcen vom Typ „CalendarList“ 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.
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 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 jede Patchanfrage drei Kontingenteinheiten verbraucht. Verwenden Sie vorzugsweise ein get, gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben 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.
ansehen POST  /users/me/calendarList/watch Achten Sie auf Änderungen an Kalenderlistenressourcen.

Kalender

Weitere Informationen zu Kalenderressourcen 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 Hauptkalender Bei 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. Verwenden Sie calendar.clear, um alle Termine in primären Kalendern zu löschen.
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 Metadaten für einen Kalender. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass jede Patchanfrage drei Kontingenteinheiten verbraucht. Verwenden Sie vorzugsweise ein get, gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
Aktualisieren PUT  /calendars/calendarId Aktualisiert Metadaten für einen Kalender.

Kanäle

Weitere Informationen zu Kanalressourcen finden Sie auf der Seite Ressourcendarstellung.

Methode HTTP-Anfrage Beschreibung
URIs relativ zu https://www.googleapis.com/calendar/v3, sofern nicht anders angegeben
Beenden POST  /channels/stop Über diesen Kanal kannst du dir keine Ressourcen mehr ansehen.

Farben

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

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

Ereignisse

Weitere Informationen zu Ressourcen vom Typ „Events“ 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.
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 Parameter iCalUID auf.
Importieren POST  /calendars/calendarId/events/import Importiert einen Termin. Mit diesem Vorgang wird einem Kalender eine private Kopie eines vorhandenen Termins hinzugefügt.
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 Ein Termin wird in einen anderen Kalender verschoben, d.h. der Organisator eines Termins wird geändert.

Erforderliche Suchparameter: destination

Patch PATCH  /calendars/calendarId/events/eventId Aktualisiert einen Termin. Diese Methode unterstützt die Patch-Semantik. Beachten Sie, dass jede Patchanfrage drei Kontingenteinheiten verbraucht. Verwenden Sie vorzugsweise ein get, gefolgt von einem update. Die von Ihnen angegebenen Feldwerte ersetzen die vorhandenen Werte. Felder, die Sie nicht in der Anfrage angeben, bleiben unverändert. Array-Felder, falls angegeben, überschreiben die vorhandenen Arrays. Dadurch werden alle vorherigen Array-Elemente verworfen.
schnell hinzufügen POST  /calendars/calendarId/events/quickAdd Erstellt ein Ereignis, das auf einem einfachen Textstring basiert.

Erforderliche Suchparameter: text

Aktualisieren PUT  /calendars/calendarId/events/eventId Aktualisiert einen Termin. Diese Methode unterstützt keine Patchsemantik und aktualisiert immer die gesamte Ereignisressource. Für eine Teilaktualisierung führen Sie ein get gefolgt von einem update aus und verwenden dabei ETags, um die Atomarität zu gewährleisten.
ansehen POST  /calendars/calendarId/events/watch Achten Sie auf Änderungen an Ereignisressourcen.

Verfügbar/Beschäftigt

Ausführliche Informationen zur Ressource vom Typ „Frei“ 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 den Verfügbar/Beschäftigt-Status von Kalendern zurück.

Einstellungen

Ausführliche Informationen zu Ressourcen vom Typ „Settings“ (Ressourcen) finden Sie auf der Seite Ressourcendarstellung.

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