Atualiza um evento. Esse método não é compatível com a semântica de patch e sempre atualiza todo o recurso do evento. Para fazer uma atualização parcial, execute um get
seguido por um update
usando Etags para garantir a atomicidade.
Faça um teste agora ou veja um exemplo.
Solicitação
Solicitação HTTP
PUT https://www.googleapis.com/calendar/v3/calendars/calendarId/events/eventId
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, use a palavra-chave "primary ".
|
eventId |
string |
Identificador do evento. |
Parâmetros de consulta opcionais | ||
alwaysIncludeEmail |
boolean |
Obsoleto 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, será fornecido um valor gerado que não funciona).
|
conferenceDataVersion |
integer |
Número da versão de dados de videoconferência aceitos pelo cliente da API. A versão 0 pressupõe que não há suporte a dados de conferência e ignora os dados de conferência no corpo do evento. A versão 1 permite a cópia de ConferenceData, bem como a criação de novas conferências usando o campo createRequest de organizationData. O padrão é 0.
Os valores aceitáveis são de 0 a 1 , inclusive.
|
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. |
sendNotifications |
boolean |
Obsoleto. Use sendUpdates. Se você quer enviar notificações sobre a atualização do evento (por exemplo, mudanças na descrição etc.). Alguns e-mails ainda poderão ser enviados mesmo que você defina o valor como false . O padrão é false .
|
sendUpdates |
string |
Convidados que devem receber notificações sobre a atualização do evento (por exemplo, alterações de título etc.).
Os valores aceitáveis são:
|
supportsAttachments |
boolean |
Se o cliente da API que está executando a operação oferece suporte a 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 |
Para mais informações, consulte a página de autenticação e autorização.
Corpo da solicitação
No corpo da solicitação, informe um recurso Eventos 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, é o horário de término da primeira instância. | |
start |
nested object |
É o horário de início (inclusive) do evento. Para um evento recorrente, é o horário de início da primeira instância. | |
Propriedades opcionais | |||
anyoneCanAddSelf |
boolean |
Se qualquer pessoa pode convidar a si mesma 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 arquivo do Google Drive, use o mesmo formato da propriedade Obrigatório ao adicionar um anexo. |
gravável |
attendees[] |
list |
Os convidados do evento. Consulte o guia Eventos com convidados para mais informações sobre como agendar 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 da resposta do convidado. 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 convidado, se disponível. Este campo precisa estar presente ao adicionar um convidado. Ele precisa ser um endereço de e-mail válido de acordo com a RFC5322 (link em inglês). Obrigatório ao adicionar um convidado. |
gravável |
attendees[].optional |
boolean |
Indica se este é um 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. As modificações subsequentes serão ignoradas. Opcional. O valor padrão é falso. | gravável |
attendees[].responseStatus |
string |
O status de resposta do convidado. Os valores possíveis são:
|
gravável |
attendeesOmitted |
boolean |
Se os participantes podem ter sido omitidos da representação do evento. Ao recuperar um evento, isso pode ocorrer devido a uma restrição especificada pelo parâmetro de consulta maxAttendee . Ao atualizar um evento, essa opção só pode ser usada para atualizar a resposta do participante. Opcional. O valor padrão é falso. |
gravável |
colorId |
string |
A cor do evento. Esse é 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 os detalhes de uma videoconferência do Google Meet. Para criar novos detalhes da videoconferência, use o campo createRequest . Para manter suas mudanças, defina o parâmetro de solicitação conferenceDataVersion como 1 para todas as solicitações de modificação de eventos. |
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 |
A hora, como um valor combinado de data-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário seja especificado explicitamente em timeZone . |
gravável |
end.timeZone |
string |
O fuso horário em que o horário é especificado. Formatado como um nome do banco de dados de fuso horário IANA, por exemplo, "Europa/Zurique". Para eventos recorrentes, este campo é obrigatório e especifica o fuso horário para expansão da recorrência. Para eventos únicos, esse campo é opcional e indica um fuso horário personalizado para o início/fim do evento. | 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 "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:
|
gravável |
gadget.height |
integer |
A altura do gadget em pixels. A altura precisa ser um número inteiro maior que zero. Opcional. Obsoleto. | gravável |
gadget.iconLink |
string |
O URL do ícone do gadget. O esquema de URL precisa ser HTTPS. Obsoleto. | gravável |
gadget.link |
string |
O URL do gadget. O esquema de URL precisa ser HTTPS. 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 zero. Opcional. Obsoleto. | gravável |
guestsCanInviteOthers |
boolean |
Se outros participantes além do organizador podem convidar outras pessoas para o evento. Opcional. O padrão é "True". | gravável |
guestsCanModify |
boolean |
Se outros participantes além do organizador podem modificar o evento. Opcional. O valor padrão é falso. | gravável |
guestsCanSeeOtherGuests |
boolean |
Se participantes que não sejam o organizador podem ver quem são os participantes do evento. Opcional. O padrão é "True". | gravável |
location |
string |
Localização geográfica do evento como texto em formato 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 |
A hora, como um valor combinado de data-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário seja especificado explicitamente em timeZone . |
gravável |
originalStartTime.timeZone |
string |
O fuso horário em que o horário é especificado. Formatado como um nome do banco de dados de fuso horário IANA, por exemplo, "Europa/Zurique". Para eventos recorrentes, este campo é obrigatório e especifica o fuso horário para expansão da recorrência. 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 em RFC5545. As linhas DTSTART e DTEND não são permitidas nesse 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 lista os lembretes específicos do evento ou, se não definido, indica que não há lembretes definidos para o evento. O número máximo de lembretes de substituição é 5. | gravável |
reminders.overrides[].method |
string |
O método usado por esse lembrete. Os valores possíveis são:
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 de acordo com o iCalendar. | gravável |
source.title |
string |
O 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 fonte 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 |
A hora, como um valor combinado de data-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário seja especificado explicitamente em timeZone . |
gravável |
start.timeZone |
string |
O fuso horário em que o horário é especificado. Formatado como um nome do banco de dados de fuso horário IANA, por exemplo, "Europa/Zurique". Para eventos recorrentes, este campo é obrigatório e especifica o fuso horário para expansão da recorrência. 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:
|
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:
|
gravável |
visibility |
string |
Visibilidade do evento. Opcional. Os valores possíveis são:
|
gravável |
workingLocationProperties |
nested object |
Dados de eventos do 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 mais informações. | 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 opcional do edifício. Deve 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 espaço de trabalho opcional. | gravável |
workingLocationProperties.officeLocation.floorId |
string |
Um identificador de andar opcional. | gravável |
workingLocationProperties.officeLocation.floorSectionId |
string |
Um identificador opcional da seção do andar. | gravável |
workingLocationProperties.officeLocation.label |
string |
O nome do escritório que é exibido nos clientes do Google Agenda na Web e em dispositivos móveis. Recomendamos que você faça referência ao nome de um edifício no banco de dados de Recursos da organização. | gravável |
workingLocationProperties.type |
string |
Tipo de local de trabalho. Os valores possíveis são:
Obrigatório ao adicionar propriedades do local de trabalho. |
gravável |
Resposta
Se for bem-sucedido, esse método retornará um recurso Events no corpo da resposta.
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; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Retrieve the event from the API Event event = service.events().get("primary", "eventId").execute(); // Make a change event.setSummary("Appointment at Somewhere"); // Update the event Event updatedEvent = service.events().update("primary", event.getId(), event).execute(); System.out.println(updatedEvent.getUpdated());
Python
Usa a biblioteca cliente de Python.
# First retrieve the event from the API. event = service.events().get(calendarId='primary', eventId='eventId').execute() event['summary'] = 'Appointment at Somewhere' updated_event = service.events().update(calendarId='primary', eventId=event['id'], body=event).execute() # Print the updated date. print updated_event['updated']
PHP
Usa a biblioteca cliente de PHP.
// First retrieve the event from the API. $event = $service->events->get('primary', 'eventId'); $event->setSummary('Appointment at Somewhere'); $updatedEvent = $service->events->update('primary', $event->getId(), $event); // Print the updated date. echo $updatedEvent->getUpdated();
Ruby
Usa a biblioteca de cliente Ruby.
event = client.get_event('primary', 'eventId') event.summary = 'Appointment at Somewhere' result = client.update_event('primary', event.id, event) print result.updated
Confira!
Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.