Diese Seite wurde von der Cloud Translation API übersetzt.

Events: list

Gibt Termine im angegebenen Kalender zurück. Jetzt testen

Anfrage

HTTP-Anfrage

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

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`“.
Optionale Abfrageparameter
`alwaysIncludeEmail`	`boolean`	Verworfen und ignoriert.
`eventTypes`	`string`	Ereignistypen, die zurückgegeben werden sollen. Optional. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse verschiedener Typen zurückzugeben. Wenn nicht festgelegt, werden alle Ereignistypen zurückgegeben. Zulässige Werte sind: „`birthday`“: Besondere ganztägige Termine, die jährlich wiederkehren. „`default`“: Regelmäßig stattfindende Ereignisse. „`focusTime`“: Fokuszeittermine. `fromGmail`: Termine aus Gmail „`outOfOffice`“: Außer-Haus-Termine. „`workingLocation`“: Ereignisse zum Arbeitsort.
`iCalUID`	`string`	Gibt eine Ereignis-ID im iCalendar-Format an, die in der Antwort angegeben werden soll. Optional. Verwenden Sie diese Option, wenn Sie nach einem Termin anhand seiner iCalendar-ID suchen möchten.
`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. Die Anzahl der Ereignisse auf der resultierenden Seite kann geringer als dieser Wert sein oder sogar null betragen, auch wenn es weitere Ereignisse gibt, die der Anfrage entsprechen. Unvollständige Seiten können durch ein nicht leeres Feld `nextPageToken` in der Antwort erkannt werden. Der Standardwert ist 250 Ereignisse. Die Seitengröße darf nie mehr als 2.500 Ereignisse umfassen. Optional.
`orderBy`	`string`	Die Reihenfolge der Ereignisse, die im Ergebnis zurückgegeben werden. Optional. Die Standardeinstellung ist eine nicht spezifizierte, stabile Reihenfolge. Zulässige Werte sind: „`startTime`“: Nach Startdatum/-zeit (aufsteigend) sortieren. Das ist nur beim Abfragen einzelner Ereignisse verfügbar (d. h. wenn der Parameter `singleEvents` auf „True“ gesetzt ist). „`updated`“: Nach der Zeit der letzten Änderung sortieren (aufsteigend).
`pageToken`	`string`	Token, das angibt, welche Ergebnisseite zurückgegeben werden soll. Optional.
`privateExtendedProperty`	`string`	Einschränkung für erweiterte Attribute, die als „propertyName=value“ angegeben wird. Entspricht nur privaten Properties. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse zurückzugeben, die allen angegebenen Einschränkungen entsprechen.
`q`	`string`	Freitext-Suchbegriffe, um Ereignisse zu finden, die in den folgenden Feldern mit diesen Begriffen übereinstimmen: `summary` `description` `location` `displayName` des Gastes `email` des Gastes `displayName` des Organisators `email` des Organisators `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Diese Suchbegriffe werden auch mit vordefinierten Keywords für alle Übersetzungen von Anzeigetiteln für Ereignisse vom Typ „Arbeitsort“, „Abwesenheit“ und „Fokuszeit“ abgeglichen. Wenn Sie beispielsweise nach „Büro“ oder „Office“ suchen, werden Arbeitsorttermine vom Typ `officeLocation` zurückgegeben. Wenn Sie nach „Abwesend“ oder „Out of office“ suchen, werden Termine für Abwesenheit zurückgegeben. Optional.
`sharedExtendedProperty`	`string`	Einschränkung für erweiterte Attribute, die als „propertyName=value“ angegeben wird. Es werden nur freigegebene Properties berücksichtigt. Dieser Parameter kann mehrmals wiederholt werden, um Ereignisse zurückzugeben, die allen angegebenen Einschränkungen entsprechen.
`showDeleted`	`boolean`	Gibt an, ob gelöschte Ereignisse (mit `status` gleich „`cancelled`“) in das Ergebnis einbezogen werden sollen. Abgesagte Instanzen von wiederkehrenden Terminen (aber nicht der zugrunde liegende wiederkehrende Termin) werden weiterhin berücksichtigt, wenn sowohl `showDeleted` als auch `singleEvents` auf „False“ gesetzt sind. Wenn sowohl `showDeleted` als auch `singleEvents` „True“ sind, werden nur einzelne Instanzen gelöschter Termine (aber nicht die zugrunde liegenden wiederkehrenden Termine) zurückgegeben. Optional. Die Standardeinstellung ist "False".
`showHiddenInvitations`	`boolean`	Gibt an, ob ausgeblendete Einladungen im Ergebnis enthalten sein sollen. Optional. Die Standardeinstellung ist "False".
`singleEvents`	`boolean`	Gibt an, ob wiederkehrende Termine in Instanzen aufgeschlüsselt und nur einzelne einmalige Termine und Instanzen wiederkehrender Termine zurückgegeben werden sollen, nicht aber 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 Ergebnisseite der vorherigen Listenanfrage zurückgegeben wurde. Das Ergebnis dieser Listenanfrage enthält dann nur Einträge, die sich seitdem geändert haben. Alle seit der letzten Listenanfrage gelöschten Ereignisse sind immer im Ergebnissatz enthalten. Es ist nicht zulässig, `showDeleted` auf „False“ zu setzen. Es gibt mehrere Abfrageparameter, die nicht zusammen mit `nextSyncToken` angegeben werden können, um die Konsistenz des Clientstatus zu gewährleisten. Dazu gehören: `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` Alle anderen Abfrageparameter sollten mit denen der ersten Synchronisierung übereinstimmen, um undefiniertes Verhalten zu vermeiden. Wenn das `syncToken` abläuft, antwortet der Server mit dem Antwortcode 410 GONE. Der Client sollte seinen Speicher leeren 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`	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, 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`	Die Untergrenze (exklusiv) 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, 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 die Uhrzeit der letzten Änderung eines Ereignisses (als RFC3339-Zeitstempel), nach der gefiltert werden soll. Wenn angegeben, werden Einträge, die seit diesem Zeitpunkt gelöscht wurden, immer berücksichtigt, unabhängig von `showDeleted`. Optional. Standardmäßig wird nicht nach der Zeit der letzten Änderung gefiltert.

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. Wichtig: Die Rolle `owner` unterscheidet sich vom Dateninhaber des Kalenders. Ein Kalender hat einen einzelnen Dateninhaber, kann aber mehrere Nutzer mit der Rolle `owner` haben.
`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.