CalendarList: list

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

Anfragen

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Optionale Suchparameter
maxResults integer Maximale Anzahl der auf einer Ergebnisseite zurückgegebenen Einträge. Standardmäßig beträgt der Wert 100 Einträge. Die Seitengröße darf maximal 250 Einträge betragen. Optional.
minAccessRole string Die minimale Zugriffsrolle für den Nutzer in den zurückgegebenen Einträgen. Optional. Der Standardwert ist keine Beschränkung.

Folgende Werte sind zulässig:
  • „freeBusyReader“: Der Nutzer kann Informationen zum Verfügbar/Beschäftigt-Status lesen.
  • „owner“: Der Nutzer kann Ereignisse und Access Control Lists lesen und ändern.
  • „reader“: Der Nutzer kann private Termine lesen.
  • „writer“: Der Nutzer kann Ereignisse lesen und ändern.
pageToken string Token, das angibt, welche Ergebnisseite zurückgegeben werden soll. Optional.
showDeleted boolean Gibt an, ob gelöschte Kalenderlisteneinträge in das Ergebnis aufgenommen werden sollen. Optional. Die Standardeinstellung ist "False".
showHidden boolean Gibt an, ob ausgeblendete Einträge angezeigt werden sollen. Optional. Die Standardeinstellung ist "False".
syncToken string Token aus dem Feld nextSyncToken, das auf der letzten Seite der Ergebnisse der vorherigen Listenanfrage zurückgegeben wurde. Das Ergebnis dieser Listenanfrage enthält 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 in der Ergebnismenge enthalten. showDeleted darf weder showHidden noch False festgelegt werden.
Damit die Konsistenz des ClientstatusminAccessRole nicht mit nextSyncToken angegeben werden kann.
Wenn syncToken abläuft, antwortet der Server mit einem 410 GONE-Antwortcode. Der Client sollte seinen Speicher löschen und eine vollständige Synchronisierung ohne syncToken ausführen.
Weitere Informationen zur inkrementellen Synchronisierung
Optional. Standardmäßig werden alle Einträge zurückgegeben.

Autorisierung

Für diese Anfrage ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

Umfang
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

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 Art der Sammlung („calendar#calendarList“).
etag etag ETag der Sammlung.
nextPageToken string Token für den Zugriff auf die nächste Seite dieses Ergebnisses. Ausgelassen, 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.

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.CalendarList;
import com.google.api.services.calendar.model.CalendarListEntry;

// ...

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

// Iterate through entries in calendar list
String pageToken = null;
do {
  CalendarList calendarList = service.calendarList().list().setPageToken(pageToken).execute();
  List<CalendarListEntry> items = calendarList.getItems();

  for (CalendarListEntry calendarListEntry : items) {
    System.out.println(calendarListEntry.getSummary());
  }
  pageToken = calendarList.getNextPageToken();
} while (pageToken != null);

Python

Verwendet die Python-Clientbibliothek.

page_token = None
while True:
  calendar_list = service.calendarList().list(pageToken=page_token).execute()
  for calendar_list_entry in calendar_list['items']:
    print calendar_list_entry['summary']
  page_token = calendar_list.get('nextPageToken')
  if not page_token:
    break

PHP

Verwendet die PHP-Clientbibliothek.

$calendarList = $service->calendarList->listCalendarList();

while(true) {
  foreach ($calendarList->getItems() as $calendarListEntry) {
    echo $calendarListEntry->getSummary();
  }
  $pageToken = $calendarList->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $calendarList = $service->calendarList->listCalendarList($optParams);
  } else {
    break;
  }
}

Ruby

Verwendet die Ruby-Clientbibliothek.

page_token = nil
begin
  result = client.list_calendar_lists(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.