Gibt Instanzen des angegebenen wiederkehrenden Termins zurück. Jetzt testen oder Beispiel ansehen
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 des wiederkehrenden Ereignisses. |
Optionale Suchparameter | ||
alwaysIncludeEmail |
boolean |
Verworfen und ignoriert. Für den Organisator, den Ersteller und die Teilnehmer wird immer ein Wert im Feld email zurückgegeben, auch wenn keine echte E-Mail-Adresse verfügbar ist. Es wird also ein generierter, nicht funktionierender Wert angegeben.
|
maxAttendees |
integer |
Die maximale Anzahl der Teilnehmer, die in der Antwort enthalten sein sollen. Wenn die Anzahl der Teilnehmer über der angegebenen Anzahl liegt, wird nur der Teilnehmer zurückgegeben. Optional. |
maxResults |
integer |
Maximale Anzahl von Ereignissen, die auf einer Ergebnisseite zurückgegeben werden. Der Standardwert ist 250 Ereignisse. Die Seitengröße darf maximal 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 (status = cancelled ) in das Ergebnis eingeschlossen werden sollen. Abgesagte Instanzen von wiederkehrenden Ereignissen werden weiterhin berücksichtigt, wenn singleEvents auf „False“ (Falsch) gesetzt ist. Optional. Die Standardeinstellung ist "False".
|
timeMax |
datetime |
Obergrenze (exklusiv) für den Beginn eines Ereignisses, nach dem gefiltert werden soll. Optional. Standardmäßig wird nicht nach Beginnzeit gefiltert. Muss ein RFC3339-Zeitstempel mit obligatorischem Zeitzonen-Versatz sein. |
timeMin |
datetime |
Untere Grenze (inklusive) 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-Versatz sein. |
timeZone |
string |
Die in der Antwort verwendete Zeitzone. Optional. Standardmäßig ist die Zeitzone des Kalenders festgelegt. |
Autorisierung
Diese Anfrage ermöglicht die Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
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 |
Die letzte Änderungszeit 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:
|
|
defaultReminders[] |
list |
Die Standarderinnerungen im Kalender des authentifizierten Nutzers. Diese Erinnerungen gelten für alle Termine in diesem Kalender, die nicht explizit überschrieben werden (d.h. für die reminders.useDefault nicht auf „Wahr“ gesetzt ist). |
|
defaultReminders[].method |
string |
Die von dieser Erinnerung verwendete Methode. Mögliche Werte sind:
Erforderlich, wenn Sie eine Erinnerung hinzufügen. |
Bearbeitbar |
defaultReminders[].minutes |
integer |
Anzahl der Minuten vor Beginn der Veranstaltung, 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, 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.