Events: instances

Retorna instâncias do evento recorrente especificado. Faça o teste agora.

Solicitação

Solicitação HTTP

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

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".
eventId string Identificador de evento recorrente.
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 participantes, mesmo que nenhum endereço de e-mail real esteja disponível (ou seja, um valor gerado e não funcional será fornecido).
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. Por padrão, o valor é de 250 eventos. O tamanho da página nunca pode ser maior que 2.500 eventos. Opcional.
originalStart string O horário de início original da instância no resultado. Opcional.
pageToken string Token que especifica qual página de resultados retornar. Opcional.
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 ainda serão incluídas se singleEvents for "False". Opcional. O valor padrão é falso.
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 compensação de fuso horário obrigatória.
timeMin datetime Limite inferior (inclusivo) 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 compensação de fuso horário obrigatória.
timeZone string Fuso horário usado na resposta. Opcional. O padrão é o fuso horário da agenda.

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.

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.