CalendarList: list

Devuelve los calendarios de la lista de calendarios del usuario. Pruébalo ahora.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre del parámetro Valor Descripción
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 mayor que 250 entradas. Opcional.
minAccessRole string Es el rol de acceso mínimo para el usuario en las entradas devueltas. Opcional. El valor predeterminado es sin restricciones.

Los valores aceptables son los siguientes:
  • "freeBusyReader": El usuario puede leer la información de disponibilidad.
  • "owner": El usuario puede leer y modificar eventos, y acceder a las listas de control de acceso.
  • "reader": El usuario puede leer eventos que no son privados.
  • "writer": El usuario puede leer y modificar eventos.
  • "writerWithoutPrivateAccess": El usuario puede leer y modificar eventos, pero no puede acceder a eventos privados.
pageToken string Es un token que especifica qué página de resultados se debe devolver. Opcional.
showDeleted boolean Indica si se deben incluir en el resultado las entradas de la lista de calendarios borradas. Opcional. El valor predeterminado es False.
showHidden boolean Indica si se deben mostrar las entradas ocultas. Opcional. El valor predeterminado es False.
syncToken string Es el token que se obtuvo del campo nextSyncToken que se devolvió 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. Si solo cambiaron los campos de solo lectura, como las propiedades del calendario o las ACL, no se devolverá la entrada. Todas las entradas borradas y ocultas desde la solicitud de lista anterior siempre estarán en el conjunto de resultados, y no se permite establecer showDeleted ni showHidden como falso.
Para garantizar la coherencia del estado del cliente, el parámetro de consulta minAccessRole no se puede especificar junto con nextSyncToken.
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 devolver 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.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.calendarlist
https://www.googleapis.com/auth/calendar.calendarlist.readonly

Para obtener más información, consulta la página de 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#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nombre de la propiedad Valor Descripción Notas
kind string Tipo de la colección ("calendar#calendarList").
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 Son los calendarios que se encuentran en la lista de calendarios del usuario.
nextSyncToken string Es el token que se usa en un momento posterior para recuperar solo las entradas que cambiaron desde que se devolvió este resultado. Se omite si hay más resultados disponibles, en cuyo caso se proporciona nextPageToken.

Pruébalo

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