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 extrair os IDs de agenda, chame o método calendarList.list. Se você 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 eventos a serem retornados. Opcional. Esse parâmetro pode ser repetido várias vezes para retornar eventos de tipos diferentes. Se não for definido, todos os tipos de evento serão retornados.
Os valores aceitáveis são:
|
iCalUID |
string |
Especifica um ID de evento no formato iCalendar para ser fornecido na resposta. Opcional. Use este campo 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 que correspondam à 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 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:
|
pageToken |
string |
Token que especifica qual página de resultados será retornada. 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 correspondem a todas as restrições. |
q |
string |
Termos de pesquisa de texto livre para encontrar eventos que correspondem a esses termos nos seguintes campos:
Esses termos de pesquisa também correspondem a palavras-chave predefinidas em todas as traduções do título de exibição de local de trabalho, eventos de ausência e de foco. Por exemplo, a pesquisa por "Office" ou "Bureau" retorna eventos de local de trabalho do tipo |
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 correspondem a todas as restrições. |
showDeleted |
boolean |
Define se os eventos excluídos (com status igual a "cancelled ") vão ser incluídos no resultado. As instâncias canceladas de eventos recorrentes (mas não o evento recorrente principal) 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) serão retornadas. Opcional. O valor padrão é falso.
|
showHiddenInvitations |
boolean |
Se os convites ocultos serão incluídos no resultado. Opcional. O valor padrão é falso. |
singleEvents |
boolean |
Define se os eventos recorrentes serão expandidos em instâncias e se apenas eventos únicos e instâncias de eventos recorrentes serão retornados, mas não os eventos recorrentes. 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 as 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:
syncToken expirar, o servidor vai responder com um código de resposta 410 GONE, e o cliente vai precisar limpar o armazenamento e realizar 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 obrigatório do fuso horá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 deslocamento obrigatório do fuso horá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 serão sempre incluídas, independentemente de showDeleted . Opcional. O padrão é não filtrar por hora da última modificação.
|
Autorização
Esta 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 |
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 coletânea ("calendar#events "). |
|
etag |
etag |
ETag da coletânea. | |
summary |
string |
Título da agenda. Somente leitura. | |
description |
string |
Descrição do calendário. Somente leitura. | |
updated |
datetime |
Hora 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:
|
|
defaultReminders[] |
list |
Os lembretes padrão na agenda do usuário autenticado. Esses lembretes se aplicam a todos os eventos da agenda que não os substituem explicitamente (ou seja, que não têm reminders.useDefault definido como "True"). |
|
defaultReminders[].method |
string |
O método usado por esse lembrete. Os valores possíveis são:
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 precisa ser acionado. Os valores válidos estão entre 0 e 40320 (quatro semanas em minutos). Obrigatório ao adicionar um lembrete. |
gravável |
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 será fornecido. |
|
items[] |
list |
Lista de eventos na agenda. | |
nextSyncToken |
string |
Token usado em um momento posterior para recuperar apenas as entradas que mudaram desde que o resultado foi retornado. Omitido se outros resultados estiverem disponíveis, caso em que nextPageToken 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.