Events: list

Retorna eventos da agenda especificada. Faça um teste agora ou veja um exemplo.

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 IDs de agendas, chame o método calendarList.list. Para acessar a agenda principal do usuário conectado, use "primary" palavra-chave.
Parâmetros de consulta opcionais
alwaysIncludeEmail boolean Obsoleto e ignorado.
eventTypes string Tipos de eventos a serem retornados. Opcional. Esse parâmetro pode ser repetido várias vezes para retornar eventos de diferentes tipos. Se não definido, retorna todos os tipos de evento.

Os valores aceitáveis são:
  • "default": eventos regulares.
  • "focusTime": eventos "Horário de concentração".
  • "fromGmail": eventos do Gmail.
  • "outOfOffice": eventos fora do escritório.
  • "workingLocation": eventos do local de trabalho.
iCalUID string Especifica um ID de evento no formato iCalendar a ser fornecido na resposta. Opcional. Use esse método 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 do que o número especificado de participantes, somente 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 ou igual a esse valor, mesmo que haja mais eventos correspondentes à consulta. 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 não pode ser maior do que 2.500 eventos. Opcional.
orderBy string A ordem dos eventos retornados no resultado. Opcional. O padrão é uma ordem estável e não especificada.

Os valores aceitáveis são:
  • "startTime": ordena pela data/hora de início (crescente). Só está disponível ao consultar eventos únicos (ou seja, o parâmetro singleEvents é "True")
  • "updated": ordem pelo horário da última modificação (crescente).
pageToken string Token que especifica qual página de resultados deve ser retornada. Opcional.
privateExtendedProperty string Restrição de propriedades estendidas especificada como propriedadeName=value. Corresponde apenas a propriedades particulares. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondem a todas as restrições fornecidas.
q string Termos de pesquisa de texto livre para localizar 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 palavras-chave predefinidas a todas as traduções de títulos de exibição referentes a eventos de local de trabalho, "fora do escritório" e "hora de se concentrar". Por exemplo, pesquisar "Escritório" ou "Bureau" retorna eventos de local de trabalho do tipo officeLocation, enquanto a pesquisa "Fora do escritório" ou "Abwesend" retorna eventos de ausência temporária. Opcional.
sharedExtendedProperty string Restrição de propriedades estendidas especificada como propriedadeName=value. Corresponde apenas a propriedades compartilhadas. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondem a todas as restrições fornecidas.
showDeleted boolean Define se eventos excluídos (com status é igual a "cancelled") no resultado. As instâncias canceladas de eventos recorrentes (mas não o evento recorrente subjacente) ainda serão incluídas se showDeleted e singleEvents forem "False". Se showDeleted e singleEvents forem verdadeiros, 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 Indica se convites ocultos devem ser incluídos no resultado. Opcional. O valor padrão é falso.
singleEvents boolean Define se eventos recorrentes serão expandidos em instâncias e retornar apenas eventos pontuais e instâncias de eventos recorrentes, mas não os eventos recorrentes subjacentes em si. 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. Isso faz com que o resultado dessa solicitação de lista contenha apenas entradas que foram alteradas 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 eles:
  • iCalUID
  • orderBy
  • privateExtendedProperty
  • q
  • sharedExtendedProperty
  • timeMin
  • timeMax
  • updatedMin
Todos os outros parâmetros de consulta precisam ser os mesmos da sincronização inicial para evitar um comportamento indefinido. Se a syncToken expirar, o servidor vai responder com um código de resposta 410 GONE, e o cliente vai 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 que será filtrado. Opcional. O padrão não é filtrar por horário de início. Precisa ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório, por exemplo, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. É possível informar os milissegundos, mas eles 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 que será filtrado. Opcional. O padrão não é filtrar por horário de término. Precisa ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório, por exemplo, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. É possível informar os milissegundos, mas eles são ignorados. Se timeMax for 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 do horário da última modificação de um evento (como um carimbo de data/hora RFC3339) que será usado como filtro. Quando especificado, as entradas excluídas a partir desse momento serão sempre incluídas, independente de showDeleted. Opcional. O padrão não é filtrar pela hora da última modificação.

Autorização

Essa 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

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 Hora da última modificação da agenda (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 à 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 disponível/ocupado.
  • "reader" - O usuário tem acesso de leitura à agenda. Os eventos particulares vão aparecer para os usuários com acesso de leitura, mas os detalhes deles vão ficar ocultos.
  • "writer" - O usuário tem acesso de leitura e gravação à agenda. Os eventos particulares serão exibidos para os usuários com acesso de gravador, e os detalhes dos eventos ficarão visíveis.
  • "owner" - O usuário é proprietário da agenda. Esse papel tem todas as permissões da função de gravador, com a capacidade adicional de ver e manipular ACLs.
defaultReminders[] list Os lembretes padrão na agenda para o usuário autenticado. Estes lembretes se aplicam a todos os eventos desta agenda que não os modificam explicitamente, ou seja, sem a definição de reminders.useDefault como "True".
defaultReminders[].method string O método usado pelo lembrete. Os valores possíveis são:
  • "email" - Os lembretes são enviados por e-mail.
  • "popup" - Os lembretes são enviados por uma janela pop-up na interface.

Obrigatório ao adicionar um lembrete.

 gravável
defaultReminders[].minutes integer Número de minutos antes do início do evento quando 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 nenhum outro resultado estiver disponível. Nesse caso, nextSyncToken é fornecido.
items[] list Lista de eventos na agenda.
nextSyncToken string Token usado posteriormente para recuperar apenas as entradas que foram alteradas desde que esse resultado foi retornado. Omitido se outros resultados estiverem disponíveis. Nesse caso, nextPageToken é fornecido.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

Usa a biblioteca cliente de Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.Events;

// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Iterate over the events in the specified calendar
String pageToken = null;
do {
  Events events = service.events().list('primary').setPageToken(pageToken).execute();
  List<Event> items = events.getItems();
  for (Event event : items) {
    System.out.println(event.getSummary());
  }
  pageToken = events.getNextPageToken();
} while (pageToken != null);

Python

Usa a biblioteca cliente de Python.

page_token = None
while True:
  events = service.events().list(calendarId='primary', pageToken=page_token).execute()
  for event in events['items']:
    print event['summary']
  page_token = events.get('nextPageToken')
  if not page_token:
    break

PHP

Usa a biblioteca cliente de PHP.

$events = $service->events->listEvents('primary');

while(true) {
  foreach ($events->getItems() as $event) {
    echo $event->getSummary();
  }
  $pageToken = $events->getNextPageToken();
  if ($pageToken) {
    $optParams = array('pageToken' => $pageToken);
    $events = $service->events->listEvents('primary', $optParams);
  } else {
    break;
  }
}

Ruby

Usa a biblioteca de cliente Ruby.

page_token = nil
begin
  result = client.list_events('primary', page_token: page_token)
  result.items.each do |e|
    print e.summary + "\n"
  end
  if result.next_page_token != page_token
    page_token = result.next_page_token
  else
    page_token = nil
  end
end while !page_token.nil?

Confira!

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