Esta página foi traduzida pela API Cloud Translation.

Events: list

Retorna eventos na agenda especificada. Faça o teste agora.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro	Valor	Descrição
Parâmetros de caminho
`calendarId`	`string`	Identificador da agenda. Para recuperar os IDs da agenda, chame o método calendarList.list. Se quiser acessar a agenda principal do usuário conectado, use a palavra-chave "`primary`".
Parâmetros de consulta opcionais
`alwaysIncludeEmail`	`boolean`	Descontinuado e ignorado.
`eventTypes`	`string`	Tipos de evento a serem retornados. Opcional. Esse parâmetro pode ser repetido várias vezes para retornar eventos de diferentes tipos. Se não estiver definido, vai retornar todos os tipos de evento. Os valores aceitáveis são: "`birthday`": eventos especiais de dia inteiro com recorrência anual. "`default`": eventos regulares. "`focusTime`": eventos "Hora de se concentrar". "`fromGmail`": Eventos do Gmail. "`outOfOffice`": eventos fora do escritório. "`workingLocation`": eventos de local de trabalho.
`iCalUID`	`string`	Especifica um ID de evento no formato iCalendar a ser fornecido na resposta. Opcional. Use isso se quiser pesquisar um evento pelo ID do iCalendar.
`maxAttendees`	`integer`	O número máximo de participantes a serem incluídos na resposta. Se houver mais participantes do que o número especificado, apenas o participante será retornado. Opcional.
`maxResults`	`integer`	Número máximo de eventos retornados em uma página de resultados. O número de eventos na página resultante pode ser menor que esse valor ou nenhum, mesmo que haja mais eventos correspondentes à consulta. As páginas incompletas podem ser detectadas por um campo `nextPageToken` não vazio na resposta. Por padrão, o valor é de 250 eventos. O tamanho da página nunca pode ser maior que 2.500 eventos. Opcional.
`orderBy`	`string`	A ordem dos eventos retornados no resultado. Opcional. O padrão é uma ordem estável não especificada. Os valores aceitáveis são: "`startTime`": ordena pela data/hora de início (crescente). Isso só está disponível ao consultar eventos únicos (ou seja, o parâmetro `singleEvents` é "True"). "`updated`": ordena pelo horário da última modificação (crescente).
`pageToken`	`string`	Token que especifica qual página de resultados retornar. Opcional.
`privateExtendedProperty`	`string`	Restrição de propriedades estendidas especificada como propertyName=value. Corresponde apenas a propriedades particulares. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições especificadas.
`q`	`string`	Termos de pesquisa de texto livre para encontrar eventos que correspondam a esses termos nos seguintes campos: `summary` `description` `location` `displayName` do convidado `email` do convidado `displayName` do organizador `email` do organizador `workingLocationProperties.officeLocation.buildingId` `workingLocationProperties.officeLocation.deskId` `workingLocationProperties.officeLocation.label` `workingLocationProperties.customLocation.label` Esses termos de pesquisa também correspondem a palavras-chave predefinidas em todas as traduções de título de exibição de eventos de local de trabalho, fora do escritório e tempo de concentração. Por exemplo, pesquisar "Escritório" ou "Bureau" retorna eventos de local de trabalho do tipo `officeLocation`, enquanto pesquisar "Fora do escritório" ou "Abwesend" retorna eventos de ausência do trabalho. Opcional.
`sharedExtendedProperty`	`string`	Restrição de propriedades estendidas especificada como propertyName=value. Corresponde apenas a propriedades compartilhadas. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições especificadas.
`showDeleted`	`boolean`	Se os eventos excluídos (em que `status` é igual a "`cancelled`") devem ser incluídos no resultado. As instâncias canceladas de eventos recorrentes (mas não o evento recorrente em si) ainda serão incluídas se `showDeleted` e `singleEvents` forem "False". Se `showDeleted` e `singleEvents` forem "True", apenas instâncias únicas de eventos excluídos (mas não os eventos recorrentes subjacentes) serão retornadas. Opcional. O valor padrão é falso.
`showHiddenInvitations`	`boolean`	Se os convites ocultos devem ser incluídos no resultado. Opcional. O valor padrão é falso.
`singleEvents`	`boolean`	Se os eventos recorrentes devem ser expandidos em instâncias e retornar apenas eventos únicos e instâncias de eventos recorrentes, mas não os eventos recorrentes subjacentes. Opcional. O valor padrão é falso.
`syncToken`	`string`	Token obtido do campo `nextSyncToken` retornado na última página de resultados da solicitação de lista anterior. Isso faz com que o resultado dessa solicitação de lista contenha apenas entradas que mudaram desde então. Todos os eventos excluídos desde a solicitação de lista anterior sempre estarão no conjunto de resultados, e não é permitido definir `showDeleted` como "False". Há vários parâmetros de consulta que não podem ser especificados com `nextSyncToken` para garantir a consistência do estado do cliente. São elas: `iCalUID` `orderBy` `privateExtendedProperty` `q` `sharedExtendedProperty` `timeMin` `timeMax` `updatedMin` Todos os outros parâmetros de consulta precisam ser iguais aos da sincronização inicial para evitar comportamentos indefinidos. Se o `syncToken` expirar, o servidor vai responder com um código 410 GONE, e o cliente precisará limpar o armazenamento e fazer uma sincronização completa sem nenhum `syncToken`. Saiba mais sobre a sincronização incremental. Opcional. O padrão é retornar todas as entradas.
`timeMax`	`datetime`	Limite superior (exclusivo) para o horário de início de um evento a ser filtrado. Opcional. O padrão é não filtrar por horário de início. Precisa ser um carimbo de data/hora RFC3339 com um ajuste de fuso horário obrigatório, por exemplo, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Os milissegundos podem ser fornecidos, mas são ignorados. Se `timeMin` estiver definido, `timeMax` precisará ser maior que `timeMin`.
`timeMin`	`datetime`	Limite inferior (exclusivo) para o horário de término de um evento a ser filtrado. Opcional. O padrão é não filtrar por horário de término. Precisa ser um carimbo de data/hora RFC3339 com um ajuste de fuso horário obrigatório, por exemplo, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Os milissegundos podem ser fornecidos, mas são ignorados. Se `timeMax` estiver definido, `timeMin` precisará ser menor que `timeMax`.
`timeZone`	`string`	Fuso horário usado na resposta. Opcional. O padrão é o fuso horário da agenda.
`updatedMin`	`datetime`	Limite inferior para o horário da última modificação de um evento (como um carimbo de data/hora RFC3339) para filtrar. Quando especificado, as entradas excluídas desde esse horário sempre serão incluídas, independente de `showDeleted`. Opcional. O padrão é não filtrar por horário da última modificação.

