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

Acl: list

Renvoie les règles de la liste de contrôle d'accès de l'agenda. Essayez maintenant ou voir un exemple

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`calendarId`	`string`	Identifiant de l'agenda. Pour récupérer les ID d'agenda, appelez la méthode calendarList.list. Si vous souhaitez accéder à l'agenda principal de l'utilisateur actuellement connecté, utilisez le mot clé "`primary`".
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 100 entrées. La taille de la page ne peut jamais dépasser 250 entrées. Facultatif.
`pageToken`	`string`	Jeton spécifiant la page de résultats à renvoyer. Facultatif.
`showDeleted`	`boolean`	Indique si les LCA supprimées doivent être incluses dans le résultat. Les LCA supprimées sont représentées par `role` égal à "`none`". Les LCA supprimées sont toujours incluses si `syncToken` est fourni. 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. Le résultat de cette requête de liste ne contient alors que les entrées qui ont changé depuis. Toutes les entrées supprimées depuis la précédente requête de liste seront toujours incluses dans l'ensemble de résultats, et il n'est pas autorisé de définir `showDeleted` sur "False". Si l'`syncToken` expire, le serveur répond avec un code de réponse 410 GONE. Le client doit alors vider son espace de stockage et effectuer une synchronisation complète sans `syncToken`. En savoir plus sur la synchronisation incrémentielle Facultatif. Par défaut, toutes les entrées sont renvoyées.

Autorisation

Cette requête nécessite une autorisation avec au moins l'un des champs d'application suivants:

Portée
`https://www.googleapis.com/auth/calendar`
`https://www.googleapis.com/auth/calendar.acls`
`https://www.googleapis.com/auth/calendar.acls.readonly`

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#acl",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    acl Resource
  ]
}

Nom de propriété	Valeur	Description
`kind`	`string`	Type de la collection ("`calendar#acl`").
`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`	Liste des règles de la liste de contrôle d'accès.
`nextSyncToken`	`string`	Jeton utilisé ultérieurement pour ne récupérer que les entrées qui ont changé 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.Acl;
import com.google.api.services.calendar.model.AclRule;

// ...

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

// Iterate over a list of access rules
Acl acl = service.acl().list('primary').execute();

for (AclRule rule : acl.getItems()) {
  System.out.println(rule.getId() + ": " + rule.getRole());
}

Python

Utilise la bibliothèque cliente Python.

acl = service.acl().list(calendarId='primary').execute()

for rule in acl['items']:
  print '%s: %s' % (rule['id'], rule['role'])

PHP

Utilise la bibliothèque cliente PHP.

$acl = $service->acl->listAcl('primary');

foreach ($acl->getItems() as $rule) {
  echo $rule->getId() . ': ' . $rule->getRole();
}

Ruby

Utilise la bibliothèque cliente Ruby.

result = client.list_acls('primary')
result.items.each do |e|
  print e.id + ": " + e.role + "\n"
end

Essayer

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