CalendarList: list

Retorna as agendas na lista de agendas do usuário. Faça o teste agora.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de consulta opcionais
maxResults integer Número máximo de entradas retornadas em uma página de resultados. Por padrão, o valor é de 100 entradas. O tamanho da página nunca pode ser maior que 250 entradas. Opcional.
minAccessRole string O papel de acesso mínimo para o usuário nas entradas retornadas. Opcional. O padrão não tem restrição.

Os valores aceitáveis são:
  • "freeBusyReader": o usuário pode ler informações de disponibilidade.
  • "owner": o usuário pode ler e modificar eventos e listas de controle de acesso.
  • "reader": o usuário pode ler eventos que não são particulares.
  • "writer": o usuário pode ler e modificar eventos.
  • "writerWithoutPrivateAccess": o usuário pode ler e modificar eventos que não são particulares. O usuário pode ler informações de disponibilidade sobre eventos particulares. O usuário não pode modificar eventos particulares.
pageToken string Token que especifica qual página de resultados retornar. Opcional.
showDeleted boolean Se as entradas excluídas da lista de agendas serão incluídas no resultado. Opcional. O valor padrão é falso.
showHidden boolean Se as entradas ocultas serão mostradas. Opcional. O valor padrão é falso.
showOwnOrganizationOnly boolean Se apenas as entradas de agendas da organização serão mostradas. Esse parâmetro só é aplicável a usuários do Google Workspace. Opcional. O valor padrão é falso.
syncToken string Token recebido do campo nextSyncToken retornado na última página de resultados da solicitação de lista anterior. Ele faz com que o resultado dessa solicitação de lista contenha apenas entradas que foram alteradas desde então. Se apenas campos somente leitura, como propriedades de agenda ou ACLs, foram alterados, a entrada não será retornada. Todas as entradas excluídas e ocultas desde a solicitação de lista anterior sempre estarão no conjunto de resultados, e não é permitido definir showDeleted nem showHidden como "falso".
Para garantir a consistência do estado do cliente, os parâmetros de consulta minAccessRole e showOwnOrganizationOnly não podem ser especificados juntos com nextSyncToken.
Se o syncToken expirar, o servidor vai responder com um código de resposta 410 GONE, e o cliente precisará limpar o armazenamento e realizar uma sincronização completa sem nenhum syncToken.
Saiba mais sobre a sincronização incremental.
Opcional. O padrão é retornar todas as entradas.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
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 mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "calendar#calendarList",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    calendarList Resource
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Tipo da coleção ("calendar#calendarList").
etag etag ETag da coleção.
nextPageToken string Token usado para acessar a próxima página desse resultado. Omitido se não houver mais resultados disponíveis. Nesse caso, nextSyncToken é fornecido.
items[] list Agendas presentes na lista de agendas do usuário.
nextSyncToken string Token usado posteriormente para recuperar apenas as entradas que foram alteradas desde que esse resultado foi retornado. Omitido se houver mais resultados disponíveis. Nesse caso, nextPageToken é fornecido.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.