Autorização

Esta solicitação permite 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.events.readonly`
`https://www.googleapis.com/auth/calendar.events`
`https://www.googleapis.com/auth/calendar.app.created`
`https://www.googleapis.com/auth/calendar.events.freebusy`
`https://www.googleapis.com/auth/calendar.events.owned`
`https://www.googleapis.com/auth/calendar.events.owned.readonly`
`https://www.googleapis.com/auth/calendar.events.public.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#events",
  "etag": etag,
  "summary": string,
  "description": string,
  "updated": datetime,
  "timeZone": string,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    events Resource
  ]
}

Nome da propriedade	Valor	Descrição	Observações
`kind`	`string`	Tipo da coleção ("`calendar#events`").
`etag`	`etag`	ETag da coleção.
`summary`	`string`	Título da agenda. Somente leitura.
`description`	`string`	Descrição da agenda. Somente leitura.
`updated`	`datetime`	Horário da última modificação do calendário (como um carimbo de data/hora RFC3339). Somente leitura.
`timeZone`	`string`	O fuso horário da agenda. Somente leitura.
`accessRole`	`string`	A função de acesso do usuário para essa agenda. Somente leitura. Os valores possíveis são: "`none`": o usuário não tem acesso. "`freeBusyReader`": o usuário tem acesso de leitura às informações de disponibilidade/ocupado. "`reader`": o usuário tem acesso de leitura à agenda. Os eventos particulares vão aparecer para usuários com acesso de leitura, mas os detalhes ficarão ocultos. "`writer`": o usuário tem acesso de leitura e gravação à agenda. Os eventos particulares vão aparecer para usuários com acesso de gravação, e os detalhes do evento vão ficar visíveis. "`owner`": o usuário tem acesso de administrador à agenda. Essa função tem todas as permissões da função de gravador, além da capacidade de ver e modificar os níveis de acesso de outros usuários. Importante: a função `owner` é diferente do proprietário dos dados da agenda. Um calendário tem um único proprietário de dados, mas pode ter vários usuários com a função `owner`.
`defaultReminders[]`	`list`	Os lembretes padrão na agenda do usuário autenticado. Esses lembretes se aplicam a todos os eventos dessa agenda que não os substituem explicitamente (ou seja, não têm `reminders.useDefault` definido como "True").
`defaultReminders[].method`	`string`	O método usado por este lembrete. Os valores possíveis são: "`email`": os lembretes são enviados por e-mail. "`popup`": os lembretes são enviados por um pop-up da interface. Obrigatório ao adicionar um lembrete.	gravável
`defaultReminders[].minutes`	`integer`	Número de minutos antes do início do evento em que o lembrete deve ser acionado. Os valores válidos estão entre 0 e 40320 (4 semanas em minutos). Obrigatório ao adicionar um lembrete.	gravável
`nextPageToken`	`string`	Token usado para acessar a próxima página deste resultado. Omitido se não houver mais resultados disponíveis, caso em que `nextSyncToken` é fornecido.
`items[]`	`list`	Lista de eventos na agenda.
`nextSyncToken`	`string`	Token usado posteriormente para recuperar apenas as entradas que mudaram desde que esse resultado foi retornado. Omitido se outros resultados estiverem disponíveis. Nesse caso, `nextPageToken` é fornecido.

Confira!

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