CalendarList: list

Muestra 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 superior a 250 entradas. Es opcional.
minAccessRole string Es el rol de acceso mínimo para el usuario en las entradas que se muestran. Es opcional. El valor predeterminado es sin restricción.

Se aceptan los siguientes valores:
  • "freeBusyReader": El usuario puede leer información sobre la disponibilidad.
  • "owner": El usuario puede leer y modificar eventos y 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 que no son privados. El usuario puede leer información sobre la disponibilidad de eventos privados. El usuario no puede modificar eventos privados.
pageToken string Es el token que especifica qué página de resultados se mostrará. Es opcional.
showDeleted boolean Indica si se deben incluir las entradas de la lista de calendarios borradas en el resultado. Es opcional. El valor predeterminado es False.
showHidden boolean Indica si se deben mostrar las entradas ocultas. Es opcional. El valor predeterminado es False.
showOwnOrganizationOnly boolean Indica si se deben mostrar solo las entradas de los calendarios de la organización. Este parámetro solo se aplica a los usuarios de Google Workspace. Es opcional. El valor predeterminado es False.
syncToken string Es el token que se obtiene 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. Si solo cambiaron los campos de solo lectura, como las propiedades del calendario o las ACL, no se mostrará 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 en False.
Para garantizar la coherencia del estado del cliente, los parámetros de consulta minAccessRole y showOwnOrganizationOnly no se pueden 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.
Es opcional. La opción predeterminada es mostrar todas las entradas.

Autorización

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

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 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 Calendarios que están presentes en la lista de calendarios del usuario.
nextSyncToken string 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.

Pruébalo

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