Diese Seite wurde von der Cloud Translation API übersetzt.

Events: list

Gibt Termine im angegebenen Kalender 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

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.
Optionale Abfrageparameter
`alwaysIncludeEmail`	`boolean`	Eingestellt und ignoriert.
`eventTypes`	`string`	Ereignistypen, die zurückgegeben werden sollen. Optional. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse unterschiedlichen Typs zurückzugeben. Wenn kein Wert festgelegt ist, werden alle Ereignistypen zurückgegeben. Zulässige Werte sind: <ph type="x-smartling-placeholder"> </ph> "`default`": Regelmäßige Ereignisse. „`focusTime`“: Fokuszeit-Ereignisse. „`fromGmail`“: Termine aus Gmail. „`outOfOffice`“: Außer-Haus-Termine. „`workingLocation`“: Ereignisse zu Arbeitsorten.
`iCalUID`	`string`	Gibt eine Termin-ID im iCalendar-Format an, die in der Antwort angegeben werden soll. Optional. Verwenden Sie diese Option, wenn Sie anhand der iKalender-ID nach einem Termin suchen möchten.
`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 Die Anzahl der Ereignisse auf der resultierenden Seite kann kleiner als dieser Wert oder gar keine sein, auch wenn es mehr Ereignisse gibt, die der Abfrage entsprechen. Unvollständige Seiten können durch ein nicht leeres `nextPageToken`-Feld in der Antwort erkannt werden. Der Standardwert ist 250 Ereignisse. Die Seite darf nicht größer als 2.500 Ereignisse sein. Optional.
`orderBy`	`string`	Die Reihenfolge der im Ergebnis zurückgegebenen Ereignisse. Optional. Die Standardeinstellung ist eine nicht spezifizierte, stabile Reihenfolge. Zulässige Werte sind: <ph type="x-smartling-placeholder"> </ph> "`startTime`": Sortiert nach Startdatum/-uhrzeit (aufsteigend). Diese Option ist nur bei der Abfrage einzelner Ereignisse verfügbar, d. h., der Parameter `singleEvents` ist „True“. "`updated`": Sortiert nach dem Zeitpunkt der letzten Änderung (aufsteigend).
`pageToken`	`string`	Token, das angibt, welche Ergebnisseite zurückgegeben werden soll. Optional.
`privateExtendedProperty`	`string`	Einschränkung für erweiterte Attribute, angegeben als propertyName=value. Stimmt nur mit privaten Properties überein. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse zurückzugeben, die allen gegebenen Einschränkungen entsprechen.
`q`	`string`	Mit Freitextsuchbegriffen können Sie Ereignisse finden, die diesen Begriffen in den folgenden Feldern entsprechen: `summary` `description` `location` `displayName` des Teilnehmers `email` des Teilnehmers `displayName` des Organisators `email` des Organisators `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Außerdem werden bei diesen Suchbegriffen vordefinierte Keywords mit allen Übersetzungen der Anzeigetitel von Arbeitsort, Abwesenheit und Fokuszeit-Terminen abgeglichen. Beispiel: Die Suche nach „Büro“ oder „Bureau“ gibt Arbeitsorte vom Typ `officeLocation` zurück, während nach „Außer Haus“ gesucht wird. oder "Zulassung" gibt Außer-Haus-Termine zurück. Optional.
`sharedExtendedProperty`	`string`	Einschränkung für erweiterte Attribute, angegeben als propertyName=value. Es werden nur gemeinsame Properties abgeglichen. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse zurückzugeben, die allen gegebenen Einschränkungen entsprechen.
`showDeleted`	`boolean`	Gibt an, ob gelöschte Ereignisse (mit `status` gleich „`cancelled`“) in das Ergebnis aufgenommen werden sollen. Abgesagte Instanzen wiederkehrender Termine (aber nicht der zugrunde liegende wiederkehrende Termin) werden weiterhin eingeschlossen, wenn sowohl `showDeleted` als auch `singleEvents` "False" sind. Wenn sowohl `showDeleted` als auch `singleEvents` „True“ sind, werden nur einzelne Instanzen gelöschter Ereignisse zurückgegeben. Die zugrunde liegenden wiederkehrenden Ereignisse werden jedoch nicht zurückgegeben. Optional. Die Standardeinstellung ist "False".
`showHiddenInvitations`	`boolean`	Gibt an, ob ausgeblendete Einladungen in das Ergebnis einbezogen werden sollen. Optional. Die Standardeinstellung ist "False".
`singleEvents`	`boolean`	Gibt an, ob wiederkehrende Termine auf Instanzen erweitert werden sollen und nur einzelne einmalige Termine und Instanzen wiederkehrender Ereignisse zurückgegeben werden, aber nicht die zugrunde liegenden wiederkehrenden Termine selbst. Optional. Die Standardeinstellung ist "False".
`syncToken`	`string`	Token, das aus dem Feld `nextSyncToken` abgerufen wurde, das auf der letzten Seite der Ergebnisse der vorherigen Listenanfrage zurückgegeben wurde. Dadurch enthält das Ergebnis dieser Listenanfrage nur Einträge, die sich seitdem geändert haben. Alle Ereignisse, die seit der vorherigen Listenanfrage gelöscht wurden, sind immer in der Ergebnismenge enthalten. `showDeleted` darf nicht auf „False“ gesetzt werden. Es gibt mehrere Abfrageparameter, die nicht zusammen mit `nextSyncToken` angegeben werden können, um für Konsistenz des Clientstatus zu sorgen. Diese sind: `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` Alle anderen Abfrageparameter sollten mit denen für die erste Synchronisierung übereinstimmen, um undefiniertes Verhalten zu vermeiden. Wenn `syncToken` abläuft, antwortet der Server mit dem Antwortcode 410 GONE und der Client sollte den Speicher löschen und eine vollständige Synchronisierung ohne `syncToken` durchführen. Weitere Informationen zur inkrementellen Synchronisierung. Optional. Standardmäßig werden alle Einträge zurückgegeben.
`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, z. B. 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Millisekunden können angegeben werden, werden aber ignoriert. Wenn `timeMin` festgelegt ist, muss `timeMax` größer als `timeMin` sein.
`timeMin`	`datetime`	Untergrenze (exklusiv) 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, z. B. 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Millisekunden können angegeben werden, werden aber ignoriert. Wenn `timeMax` festgelegt ist, muss `timeMin` kleiner als `timeMax` sein.
`timeZone`	`string`	In der Antwort verwendete Zeitzone. Optional. Standardmäßig wird die Zeitzone des Kalenders verwendet.
`updatedMin`	`datetime`	Untergrenze für den Zeitpunkt der letzten Änderung eines Ereignisses (als RFC3339-Zeitstempel), nach dem gefiltert werden soll. Wenn dieses Flag angegeben ist, werden Einträge, die seit diesem Zeitpunkt gelöscht wurden, unabhängig von `showDeleted` immer eingeschlossen. Optional. Standardmäßig wird nicht nach dem Zeitpunkt der letzten Änderung gefiltert.

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 events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').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().list(calendarId='primary', 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->listEvents('primary');

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

Ruby

Verwendet die Ruby-Clientbibliothek.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  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.