Cria um evento. Faça um teste agora ou veja um exemplo.
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 IDs de agendas, chame o método calendarList.list. Para acessar a agenda principal do usuário conectado, use "primary " palavra-chave.
|
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 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 o suporte para cópia de ConferenceData, bem como para a criação de novas conferências usando o campo createRequest de educationData. 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 do que o número especificado de participantes, somente o participante será retornado. Opcional. |
sendNotifications |
boolean |
Obsoleto. Em vez disso, use sendUpdates. Se as notificações sobre a criação do novo evento serão enviadas. Alguns e-mails ainda poderão ser enviados mesmo se você definir 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 os seguintes:
|
supportsAttachments |
boolean |
Se a operação do cliente da API é 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 |
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 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 (inclusivo) do evento. Para um evento recorrente, esse é 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 participantes 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 adicionais. Opcional. O padrão é 0. | gravável |
attendees[].comment |
string |
O comentário de 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 participante, se disponível. Este campo precisa estar presente ao adicionar um participante. 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 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. Modificações subsequentes sã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 |
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 a videoconferências, como detalhes de uma videoconferência do Google Meet. Para criar detalhes de videoconferências, use o campo createRequest . Para manter as mudanças, lembre-se de definir 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 e hora (formatado de acordo com RFC3339). É necessário um ajuste de fuso horário, a menos que ele seja explicitamente especificado 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, 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:
|
gravável |
extendedProperties.private |
object |
Propriedades particulares da cópia do evento que aparece na agenda. | gravável |
extendedProperties.shared |
object |
Propriedades que são compartilhadas entre as cópias do evento nos outros participantes. agendas. | gravável |
focusTimeProperties |
nested object |
Dados do evento "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 do URL precisa ser HTTPS. Obsoleto. | gravável |
gadget.link |
string |
O URL do gadget. O esquema do 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 do 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 outros participantes, 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 novos eventos únicos ou recorrentes, você pode especificar os IDs deles. Os IDs fornecidos devem seguir estas regras:
Se você não especificar um ID, ele será gerado automaticamente pelo servidor.
|
gravável |
location |
string |
A 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 e hora (formatado de acordo com RFC3339). É necessário um ajuste de fuso horário, a menos que ele seja explicitamente especificado 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, 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 no RFC5545. Observe que 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 . Este 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, listará os lembretes específicos do evento ou, se não definido, indicará que nenhum lembrete foi definido para o evento. O número máximo de lembretes de substituição é cinco. | gravável |
reminders.overrides[].method |
string |
O método usado pelo 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 quando 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 |
Indica 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 |
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 do 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 e hora (formatado de acordo com RFC3339). É necessário um ajuste de fuso horário, a menos que ele seja explicitamente especificado 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, 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:
|
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 marcador 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 de edifício opcional. Ela deve fazer referência ao ID de um edifício no banco de dados de Recursos da organização. | gravável |
workingLocationProperties.officeLocation.deskId |
string |
Um identificador opcional do espaço de trabalho. | 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ê mencione o 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 de 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.
// Refer to the Java quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/java // Change the scope to CalendarScopes.CALENDAR and delete any stored // credentials. Event event = new Event() .setSummary("Google I/O 2015") .setLocation("800 Howard St., San Francisco, CA 94103") .setDescription("A chance to hear more about Google's developer products."); DateTime startDateTime = new DateTime("2015-05-28T09:00:00-07:00"); EventDateTime start = new EventDateTime() .setDateTime(startDateTime) .setTimeZone("America/Los_Angeles"); event.setStart(start); DateTime endDateTime = new DateTime("2015-05-28T17:00:00-07:00"); EventDateTime end = new EventDateTime() .setDateTime(endDateTime) .setTimeZone("America/Los_Angeles"); event.setEnd(end); String[] recurrence = new String[] {"RRULE:FREQ=DAILY;COUNT=2"}; event.setRecurrence(Arrays.asList(recurrence)); EventAttendee[] attendees = new EventAttendee[] { new EventAttendee().setEmail("lpage@example.com"), new EventAttendee().setEmail("sbrin@example.com"), }; event.setAttendees(Arrays.asList(attendees)); EventReminder[] reminderOverrides = new EventReminder[] { new EventReminder().setMethod("email").setMinutes(24 * 60), new EventReminder().setMethod("popup").setMinutes(10), }; Event.Reminders reminders = new Event.Reminders() .setUseDefault(false) .setOverrides(Arrays.asList(reminderOverrides)); event.setReminders(reminders); String calendarId = "primary"; event = service.events().insert(calendarId, event).execute(); System.out.printf("Event created: %s\n", event.getHtmlLink());
Python
Usa a biblioteca cliente de Python.
# Refer to the Python quickstart on how to setup the environment: # https://developers.google.com/calendar/quickstart/python # Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any # stored credentials. event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': False, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, } event = service.events().insert(calendarId='primary', body=event).execute() print 'Event created: %s' % (event.get('htmlLink'))
PHP
Usa a biblioteca cliente de PHP.
// Refer to the PHP quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/php // Change the scope to Google_Service_Calendar::CALENDAR and delete any stored // credentials. $event = new Google_Service_Calendar_Event(array( 'summary' => 'Google I/O 2015', 'location' => '800 Howard St., San Francisco, CA 94103', 'description' => 'A chance to hear more about Google\'s developer products.', 'start' => array( 'dateTime' => '2015-05-28T09:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'end' => array( 'dateTime' => '2015-05-28T17:00:00-07:00', 'timeZone' => 'America/Los_Angeles', ), 'recurrence' => array( 'RRULE:FREQ=DAILY;COUNT=2' ), 'attendees' => array( array('email' => 'lpage@example.com'), array('email' => 'sbrin@example.com'), ), 'reminders' => array( 'useDefault' => FALSE, 'overrides' => array( array('method' => 'email', 'minutes' => 24 * 60), array('method' => 'popup', 'minutes' => 10), ), ), )); $calendarId = 'primary'; $event = $service->events->insert($calendarId, $event); printf('Event created: %s\n', $event->htmlLink);
Ruby
Usa a biblioteca de cliente Ruby.
event = Google::Apis::CalendarV3::Event.new( summary: 'Google I/O 2015', location: '800 Howard St., San Francisco, CA 94103', description: 'A chance to hear more about Google\'s developer products.', start: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T09:00:00-07:00', time_zone: 'America/Los_Angeles' ), end: Google::Apis::CalendarV3::EventDateTime.new( date_time: '2015-05-28T17:00:00-07:00', time_zone: 'America/Los_Angeles' ), recurrence: [ 'RRULE:FREQ=DAILY;COUNT=2' ], attendees: [ Google::Apis::CalendarV3::EventAttendee.new( email: 'lpage@example.com' ), Google::Apis::CalendarV3::EventAttendee.new( email: 'sbrin@example.com' ) ], reminders: Google::Apis::CalendarV3::Event::Reminders.new( use_default: false, overrides: [ Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'email', minutes: 24 * 60 ), Google::Apis::CalendarV3::EventReminder.new( reminder_method: 'popup', minutes: 10 ) ] ) ) result = client.insert_event('primary', event) puts "Event created: #{result.html_link}"
.NET
Usa a biblioteca de cliente.NET.
// Refer to the .NET quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/dotnet // Change the scope to CalendarService.Scope.Calendar and delete any stored // credentials. Event newEvent = new Event() { Summary = "Google I/O 2015", Location = "800 Howard St., San Francisco, CA 94103", Description = "A chance to hear more about Google's developer products.", Start = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T09:00:00-07:00"), TimeZone = "America/Los_Angeles", }, End = new EventDateTime() { DateTime = DateTime.Parse("2015-05-28T17:00:00-07:00"), TimeZone = "America/Los_Angeles", }, Recurrence = new String[] { "RRULE:FREQ=DAILY;COUNT=2" }, Attendees = new EventAttendee[] { new EventAttendee() { Email = "lpage@example.com" }, new EventAttendee() { Email = "sbrin@example.com" }, }, Reminders = new Event.RemindersData() { UseDefault = false, Overrides = new EventReminder[] { new EventReminder() { Method = "email", Minutes = 24 * 60 }, new EventReminder() { Method = "sms", Minutes = 10 }, } } }; String calendarId = "primary"; EventsResource.InsertRequest request = service.Events.Insert(newEvent, calendarId); Event createdEvent = request.Execute(); Console.WriteLine("Event created: {0}", createdEvent.HtmlLink);
Go
Usa a biblioteca de cliente Go.
// Refer to the Go quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/go // Change the scope to calendar.CalendarScope and delete any stored credentials. event := &calendar.Event{ Summary: "Google I/O 2015", Location: "800 Howard St., San Francisco, CA 94103", Description: "A chance to hear more about Google's developer products.", Start: &calendar.EventDateTime{ DateTime: "2015-05-28T09:00:00-07:00", TimeZone: "America/Los_Angeles", }, End: &calendar.EventDateTime{ DateTime: "2015-05-28T17:00:00-07:00", TimeZone: "America/Los_Angeles", }, Recurrence: []string{"RRULE:FREQ=DAILY;COUNT=2"}, Attendees: []*calendar.EventAttendee{ &calendar.EventAttendee{Email:"lpage@example.com"}, &calendar.EventAttendee{Email:"sbrin@example.com"}, }, } calendarId := "primary" event, err = srv.Events.Insert(calendarId, event).Do() if err != nil { log.Fatalf("Unable to create event. %v\n", err) } fmt.Printf("Event created: %s\n", event.HtmlLink)
JavaScript
Usa a biblioteca cliente de JavaScript.
// Refer to the JavaScript quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/js // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles' }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'} ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10} ] } }; var request = gapi.client.calendar.events.insert({ 'calendarId': 'primary', 'resource': event }); request.execute(function(event) { appendPre('Event created: ' + event.htmlLink); });
Node.js
Usa a biblioteca de cliente Node.js.
// Refer to the Node.js quickstart on how to setup the environment: // https://developers.google.com/calendar/quickstart/node // Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any // stored credentials. var event = { 'summary': 'Google I/O 2015', 'location': '800 Howard St., San Francisco, CA 94103', 'description': 'A chance to hear more about Google\'s developer products.', 'start': { 'dateTime': '2015-05-28T09:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'end': { 'dateTime': '2015-05-28T17:00:00-07:00', 'timeZone': 'America/Los_Angeles', }, 'recurrence': [ 'RRULE:FREQ=DAILY;COUNT=2' ], 'attendees': [ {'email': 'lpage@example.com'}, {'email': 'sbrin@example.com'}, ], 'reminders': { 'useDefault': false, 'overrides': [ {'method': 'email', 'minutes': 24 * 60}, {'method': 'popup', 'minutes': 10}, ], }, }; calendar.events.insert({ auth: auth, calendarId: 'primary', resource: event, }, function(err, event) { if (err) { console.log('There was an error contacting the Calendar service: ' + err); return; } console.log('Event created: %s', event.htmlLink); });
Confira!
Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.