Events: instances

Gibt Instanzen des angegebenen wiederkehrenden Termins zurück. Jetzt testen

Anfrage

HTTP-Anfrage

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId/instances

Parameter

Parametername Wert Beschreibung
Pfadparameter
calendarId string Kalender-ID. Rufen Sie die Methode calendarList.list auf, um Kalender-IDs abzurufen. Wenn Sie auf den primären Kalender des aktuell angemeldeten Nutzers zugreifen möchten, verwenden Sie das Keyword „primary“.
eventId string Kennung für wiederkehrende Termine.
Optionale Abfrageparameter
alwaysIncludeEmail boolean Verworfen und ignoriert. Im Feld email wird immer ein Wert für den Organisator, den Ersteller und die Teilnehmer zurückgegeben, auch wenn keine echte E-Mail-Adresse verfügbar ist. In diesem Fall wird ein generierter, nicht funktionierender Wert angegeben.
maxAttendees integer Die maximale Anzahl der Teilnehmer, die in der Antwort enthalten sein sollen. Wenn es mehr Teilnehmer als die angegebene Anzahl gibt, wird nur der Teilnehmer zurückgegeben. Optional.
maxResults integer Maximale Anzahl der Ereignisse, die auf einer Ergebnisseite zurückgegeben werden. Der Standardwert ist 250 Ereignisse. Die Seitengröße darf nie mehr als 2.500 Ereignisse umfassen. Optional.
originalStart string Die ursprüngliche Startzeit der Instanz im Ergebnis. Optional.
pageToken string Token, das angibt, welche Ergebnisseite zurückgegeben werden soll. Optional.
showDeleted boolean Gibt an, ob gelöschte Ereignisse (mit status gleich „cancelled“) in das Ergebnis einbezogen werden sollen. Abgesagte Instanzen wiederkehrender Termine werden weiterhin berücksichtigt, wenn singleEvents auf „False“ gesetzt ist. Optional. Die Standardeinstellung ist "False".
timeMax datetime Die exklusive Obergrenze für die Startzeit eines Ereignisses, nach der gefiltert werden soll. Optional. Standardmäßig wird nicht nach Startzeit gefiltert. Muss ein RFC3339-Zeitstempel mit obligatorischem Zeitzonen-Offset sein.
timeMin datetime Untergrenze (einschließlich) für die Endzeit eines Ereignisses, nach der gefiltert werden soll. Optional. Standardmäßig wird nicht nach Endzeit gefiltert. Muss ein RFC3339-Zeitstempel mit obligatorischem Zeitzonen-Offset sein.
timeZone string In der Antwort verwendete Zeitzone. Optional. Standardmäßig wird die Zeitzone des Kalenders verwendet.

Autorisierung

Für diese Anfrage ist die Autorisierung mit mindestens einem der folgenden Bereiche erforderlich:

Umfang
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events.readonly
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.freebusy
https://www.googleapis.com/auth/calendar.events.owned
https://www.googleapis.com/auth/calendar.events.owned.readonly
https://www.googleapis.com/auth/calendar.events.public.readonly

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Mit dieser Methode keinen Anfragetext bereitstellen.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "calendar#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}
Name der Eigenschaft Wert Beschreibung Hinweise
kind string Typ der Sammlung („calendar#events“).
etag etag ETag der Sammlung.
summary string Titel des Kalenders. Schreibgeschützt.
description string Beschreibung des Kalenders. Schreibgeschützt.
updated datetime Zeitpunkt der letzten Änderung des Kalenders (als RFC3339-Zeitstempel). Schreibgeschützt.
timeZone string Die Zeitzone des Kalenders. Schreibgeschützt.
accessRole string Die Zugriffsrolle des Nutzers für diesen Kalender. Schreibgeschützt. Mögliche Werte:
  • none: Der Nutzer hat keinen Zugriff.
  • „freeBusyReader“: Der Nutzer hat Lesezugriff auf Verfügbarkeitsdaten.
  • „reader“: Der Nutzer hat Lesezugriff auf den Kalender. Private Termine werden Nutzern mit Lesezugriff angezeigt, Termindetails sind jedoch ausgeblendet.
  • „writer“: Der Nutzer hat Lese- und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Schreibzugriff angezeigt und Termindetails sind sichtbar.
  • „owner“: Der Nutzer hat Managerzugriff auf den Kalender. Diese Rolle hat alle Berechtigungen der Rolle „Autor“ und kann zusätzlich die Zugriffsebenen anderer Nutzer aufrufen und ändern.

defaultReminders[] list Die Standarderinnerungen im Kalender für den authentifizierten Nutzer. Diese Erinnerungen gelten für alle Termine in diesem Kalender, für die sie nicht explizit überschrieben werden (d.h. für die reminders.useDefault nicht auf „True“ gesetzt ist).
defaultReminders[].method string Die von dieser Erinnerung verwendete Methode. Mögliche Werte:
  • „email“: Erinnerungen werden per E-Mail gesendet.
  • „popup“: Erinnerungen werden über ein Pop-up-Fenster in der Benutzeroberfläche gesendet.

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 Bearbeitbar
defaultReminders[].minutes integer Anzahl der Minuten vor Beginn des Termins, zu der die Erinnerung ausgelöst werden soll. Gültige Werte liegen zwischen 0 und 40.320 (4 Wochen in Minuten).

Erforderlich, wenn Sie eine Erinnerung hinzufügen.

 Bearbeitbar
nextPageToken string Token für den Zugriff auf die nächste Seite dieses Ergebnisses. Wird weggelassen, wenn keine weiteren Ergebnisse verfügbar sind. In diesem Fall wird nextSyncToken angegeben.
items[] list Liste der Termine im Kalender.
nextSyncToken string Token, das später verwendet wird, um nur die Einträge abzurufen, die sich seit der Rückgabe dieses Ergebnisses geändert haben. Wird weggelassen, wenn weitere Ergebnisse verfügbar sind. In diesem Fall wird nextPageToken angegeben.

Testen!

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.