Esta página foi traduzida pela API Cloud Translation.

Events: list

Retorna eventos na 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. Se você quiser acessar a agenda principal do usuário conectado no momento, use a palavra-chave "`primary`".
Parâmetros de consulta opcionais
`alwaysIncludeEmail`	`boolean`	Descontinuado e ignorado. Um valor sempre será retornado no campo `email` para o organizador, o criador e os convidados, mesmo que nenhum endereço de e-mail real esteja disponível (ou seja, será gerado um valor gerado que não funciona).
`eventTypes`	`string`	Tipos de evento a serem retornados. Opcional. Os valores possíveis são: `"default"` `"focusTime"` `"outOfOffice"` Esse parâmetro pode ser repetido várias vezes para retornar eventos de tipos diferentes. Atualmente, este é o único valor permitido para este campo: `["default", "focusTime", "outOfOffice"]` Esse valor será o padrão. Se você tiver se inscrito no programa de prévia para desenvolvedores do Local de trabalho, além do valor padrão acima, também poderá definir o tipo de evento `"workingLocation"`: `["default", "focusTime", "outOfOffice", "workingLocation"]` `["workingLocation"]` Outras combinações desses quatro tipos de evento vão ser disponibilizadas em versões futuras. Prévia para desenvolvedores:disponível como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos.
`iCalUID`	`string`	Especifica um ID de evento no formato iCalendar a ser fornecido na resposta. Opcional. Use essa opção se você 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 ou igual a esse valor, 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 é 250 eventos. O tamanho da página nunca 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 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` é verdadeiro). "`updated`": ordena pelo horário da última modificação (ascendente).
`pageToken`	`string`	Token especificando a página de resultados a ser retornada. Opcional.
`privateExtendedProperty`	`string`	Restrição de propriedades estendidas especificada como propertyName=value. Corresponde somente a propriedades privadas. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições determinadas.
`q`	`string`	Termos de pesquisa de texto sem custo financeiro para encontrar eventos que correspondam a estes termos nos seguintes campos: `summary`, `description`, `location`, `displayName` do convidado, `email` do participante. Opcional.
`sharedExtendedProperty`	`string`	Restrição de propriedades estendidas especificada como propertyName=value. Inclui somente propriedades compartilhadas. Esse parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições determinadas.
`showDeleted`	`boolean`	Incluir ou não 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 falsos. 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 serão incluídos no resultado. Opcional. O valor padrão é falso.
`singleEvents`	`boolean`	Define se é necessário expandir eventos recorrentes 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 recebido do campo `nextSyncToken` retornado na última página de resultados da solicitação de lista anterior. O resultado dessa solicitação de lista contém apenas entradas que mudaram desde então. Todos os eventos excluídos desde a solicitação de lista anterior sempre vão estar no conjunto de resultados e não podem definir `showDeleted` como falso. 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` Se o `syncToken` expirar, o servidor vai responder com um código de resposta 410 GONE e o cliente vai precisar limpar o armazenamento e fazer uma sincronização completa sem `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 deslocamento de fuso horário obrigatório, por exemplo, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milissegundos são fornecidos, mas são ignorados. Se `timeMin` for definido, `timeMax` vai precisar ser maior que `timeMin`.
`timeMin`	`datetime`	Limite inferior (exclusivo) para o horário de término de um evento para filtragem. 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. Milissegundos são fornecidos, mas são ignorados. Se `timeMax` for definido, `timeMin` vai 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 então serão sempre incluídas, independentemente do `showDeleted`. Opcional. O padrão é não filtrar pela hora da última modificação.

Autorização

Essa solicitação permite a 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`	Horário 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`	Função de acesso do usuário para esta 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 a informações de disponibilidade. "`reader`": o usuário tem acesso de leitura à agenda. Os eventos particulares aparecem para os usuários com acesso de leitor, mas os detalhes dos eventos ficam ocultos. "`writer`": o usuário tem acesso de leitura e gravação à agenda. Os eventos privados serão exibidos para os usuários com acesso de gravação, e os detalhes dos eventos ficarão visíveis. "`owner`": o usuário tem a propriedade da agenda. Esse papel tem todas as permissões do papel de gravador com a capacidade adicional de ver e manipular ACLs.
`defaultReminders[]`	`list`	Os lembretes padrão na agenda para o usuário autenticado. Esses lembretes são aplicados a todos os eventos da agenda que não substituem explicitamente esses itens (ou seja, não têm `reminders.useDefault` definido como "Verdadeiro").
`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 meio de um pop-up da IU. 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 será acionado. Os valores válidos estão entre 0 e 40.320 (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. Nesse caso, `nextSyncToken` será fornecido.
`items[]`	`list`	Lista de eventos na agenda.
`nextSyncToken`	`string`	Token usado posteriormente para recuperar apenas as entradas que mudaram desde que o resultado foi retornado. Omitido se mais resultados estiverem disponíveis. Nesse caso, `nextPageToken` vai ser 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.