CalendarList: list

Gibt die Kalender in der Kalenderliste des Nutzers zurück. Jetzt testen

Anfrage

HTTP-Anfrage

GET https://www.googleapis.com/calendar/v3/users/me/calendarList

Parameter

Parametername Wert Beschreibung
Optionale Suchparameter
maxResults integer Maximale Anzahl der Einträge, die auf einer Ergebnisseite zurückgegeben werden. Standardmäßig ist der Wert 100 Einträge. Die Seitengröße darf niemals mehr als 250 Einträge umfassen. Optional.
minAccessRole string Die Mindestzugriffsrolle für den Nutzer in den zurückgegebenen Einträgen. Optional. Standardmäßig gilt keine Einschränkung.

Zulässige Werte sind:
  • freeBusyReader“: Der Nutzer kann Verfügbarkeitsinformationen lesen.
  • owner“: Der Nutzer kann Ereignisse und Zugriffskontrolllisten lesen und ändern.
  • reader“: Der Nutzer kann Ereignisse lesen, die nicht privat sind.
  • writer“: Der Nutzer kann Ereignisse lesen und ändern.
pageToken string Token, das angibt, welche Ergebnisseite zurückgegeben werden soll. Optional.
showDeleted boolean Ob gelöschte Kalenderlisteneinträge in das Ergebnis einbezogen werden sollen. Optional. Die Standardeinstellung ist "False".
showHidden boolean Ob ausgeblendete Einträge angezeigt werden sollen. Optional. Die Standardeinstellung ist "False".
syncToken string Token aus dem Feld nextSyncToken, das auf der letzten Ergebnisseite der vorherigen Listenanfrage zurückgegeben wurde. Dadurch enthält das Ergebnis dieser Listenanfrage nur Einträge, die sich seitdem geändert haben. Wenn sich nur schreibgeschützte Felder wie Kalendereigenschaften oder ACLs geändert haben, wird der Eintrag nicht zurückgegeben. Alle Einträge, die seit der vorherigen Listenanfrage gelöscht und ausgeblendet wurden, sind immer im Ergebnissatz enthalten. Außerdem ist es nicht zulässig, showDeleted oder showHidden auf „Falsch“ zu setzen.
Um für Konsistenz des Clientstatus zu sorgen, kann der Abfrageparameter minAccessRole nicht zusammen mit nextSyncToken angegeben werden.
Wenn die syncToken abläuft, antwortet der Server mit dem Antwortcode 410 GONE. Der Client sollte dann seinen Speicher leeren und eine vollständige Synchronisierung ohne syncToken ausführen.
Weitere Informationen zur inkrementellen Synchronisierung
Optional. Standardmäßig werden alle Einträge zurückgegeben.

Autorisierung

Diese Anfrage erfordert eine 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.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.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#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Name der Eigenschaft Wert Beschreibung Hinweise
kind string Typ der Sammlung („calendar#calendarList“).
etag etag ETag der Sammlung.
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 Kalender, die in der Kalenderliste des Nutzers vorhanden sind.
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.

Testen!

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