Renvoie les règles figurant dans la liste de contrôle d'accès de l'agenda. Essayez dès maintenant ou consultez 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 bouton "primary " mot clé.
|
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 dépasser 250 entrées. Facultatif. |
pageToken |
string |
Jeton spécifiant la page de résultats à renvoyer. Facultatif. |
showDeleted |
boolean |
Indique s'il faut inclure les LCA supprimées dans le résultat. Les LCA supprimées sont représentées par role égal à "none ". Les LCA supprimées seront 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 été modifiées depuis. Toutes les entrées supprimées depuis la requête de liste précédente figureront toujours dans l'ensemble de résultats, et vous n'êtes pas autorisé à définir showDeleted sur "False". Si le 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 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 ayant le champ d'application suivant:
Champ d'application |
---|
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#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
Nom de propriété | Valeur | Description | Remarques |
---|---|---|---|
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 récupérer uniquement les entrées qui ont été modifiées depuis que ce résultat a été renvoyé. Ignoré 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
Elle 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
Elle 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
Elle utilise la bibliothèque cliente PHP.
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Ruby
Elle 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.