Cette page a été traduite par l'API Cloud Translation.

CalendarList: list

Renvoie les agendas figurant dans la liste d'agendas de l'utilisateur. Essayez maintenant ou consultez un exemple.

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de requête facultatifs
`maxResults`	`integer`	Nombre maximal d'entrées renvoyées sur une page de résultats. Par défaut, la valeur est de 100 entrées. La taille de la page ne peut jamais être supérieure à 250 entrées. Facultatif.
`minAccessRole`	`string`	Rôle d'accès minimal de l'utilisateur dans les entrées renvoyées. Facultatif. Par défaut, aucune restriction n'est définie. Valeurs acceptées : "`freeBusyReader`": l'utilisateur peut lire les informations de disponibilité. "`owner`": l'utilisateur peut lire et modifier les événements et les listes de contrôle d'accès. "`reader`": l'utilisateur peut lire les événements qui ne sont pas privés. "`writer`": l'utilisateur peut lire et modifier les événements.
`pageToken`	`string`	Jeton spécifiant la page de résultats à renvoyer. Facultatif.
`showDeleted`	`boolean`	Permet d'inclure ou non les entrées de la liste d'agendas supprimées dans le résultat. Facultatif. La valeur par défaut est "False" (faux).
`showHidden`	`boolean`	Permet d'afficher ou non les entrées masquées. Facultatif. La valeur par défaut est "False" (faux).
`syncToken`	`string`	Jeton obtenu à partir du champ `nextSyncToken` renvoyé sur la dernière page de résultats de la requête de liste précédente. Ainsi, le résultat de cette demande de liste ne contiendra que les entrées qui ont été modifiées depuis. Si seuls des champs en lecture seule, tels que les propriétés de l'agenda ou les LCA ont été modifiés, l'entrée n'est pas renvoyée. Toutes les entrées supprimées et masquées depuis la demande de liste précédente figureront toujours dans l'ensemble de résultats. De plus, il n'est pas autorisé de définir `showDeleted` ni `showHidden` sur "False". Pour garantir la cohérence de l'état du client, le paramètre de requête `minAccessRole` ne peut pas être spécifié avec `nextSyncToken`. Si la valeur `syncToken` expire, le serveur renvoie un code de réponse 410 GONE, et le client doit effacer son espace de stockage et effectuer une synchronisation complète sans aucun `syncToken`. En savoir plus sur la synchronisation incrémentielle. Facultatif. La valeur par défaut consiste à renvoyer toutes les entrées.

Autorisation

Une autorisation est nécessaire pour cette requête avec au moins l'un des champs d'application suivants:

Définition du champ d'application
`https://www.googleapis.com/auth/calendar.readonly`
`https://www.googleapis.com/auth/calendar`

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}

Nom de propriété	Valeur	Description
`kind`	`string`	Type de collection ("`calendar#calendarList`").
`etag`	`etag`	ETag de la collection.
`nextPageToken`	`string`	Jeton utilisé pour accéder à la page suivante de ce résultat. Omis si aucun autre résultat n'est disponible, auquel cas `nextSyncToken` est fourni.
`items[]`	`list`	Agendas figurant dans la liste d'agendas de l'utilisateur.
`nextSyncToken`	`string`	Jeton utilisé ultérieurement pour récupérer uniquement les entrées qui ont été modifiées depuis le renvoi de ce résultat. Omis si d'autres résultats sont disponibles, auquel cas `nextPageToken` est fourni.

Exemples

Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).

Java

Utilise la bibliothèque cliente Java.

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

Utilise la bibliothèque cliente Python.

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

Utilise la bibliothèque cliente PHP.

$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

Utilise la bibliothèque cliente Ruby.

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?

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.