Events: insert

Cria um evento. Faça o teste agora.

Solicitação

Solicitação HTTP

POST 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 você quiser acessar a agenda principal do usuário conectado no momento, use a palavra-chave "primary".
Parâmetros de consulta opcionais
conferenceDataVersion integer Número da versão dos dados de conferência compatíveis com o cliente da API. A versão 0 não pressupõe suporte a dados de conferência e ignora esses dados no corpo do evento. A versão 1 permite copiar ConferenceData e criar novas conferências usando o campo createRequest de conferenceData. O padrão é 0. Os valores aceitos vão de 0 a 1, inclusive.
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.
sendNotifications boolean Obsoleto. Use sendUpdates.

Indica se as notificações sobre a criação do novo evento serão enviadas. Alguns e-mails ainda podem ser enviados mesmo que você defina o valor como false. O padrão é false.
sendUpdates string Se as notificações sobre a criação do novo evento serão enviadas. Alguns e-mails ainda podem ser enviados. O padrão é false.

Os valores aceitáveis são:
  • "all": as notificações são enviadas a todos os convidados.
  • "externalOnly": as notificações são enviadas apenas para convidados que não usam o Google Agenda.
  • "none": nenhuma notificação é enviada.
supportsAttachments boolean Se o cliente da API que realiza a operação é compatível com anexos de eventos. Opcional. O valor padrão é falso.

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos:

Escopo
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça um recurso Events com as seguintes propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades obrigatórias
end nested object O horário de término (exclusivo) do evento. Para um evento recorrente, esse é o horário de término da primeira instância.
start nested object O horário de início do evento (inclusivo). Para um evento recorrente, esse é o horário de início da primeira instância.
Propriedades opcionais
anyoneCanAddSelf boolean Se qualquer pessoa pode se convidar para o evento (descontinuado). Opcional. O valor padrão é falso. gravável
attachments[].fileUrl string Link do URL para o anexo.

Para adicionar anexos de arquivos do Google Drive, use o mesmo formato da propriedade alternateLink do recurso Files na API Drive.

Obrigatório ao adicionar um anexo.

 gravável
attendees[] list Os participantes do evento. Consulte o guia Eventos com convidados para mais informações sobre como programar eventos com outros usuários da Agenda. As contas de serviço precisam usar a delegação de autoridade em todo o domínio para preencher a lista de participantes. gravável
attendees[].additionalGuests integer Número de hóspedes extras. Opcional. O padrão é 0. gravável
attendees[].comment string O comentário de resposta do participante. Opcional. gravável
attendees[].displayName string O nome do participante, se disponível. Opcional. gravável
attendees[].email string O endereço de e-mail do participante, se disponível. Esse campo precisa estar presente ao adicionar um participante. Ele precisa ser um endereço de e-mail válido, de acordo com a RFC5322.

Obrigatório ao adicionar um participante.

 gravável
attendees[].optional boolean Indica se o participante é opcional. Opcional. O valor padrão é falso. gravável
attendees[].resource boolean Se o participante é um recurso. Só pode ser definido quando o participante é adicionado ao evento pela primeira vez. Modificações subsequentes são ignoradas. Opcional. O valor padrão é falso. gravável
attendees[].responseStatus string O status da resposta do participante. Os valores possíveis são:
  • "needsAction": o participante não respondeu ao convite (recomendado para novos eventos).
  • "declined": o participante recusou o convite.
  • "tentative": o participante aceitou o convite provisoriamente.
  • "accepted": o participante aceitou o convite.
 gravável
birthdayProperties nested object Dados de aniversário ou evento especial. Usado se eventType for "birthday". Imutável. gravável
birthdayProperties.type string Tipo de aniversário ou evento especial. Os valores possíveis são:
  • "anniversary": um aniversário que não seja de nascimento. Sempre tem um contact.
  • "birthday": um evento de aniversário. Esse é o valor padrão.
  • "custom": uma data especial cujo rótulo é especificado ainda mais no campo customTypeName. Sempre tem um contact.
  • "other": uma data especial que não se enquadra nas outras categorias e não tem um rótulo personalizado. Sempre tem um contact.
  • "self": aniversário do proprietário da agenda. Não pode ter um contact.
