Events: instances

Gibt Instanzen des angegebenen wiederkehrenden Termins zurück Probieren Sie es jetzt aus oder sehen Sie sich ein Beispiel an.

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 zum Abrufen von Kalender-IDs die Methode calendarList.list auf. Wenn Sie auf den Hauptkalender des derzeit angemeldeten Nutzers zugreifen möchten, verwenden Sie die „primary“ Keyword.
eventId string ID für wiederkehrende Ereignisse.
Optionale Abfrageparameter
alwaysIncludeEmail boolean Eingestellt und ignoriert. Im Feld email wird für den Organisator, den Ersteller und die Teilnehmer immer ein Wert zurückgegeben, auch wenn keine echte E-Mail-Adresse verfügbar ist (d.h. ein generierter, nicht funktionsfähiger Wert wird bereitgestellt).
maxAttendees integer Die maximale Anzahl von Teilnehmern, die in die Antwort aufgenommen werden sollen. Wenn mehr als die angegebene Anzahl von Teilnehmern vorhanden ist, 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 Seite darf nicht größer als 2.500 Ereignisse sein. 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 aufgenommen werden sollen. Abgebrochene Instanzen wiederkehrender Termine werden weiterhin eingeschlossen, wenn singleEvents auf "False" gesetzt ist. Optional. Die Standardeinstellung ist "False".
timeMax datetime Obergrenze (exklusiv) für die Startzeit eines Ereignisses, nach der gefiltert werden soll. Optional. Standardmäßig wird nicht nach der Startzeit gefiltert. Muss ein RFC3339-Zeitstempel mit obligatorischem Zeitzonenversatz sein.
timeMin datetime Untergrenze (einschließlich) für das Ende eines Ereignisses, nach dem gefiltert werden soll. Optional. Standardmäßig wird nicht nach Endzeit gefiltert. Muss ein RFC3339-Zeitstempel mit obligatorischem Zeitzonenversatz sein.
timeZone string In der Antwort verwendete Zeitzone. Optional. Standardmäßig wird die Zeitzone des Kalenders verwendet.

Autorisierung

Diese Anfrage lässt eine Autorisierung mit mindestens einem der folgenden Bereiche zu:

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

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 Das 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 sind:
  • „none“ - Der Nutzer hat keinen Zugriff.
  • „freeBusyReader“ - Der Nutzer hat Lesezugriff auf Informationen zur Verfügbarkeit.
  • „reader“ – Der Nutzer hat Lesezugriff auf den Kalender. Private Termine werden Nutzern mit Lesezugriff angezeigt, die Termindetails werden jedoch ausgeblendet.
  • „writer“ – Der Nutzer hat Lese- und Schreibzugriff auf den Kalender. Private Termine werden Nutzern mit Schreibberechtigung angezeigt und Termindetails werden angezeigt.
  • „owner“ – Der Nutzer ist Eigentümer des Kalenders. Diese Rolle verfügt über alle Berechtigungen der Rolle „Writer“, bietet zusätzlich die Möglichkeit, ACLs aufzurufen und zu bearbeiten.
defaultReminders[] list Die Standarderinnerungen im Kalender für den authentifizierten Nutzer. Diese Erinnerungen gelten für alle Termine in diesem Kalender, bei denen sie nicht explizit überschrieben werden (d.h., reminders.useDefault ist nicht auf „True“ gesetzt).
defaultReminders[].method string Die von dieser Erinnerung verwendete Methode. Mögliche Werte sind:
  • „email“ - Erinnerungen werden per E-Mail gesendet.
  • „popup“ - Erinnerungen werden über ein Pop-up-Fenster auf der Benutzeroberfläche gesendet.

Erforderlich beim Hinzufügen einer Erinnerung.

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

Erforderlich beim Hinzufügen einer Erinnerung.

 Bearbeitbar
nextPageToken string Token, das für den Zugriff auf die nächste Seite dieses Ergebnisses verwendet wird. 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 zu einem späteren Zeitpunkt 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.

Beispiele

Hinweis: Bei den für diese Methode verfügbaren Codebeispielen sind nicht alle unterstützten Programmiersprachen vertreten. Eine Liste der unterstützten Sprachen finden Sie auf der Seite für Clientbibliotheken.

Java

Verwendet die Java-Clientbibliothek.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the instances of a specific recurring event
String pageToken = null;
do {
  Events events =
      service.events().instances('primary', 'eventId').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Python

Verwendet die Python-Clientbibliothek.

page_token = None
while True:
  events = service.events().instances(calendarId='primary', eventId='eventId',
                                      pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

Verwendet die PHP-Clientbibliothek.

$events = $service->events->instances('primary', "eventId");

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->instances('primary', "eventId",
        $optParams);
  } else {
    break;
  }
}

Ruby

Verwendet die Ruby-Clientbibliothek.

page_token = nil
begin
  result = client.list_event_instances('primary', 'eventId')
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Testen!

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