Events

A API Calendar oferece diferentes tipos de recursos de eventos. Para mais informações, consulte Sobre eventos.

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}

Nome da propriedade	Valor	Descrição	Observações
anyoneCanAddSelf	boolean	Se qualquer pessoa pode se convidar para o evento (descontinuado). Opcional. O valor padrão é falso.	gravável
attachments[]	list	Anexos de arquivo do evento. Para modificar anexos, o parâmetro de solicitação supportsAttachments precisa ser definido como true. É possível ter no máximo 25 anexos por evento.
attachments[].fileId	string	ID do arquivo anexado. Somente leitura. Para arquivos do Google Drive, esse é o ID da entrada de recurso Files correspondente na API Drive.
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
attachments[].iconLink	string	Link do URL para o ícone do anexo. Esse campo só pode ser modificado para anexos personalizados de terceiros.
attachments[].mimeType	string	Tipo de mídia da Internet (tipo MIME) do anexo.
attachments[].title	string	Título do anexo.
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, isso pode ser usado para atualizar apenas a resposta do participante. Opcional. O valor padrão é falso.	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[].id	string	O ID do perfil do participante, se disponível.
attendees[].optional	boolean	Indica se o participante é opcional. Opcional. O valor padrão é falso.	gravável
attendees[].organizer	boolean	Se o participante é o organizador do evento. Somente leitura. O valor padrão é falso.
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. Aviso:se você adicionar um evento usando os valores declined, tentative ou accepted, a resposta dos participantes com a configuração "Adicionar convites à minha agenda" definida como "Quando eu responder ao convite no e-mail" ou "Apenas se o remetente for conhecido" poderá ser redefinida como needsAction. Além disso, eles não vão ver um evento na agenda, a menos que mudem a resposta no e-mail de convite. Além disso, se mais de 200 convidados forem convidados para o evento, o status da resposta não será propagado para eles.	gravável
attendees[].self	boolean	Se esta entrada representa a agenda em que esta cópia do evento aparece. Somente leitura. O valor padrão é falso.
birthdayProperties	nested object	Dados de aniversário ou evento especial. Usado se eventType for "birthday". Imutável.	gravável
birthdayProperties.contact	string	Nome do recurso do contato a que este evento de aniversário está vinculado. Isso pode ser usado para buscar detalhes de contato na API People. Formato: "people/c12345". Somente leitura.
birthdayProperties.customTypeName	string	Rótulo de tipo personalizado especificado para este evento. Ele será preenchido se birthdayProperties.type estiver definido como "custom". Somente leitura.
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. Aviso:reutilizar dados de conferências do Google Meet em diferentes eventos pode causar problemas de acesso e expor detalhes da reunião a usuários não intencionais. Para garantir a privacidade da reunião, sempre gere uma videoconferência exclusiva para cada evento usando o campo createRequest.	gravável
conferenceData.conferenceId	string	O ID da conferência. Pode ser usado por desenvolvedores para acompanhar conferências, mas não deve ser mostrado aos usuários. O valor do ID é formado de maneira diferente para cada tipo de solução de conferência: eventHangout: o ID não está definido. (Esse tipo de conferência foi descontinuado.) eventNamedHangout: o ID é o nome do Hangout. (Esse tipo de conferência foi descontinuado.) hangoutsMeet: o ID é o código de 10 letras da reunião, por exemplo, aaa-bbbb-ccc. addOn: o ID é definido pelo provedor terceirizado. Opcional.
conferenceData.conferenceSolution	nested object	A solução de conferência, como o Google Meet. Não definido para uma conferência com uma solicitação de criação com falha. É necessário incluir conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.conferenceSolution.iconUri	string	O ícone visível ao usuário para essa solução.
conferenceData.conferenceSolution.key	nested object	A chave que pode identificar exclusivamente a solução de conferência para esse evento.
conferenceData.conferenceSolution.key.type	string	O tipo de solução de conferência. Se um cliente encontrar um tipo desconhecido ou vazio, ainda será possível mostrar os pontos de entrada. No entanto, ele não pode permitir modificações. Os valores possíveis são: "eventHangout" para o Hangouts para consumidores (descontinuado; os eventos atuais podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "eventNamedHangout" para o Hangouts clássico para usuários do Google Workspace (descontinuado; os eventos atuais podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "hangoutsMeet" para o Google Meet (http://meet.google.com) "addOn" para provedores de conferências terceirizados
conferenceData.conferenceSolution.name	string	O nome da solução visível para o usuário. Não localizado.
conferenceData.createRequest	nested object	Uma solicitação para gerar uma nova conferência e anexá-la ao evento. Os dados são gerados de forma assíncrona. Para verificar se os dados estão presentes, confira o campo status. É necessário incluir conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.createRequest.conferenceSolutionKey	nested object	A solução de conferência, como Hangouts ou Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type	string	O tipo de solução de conferência. Se um cliente encontrar um tipo desconhecido ou vazio, ainda será possível mostrar os pontos de entrada. No entanto, ele não pode permitir modificações. Os valores possíveis são: "eventHangout" para o Hangouts para consumidores (descontinuado; os eventos atuais podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "eventNamedHangout" para o Hangouts clássico para usuários do Google Workspace (descontinuado; os eventos atuais podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "hangoutsMeet" para o Google Meet (http://meet.google.com) "addOn" para provedores de conferências terceirizados
conferenceData.createRequest.requestId	string	O ID exclusivo gerado pelo cliente para esta solicitação. Os clientes precisam regenerar esse ID para cada nova solicitação. Se um ID fornecido for igual ao da solicitação anterior, a solicitação será ignorada.
conferenceData.createRequest.status	nested object	O status da solicitação de criação de conferência.
conferenceData.createRequest.status.statusCode	string	O status atual da solicitação de criação de conferência. Somente leitura. Os valores possíveis são: "pending": a solicitação de criação de conferência ainda está sendo processada. "success": a solicitação de criação de conferência foi bem-sucedida e os pontos de entrada foram preenchidos. "failure": a solicitação de criação de conferência falhou, não há pontos de entrada.
conferenceData.entryPoints[]	list	Informações sobre pontos de entrada de conferências individuais, como URLs ou números de telefone. Todos precisam pertencer à mesma conferência. É necessário incluir conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.entryPoints[].accessCode	string	O código de acesso para entrar na conferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de conferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor de conferências. Somente os campos preenchidos devem ser mostrados. Opcional.
conferenceData.entryPoints[].entryPointType	string	O tipo do ponto de entrada da conferência. Os valores possíveis são: "video": participar de uma conferência por HTTP. Uma conferência pode ter zero ou um ponto de entrada video. "phone": ligar para um número de telefone e participar de uma conferência. Uma conferência pode ter zero ou mais pontos de entrada phone. "sip": participar de uma conferência por SIP. Uma conferência pode ter zero ou um ponto de entrada sip. "more": mais instruções para participar da conferência, por exemplo, outros números de telefone. Uma conferência pode ter zero ou um ponto de entrada more. Uma conferência com apenas um ponto de entrada more não é válida.
conferenceData.entryPoints[].label	string	O rótulo do URI. Visível para os usuários finais. Não localizado. O tamanho máximo é de 512 caracteres. Exemplos: para video: meet.google.com/aaa-bbbb-ccc para phone: [phone] para sip: [e-mail] para more: não pode ser preenchido Opcional.
conferenceData.entryPoints[].meetingCode	string	O código da reunião para acessar a conferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de conferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor de conferências. Somente os campos preenchidos devem ser mostrados. Opcional.
conferenceData.entryPoints[].passcode	string	A senha para acessar a conferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de conferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor de conferências. Somente os campos preenchidos devem ser mostrados.
conferenceData.entryPoints[].password	string	A senha para acessar a conferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de conferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor de conferências. Somente os campos preenchidos devem ser mostrados. Opcional.
conferenceData.entryPoints[].pin	string	O PIN para acessar a conferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de conferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor de conferências. Somente os campos preenchidos devem ser mostrados. Opcional.
conferenceData.entryPoints[].uri	string	O URI do ponto de entrada. O tamanho máximo é de 1.300 caracteres. Formato: Para video, é necessário um esquema http: ou https:. Para phone, o esquema tel: é obrigatório. O URI precisa incluir toda a sequência de discagem (por exemplo, tel:[phone],,,123456789;1234). para sip, o esquema sip: é obrigatório. Por exemplo, sip:[e-mail]. Para more, é necessário um esquema http: ou https:.
conferenceData.notes	string	Observações adicionais (como instruções do administrador do domínio, avisos legais) para mostrar ao usuário. Pode conter HTML. O tamanho máximo é de 2.048 caracteres. Opcional.
conferenceData.signature	string	A assinatura dos dados da conferência. Gerado no lado do servidor. Não definido para uma conferência com uma solicitação de criação com falha. Opcional para uma conferência com uma solicitação de criação pendente.
created	datetime	Hora da criação do evento (como um carimbo de data/hora RFC3339). Somente leitura.
creator	object	O criador do evento. Somente leitura.
creator.displayName	string	O nome do criador de conteúdo, se disponível.
creator.email	string	O endereço de e-mail do criador de conteúdo, se disponível.
creator.id	string	O ID do perfil do criador de conteúdo, se disponível.
creator.self	boolean	Indica se o criador corresponde à agenda em que esta cópia do evento aparece. Somente leitura. O valor padrão é falso.
description	string	É a descrição do evento. Pode conter HTML. Opcional.	gravável
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.
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
endTimeUnspecified	boolean	Indica se o horário de término não foi especificado. Um horário de término ainda é fornecido por motivos de compatibilidade, mesmo que esse atributo esteja definido como "True". O valor padrão é falso.
etag	etag	ETag do recurso.
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	object	Propriedades estendidas do evento.
extendedProperties.private	object	Propriedades particulares da cópia do evento que aparece nesta agenda.	gravável
extendedProperties.private.(key)	string	O nome da propriedade particular e o valor correspondente.
extendedProperties.shared	object	Propriedades compartilhadas entre cópias do evento nas agendas de outros participantes.	gravável
extendedProperties.shared.(key)	string	O nome da propriedade compartilhada e o valor correspondente.
focusTimeProperties	nested object	Dados de eventos do Horário de concentração. Usado se eventType for focusTime.	gravável
focusTimeProperties.autoDeclineMode	string	Se os convites para reuniões que se sobrepõem aos eventos de "Hora de se concentrar" devem ser recusados. Os valores válidos são declineNone, que significa que nenhum convite para reunião é recusado; declineAllConflictingInvitations, que significa que todos os convites para reunião conflitantes com o evento são recusados; e declineOnlyNewConflictingInvitations, que significa que apenas os novos convites para reunião conflitantes que chegam enquanto o evento de Tempo de foco está presente são recusados.
focusTimeProperties.chatStatus	string	O status para marcar o usuário no Chat e em produtos relacionados. Os valores podem ser available ou doNotDisturb.
focusTimeProperties.declineMessage	string	Mensagem de resposta a ser definida se um evento ou convite novo for recusado automaticamente pelo Google Agenda.
gadget	object	Um gadget que estende esse evento. Os gadgets foram descontinuados. Em vez disso, essa estrutura é usada apenas para retornar metadados do calendário de aniversários.
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.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.preferences.(key)	string	O nome da preferência e o valor correspondente.
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
hangoutLink	string	Um link absoluto para o Google Hangout associado a este evento. Somente leitura.
htmlLink	string	Um link absoluto para esse evento na interface da Web do Google Agenda. Somente leitura.
iCalUID	string	Identificador exclusivo do evento, conforme definido na RFC5545. Ele é usado para identificar eventos de maneira exclusiva em sistemas de agenda e precisa ser fornecido ao importar eventos usando o método import. 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. Para recuperar um evento usando o iCalUID dele, chame o método events.list usando o parâmetro iCalUID. Para recuperar um evento usando o id dele, chame o método events.get.
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
kind	string	Tipo do recurso ("calendar#event").
location	string	Localização geográfica do evento como texto livre. Opcional.	gravável
locked	boolean	Se esta é uma cópia bloqueada do evento em que não é possível fazer mudanças nos campos principais "resumo", "descrição", "local", "início", "fim" ou "recorrência". O valor padrão é falso. Somente leitura.
organizer	object	O organizador do evento. Se o organizador também for um participante, isso será indicado com uma entrada separada em attendees com o campo organizer definido como "True". Para mudar o organizador, use a operação move. Somente leitura, exceto ao importar um evento.	gravável
organizer.displayName	string	O nome do organizador, se disponível.	gravável
organizer.email	string	O endereço de e-mail do organizador, se disponível. Ele precisa ser um endereço de e-mail válido, de acordo com a RFC5322.	gravável
organizer.id	string	O ID do perfil do organizador, se disponível.
organizer.self	boolean	Se o organizador corresponde à agenda em que esta cópia do evento aparece. Somente leitura. O valor padrão é falso.
originalStartTime	nested object	Para uma instância de um evento recorrente, é o horário em que o evento começaria de acordo com os dados de recorrência no evento recorrente identificado por "recurringEventId". Ele identifica de forma exclusiva a instância na série de eventos recorrentes, mesmo que ela tenha sido movida para outro horário. Imutá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
outOfOfficeProperties.autoDeclineMode	string	Se os convites para reuniões que se sobrepõem aos eventos fora do escritório devem ser recusados. Os valores válidos são declineNone, o que significa que nenhum convite para reunião é recusado; declineAllConflictingInvitations, o que significa que todos os convites para reunião conflitantes com o evento são recusados; e declineOnlyNewConflictingInvitations, o que significa que apenas os novos convites para reunião conflitantes que chegarem enquanto o evento "Fora do escritório" estiver presente serão recusados.
outOfOfficeProperties.declineMessage	string	Mensagem de resposta a ser definida se um evento ou convite novo for recusado automaticamente pelo Google Agenda.
privateCopy	boolean	Se definido como "True", a propagação de eventos será desativada. Não é a mesma coisa que Propriedades de eventos particulares. Opcional. Imutável. O valor padrão é falso.
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
recurringEventId	string	Para uma instância de um evento recorrente, este é o id do evento recorrente a que esta instância pertence. Imutável.
reminders	object	Informações sobre os lembretes do evento para o usuário autenticado. Mudar os lembretes não altera a propriedade updated do evento envolvido.
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	object	Origem de onde o evento foi criado. Por exemplo, uma página da Web, uma mensagem de e-mail ou qualquer documento identificável por um URL com esquema HTTP ou HTTPS. Só pode ser visto ou modificado pelo criador do evento.
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	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.
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: 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. 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 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
updated	datetime	Hora da última modificação dos dados principais do evento (como um carimbo de data/hora RFC3339). Atualizar os lembretes de eventos não vai mudar isso. Somente leitura.
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

Métodos

delete

Exclui um evento.

get

Retorna um evento com base no ID do Google Agenda. Para recuperar um evento usando o ID do iCalendar, chame o método events.list usando o parâmetro iCalUID.

import

Importa um evento. Essa operação é usada para adicionar uma cópia particular de um evento a uma agenda. Só é possível importar eventos com um eventType de default.

Comportamento descontinuado:se um evento que não seja default for importado, o tipo dele será alterado para default, e todas as propriedades específicas do tipo de evento serão descartadas.

inserir

Cria um evento.

instâncias

Retorna instâncias do evento recorrente especificado.

list

Retorna eventos na agenda especificada.

move

Move um evento para outra agenda, ou seja, muda o organizador de um evento. Só é possível mover eventos default. Os eventos birthday, focusTime, fromGmail, outOfOffice e workingLocation não podem ser movidos.

patch

Atualiza um evento. Esse método é compatível com a semântica de patch. Cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido de um update. Os valores de campo especificados substituem os valores atuais. Os campos que você não especificar na solicitação vão permanecer inalterados. Se especificados, os campos de matriz substituem as matrizes atuais, descartando todos os elementos anteriores.

quickAdd

Cria um evento com base em uma string de texto simples.

update

Atualiza um evento. Esse método não é compatível com a semântica de patch e sempre atualiza todo o recurso de evento. Para fazer uma atualização parcial, execute um get seguido de um update usando ETags para garantir a atomicidade.

assistir

Monitora mudanças nos recursos de eventos.