Acl: list

Muestra las reglas de la lista de control de acceso del calendario. Pruébalo ahora y ve un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta de acceso
calendarId string Es el identificador del calendario. Para recuperar los IDs de calendario, llama al método calendarList.list. Si deseas acceder al calendario principal del usuario que accedió actualmente, usa la palabra clave "primary".
Parámetros de consulta opcionales
maxResults integer Es la cantidad máxima de entradas que se muestran en una página de resultados. De forma predeterminada, el valor es de 100 entradas. El tamaño de la página nunca puede ser superior a 250 entradas. Opcional.
pageToken string Es un token que especifica qué página de resultados se mostrará. Opcional.
showDeleted boolean Indica si se deben incluir las ACL borradas en el resultado. Las LCA borradas se representan con role igual a "none". Las LCA borradas siempre se incluirán si se proporciona syncToken. Opcional. El valor predeterminado es False.
syncToken string Es el token obtenido del campo nextSyncToken que se muestra en la última página de resultados de la solicitud de lista anterior. Hace que el resultado de esta solicitud de lista contenga solo las entradas que cambiaron desde entonces. Todas las entradas borradas desde la solicitud de lista anterior siempre estarán en el conjunto de resultados y no se puede establecer showDeleted como False.
Si vence el syncToken, el servidor responderá con un código de respuesta 410 GONE y el cliente deberá borrar su almacenamiento y realizar una sincronización completa sin ningún syncToken.
Obtén más información sobre la sincronización incremental.
Opcional. La opción predeterminada es mostrar todas las entradas.

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes permisos:

Alcance
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.acls
https://www.googleapis.com/auth/calendar.acls.readonly

Para obtener más información, consulta la página autenticación y autorización.

Cuerpo de la solicitud

No proporciones un cuerpo de la solicitud con este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "calendar#acl",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    acl Resource
  ]
}
Nombre de la propiedad Valor Descripción Notas
kind string Es el tipo de la colección ("calendar#acl").
etag etag ETag de la colección.
nextPageToken string Es el token que se usa para acceder a la siguiente página de este resultado. Se omite si no hay más resultados disponibles, en cuyo caso se proporciona nextSyncToken.
items[] list Es la lista de reglas de la lista de control de acceso.
nextSyncToken string Es un token que se usa más adelante para recuperar solo las entradas que cambiaron desde que se mostró este resultado. Se omite si hay más resultados disponibles, en cuyo caso se proporciona nextPageToken.

Ejemplos

Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas cliente para consultar una lista de lenguajes admitidos).

Java

Usa la biblioteca cliente de 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

Usa la biblioteca cliente de Python.

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

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

PHP

Usa la biblioteca cliente de PHP.

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

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

Ruby

Usa la biblioteca cliente de Ruby.

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

Pruébalo

Usa el Explorador de APIs que aparece a continuación para llamar a este método en datos en vivo y ver la respuesta.