A API Calendar só permite criar eventos do tipo "birthday". Não é possível mudar o tipo depois da criação do evento.		 gravável
colorId string A cor do evento. É um ID que se refere a uma entrada na seção event da definição de cores. Consulte o endpoint de cores. Opcional. gravável
conferenceData nested object As informações relacionadas à videoconferência, como detalhes de uma videoconferência do Google Meet. Para criar novos detalhes da conferência, use o campo createRequest. Para manter as mudanças, defina o parâmetro de solicitação conferenceDataVersion como 1 em todas as solicitações de modificação de evento. gravável
description string É a descrição do evento. Pode conter HTML. Opcional. gravável
end.date date A data, no formato "aaaa-mm-dd", se for um evento de dia inteiro. gravável
end.dateTime datetime O horário, como um valor combinado de data e hora (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja especificado explicitamente em timeZone. gravável
end.timeZone string O fuso horário em que a hora é especificada. (Formatado como um nome do banco de dados de fusos horários da IANA, por exemplo, "Europe/Zurich".) Para eventos recorrentes, esse campo é obrigatório e especifica o fuso horário em que a recorrência é expandida. Para eventos únicos, esse campo é opcional e indica um fuso horário personalizado para o início/fim do evento. gravável
eventType string Tipo específico do evento. Isso não pode ser modificado depois da criação do evento. Os valores possíveis são:
  • "birthday": um evento especial de dia inteiro com recorrência anual.
  • "default": um evento regular ou não especificado.
  • "focusTime": um evento de hora de se concentrar.
  • "fromGmail": um evento do Gmail. Não é possível criar esse tipo de evento.
  • "outOfOffice": um evento fora do escritório.
  • "workingLocation": um evento de local de trabalho.
 gravável
extendedProperties.private object Propriedades particulares da cópia do evento que aparece nesta agenda. gravável
extendedProperties.shared object Propriedades compartilhadas entre cópias do evento nas agendas de outros participantes. gravável
focusTimeProperties nested object Dados de eventos do Horário de concentração. Usado se eventType for focusTime. gravável
gadget.display string O modo de exibição do gadget. Obsoleto. Os valores possíveis são:
  • "icon": o gadget aparece ao lado do título do evento na visualização da agenda.
  • "chip": o gadget é exibido quando o evento é clicado.
 gravável
gadget.height integer A altura do gadget em pixels. A altura precisa ser um número inteiro maior que 0. Opcional. Obsoleto. gravável
gadget.preferences object Preferências. gravável
gadget.title string O título do gadget. Obsoleto. gravável
gadget.type string O tipo de gadget. Obsoleto. gravável
gadget.width integer A largura do gadget em pixels. A largura precisa ser um número inteiro maior que 0. Opcional. Obsoleto. gravável
guestsCanInviteOthers boolean Se os participantes, além do organizador, podem convidar outras pessoas para o evento. Opcional. O padrão é "True". gravável
guestsCanModify boolean Se os participantes, além do organizador, podem modificar o evento. Opcional. O valor padrão é falso. gravável
guestsCanSeeOtherGuests boolean Se os convidados, além do organizador, podem ver quem são os participantes do evento. Opcional. O padrão é "True". gravável
id string Identificador opaco do evento. Ao criar eventos únicos ou recorrentes, você pode especificar os IDs deles. Os IDs fornecidos precisam seguir estas regras:
  • Os caracteres permitidos no ID são aqueles usados na codificação base32hex, ou seja, letras minúsculas de a a v e dígitos de 0 a 9.Consulte a seção 3. 1.2 em RFC2938.
  • O ID precisa ter entre 5 e 1.024 caracteres.
  • o ID precisa ser exclusivo por calendário
Devido à natureza distribuída globalmente do sistema, não podemos garantir que colisões de ID serão detectadas no momento da criação do evento. Para minimizar o risco de colisões, recomendamos usar um algoritmo UUID estabelecido, como o descrito na RFC4122.

Se você não especificar um ID, ele será gerado automaticamente pelo servidor.

O icalUID e o id não são idênticos, e apenas um deles deve ser fornecido no momento da criação do evento. Uma diferença na semântica é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, mas compartilham os mesmos icalUIDs.

 gravável
location string Localização geográfica do evento como texto livre. Opcional. gravável
originalStartTime.date date A data, no formato "aaaa-mm-dd", se for um evento de dia inteiro. gravável
originalStartTime.dateTime datetime O horário, como um valor combinado de data e hora (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja especificado explicitamente em timeZone. gravável
originalStartTime.timeZone string O fuso horário em que a hora é especificada. (Formatado como um nome do banco de dados de fusos horários da IANA, por exemplo, "Europe/Zurich".) Para eventos recorrentes, esse campo é obrigatório e especifica o fuso horário em que a recorrência é expandida. Para eventos únicos, esse campo é opcional e indica um fuso horário personalizado para o início/fim do evento. gravável
outOfOfficeProperties nested object Dados de eventos fora do escritório. Usado se eventType for outOfOffice. gravável
recurrence[] list Lista de linhas RRULE, EXRULE, RDATE e EXDATE para um evento recorrente, conforme especificado na RFC5545. As linhas DTSTART e DTEND não são permitidas neste campo. Os horários de início e término do evento são especificados nos campos start e end. Esse campo é omitido para eventos únicos ou instâncias de eventos recorrentes. gravável
reminders.overrides[] list Se o evento não usar os lembretes padrão, isso vai listar os lembretes específicos do evento ou, se não estiver definido, indicar que não há lembretes definidos para esse evento. O número máximo de lembretes de substituição é 5. gravável
reminders.overrides[].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
reminders.overrides[].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
reminders.useDefault boolean Se os lembretes padrão da agenda se aplicam ao evento. gravável
sequence integer Número de sequência conforme o iCalendar. gravável
source.title string Título da fonte, por exemplo, o título de uma página da Web ou o assunto de um e-mail. gravável
source.url string URL da origem que aponta para um recurso. O esquema de URL precisa ser HTTP ou HTTPS. gravável
start.date date A data, no formato "aaaa-mm-dd", se for um evento de dia inteiro. gravável
start.dateTime datetime O horário, como um valor combinado de data e hora (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja especificado explicitamente em timeZone. gravável
start.timeZone string O fuso horário em que a hora é especificada. (Formatado como um nome do banco de dados de fusos horários da IANA, por exemplo, "Europe/Zurich".) Para eventos recorrentes, esse campo é obrigatório e especifica o fuso horário em que a recorrência é expandida. Para eventos únicos, esse campo é opcional e indica um fuso horário personalizado para o início/fim do evento. gravável
status string Status do evento. Opcional. Os valores possíveis são:
  • "confirmed": o evento está confirmado. Esse é o status padrão.
  • "tentative": o evento está provisoriamente confirmado.
  • "cancelled": o evento foi cancelado (excluído). O método list retorna eventos cancelados apenas na sincronização incremental (quando syncToken ou updatedMin são especificados) ou se a flag showDeleted estiver definida como true. O método get sempre os retorna.

    Um status cancelado representa dois estados diferentes, dependendo do tipo de evento:

    1. Exceções canceladas de um evento recorrente não cancelado indicam que essa instância não deve mais ser apresentada ao usuário. Os clientes precisam armazenar esses eventos durante a vida útil do evento recorrente principal.

      As exceções canceladas só têm valores garantidos para os campos id, recurringEventId e originalStartTime. Os outros campos podem estar vazios.

    2. Todos os outros eventos cancelados representam eventos excluídos. Os clientes precisam remover as cópias sincronizadas localmente. Esses eventos cancelados vão desaparecer com o tempo. Portanto, não confie que eles vão ficar disponíveis indefinidamente.

      Os eventos excluídos só têm garantia de que o campo id será preenchido.

    Na agenda do organizador, os eventos cancelados continuam mostrando os detalhes (resumo, local etc.) para que possam ser restaurados (recuperados). Da mesma forma, os eventos para os quais o usuário foi convidado e que ele removeu manualmente continuam fornecendo detalhes. No entanto, as solicitações de sincronização incremental com showDeleted definido como "false" não vão retornar esses detalhes.

    Se um evento mudar de organizador (por exemplo, pela operação move) e o organizador original não estiver na lista de participantes, um evento cancelado será deixado para trás, em que apenas o campo id terá preenchimento garantido.

gravável
summary string Título do evento. gravável
transparency string Se o evento bloqueia o tempo na agenda. Opcional. Os valores possíveis são:
  • "opaque": valor padrão. O evento bloqueia o tempo na agenda. Isso equivale a definir Mostrar como como Ocupado na interface do Google Agenda.
  • "transparent": o evento não bloqueia o tempo na agenda. Isso equivale a definir Mostrar como como Disponível na interface do Google Agenda.
 gravável
visibility string Visibilidade do evento. Opcional. Os valores possíveis são:
  • "default": usa a visibilidade padrão para eventos na agenda. Esse é o valor padrão.
  • "public": o evento é público e os detalhes ficam visíveis para todos os leitores da agenda.
  • "private": o evento é particular, e apenas os participantes podem ver os detalhes dele.
  • "confidential": o evento é particular. Esse valor é fornecido por motivos de compatibilidade.
 gravável
workingLocationProperties nested object Dados de eventos de local de trabalho. gravável
workingLocationProperties.customLocation object Se presente, especifica que o usuário está trabalhando em um local personalizado. gravável
workingLocationProperties.customLocation.label string Um rótulo extra opcional para informações adicionais. gravável
workingLocationProperties.homeOffice any value Se presente, especifica que o usuário está trabalhando em casa. gravável
workingLocationProperties.officeLocation object Se presente, especifica que o usuário está trabalhando em um escritório. gravável
workingLocationProperties.officeLocation.buildingId string Um identificador de prédio opcional. Ele precisa fazer referência a um ID de edifício no banco de dados de recursos da organização. gravável
workingLocationProperties.officeLocation.deskId string Um identificador de mesa opcional. gravável
workingLocationProperties.officeLocation.floorId string Um identificador de andar opcional. gravável
workingLocationProperties.officeLocation.floorSectionId string Um identificador opcional de seção do piso. gravável
workingLocationProperties.officeLocation.label string O nome do escritório exibido nos clientes da Web e para dispositivos móveis do Google Agenda. Recomendamos que você faça referência a um nome de prédio no banco de dados de recursos da organização. gravável
workingLocationProperties.type string Tipo do local de trabalho. Os valores possíveis são:
  • "homeOffice": o usuário está trabalhando em casa.
  • "officeLocation": o usuário está trabalhando em um escritório.
  • "customLocation": o usuário está trabalhando em um local personalizado.
Todos os detalhes são especificados em um subcampo do nome especificado, mas esse campo pode estar ausente se estiver vazio. Todos os outros campos são ignorados.

Obrigatório ao adicionar propriedades de local de trabalho.

 gravável

Resposta

Se for bem-sucedido, esse método retornará um recurso Events no corpo da resposta.

Confira!

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