Events

A API Calendar oferece diferentes tipos de recursos de eventos. Confira mais informações em Sobre os 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
    }
  ],
  "eventType": string
}

Nome da propriedade	Valor	Descrição	Observações
anyoneCanAddSelf	boolean	Se qualquer pessoa pode convidar a si mesma para o evento (descontinuado). Opcional. O valor padrão é falso.	gravável
attachments[]	list	Anexos de arquivos para o evento. Para modificar anexos, o parâmetro da solicitação supportsAttachments precisa ser definido como true. Pode haver no máximo 25 anexos por evento,
attachments[].fileId	string	ID do arquivo anexado. Somente leitura. Para arquivos do Google Drive, é o ID da entrada de recurso Files correspondente na API Drive.
attachments[].fileUrl	string	Link do URL para o anexo. Para adicionar anexos de arquivo 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 apenas para atualizar 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 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[].id	string	O ID do perfil do participante, se disponível.
attendees[].optional	boolean	Indica se este é um 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 de resposta do convidado. Os valores possíveis são: "needsAction": o participante não respondeu ao convite (recomendado para novos eventos). "declined" - O convidado recusou o convite. "tentative" - O convidado aceitou temporariamente o convite. "accepted" - O convidado aceitou o convite. Aviso:se você adicionar um evento usando os valores declined, tentative ou accepted, os participantes com a opção "Adicionar convites à minha agenda" definida como "Quando eu responder a um convite no e-mail" ou "Apenas se o remetente for conhecido" poderá ter a resposta redefinida como needsAction e não verá um evento na agenda, a menos que altere a resposta no e-mail de convite do evento. Além disso, se mais de 200 pessoas forem convidadas para o evento, o status da resposta não será propagado para os convidados.	gravável
attendees[].self	boolean	Indica se essa entrada representa a agenda em que essa cópia do evento aparece. Somente leitura. O valor padrão é falso.
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
conferenceData.conferenceId	string	O ID da videoconferência. Pode ser usado por desenvolvedores para acompanhar conferências. Não deve ser exibido 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 foi definido. Esse tipo de videoconferência foi descontinuado. eventNamedHangout: ID é o nome do Hangout. Esse tipo de conferência foi descontinuado. hangoutsMeet: o ID é o código da reunião de 10 letras, 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 videoconferê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 esta solução.
conferenceData.conferenceSolution.key	nested object	A chave que pode identificar exclusivamente a solução de conferência para este evento.
conferenceData.conferenceSolution.key.type	string	O tipo de solução de conferência. Se um cliente encontrar um tipo desconhecido ou vazio, ele ainda poderá exibir os pontos de entrada. No entanto, ela precisa impedir modificações. Os valores possíveis são: "eventHangout" para Hangouts para consumidores (descontinuado; eventos existentes podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "eventNamedHangout" para usuários do Hangouts clássico para Google Workspace (descontinuado. Os eventos atuais podem mostrar esse tipo de solução de videoconferência, mas não é possível criar novas videoconferências) "hangoutsMeet" para o Google Meet (http://meet.google.com) "addOn" para provedores de conferência de terceiros
conferenceData.conferenceSolution.name	string	O nome visível para o usuário da solução. Não localizada.
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 ver se os dados estão presentes, verifique o campo status. É necessário 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, ele ainda poderá exibir os pontos de entrada. No entanto, ela precisa impedir modificações. Os valores possíveis são: "eventHangout" para Hangouts para consumidores (descontinuado; eventos existentes podem mostrar esse tipo de solução de conferência, mas não é possível criar novas conferências) "eventNamedHangout" para usuários do Hangouts clássico para Google Workspace (descontinuado. Os eventos atuais podem mostrar esse tipo de solução de videoconferência, mas não é possível criar novas videoconferências) "hangoutsMeet" para o Google Meet (http://meet.google.com) "addOn" para provedores de conferência de terceiros
conferenceData.createRequest.requestId	string	O ID exclusivo gerado pelo cliente para essa solicitação. Os clientes precisam gerar esse ID novamente para cada nova solicitação. Se um ID fornecido for o mesmo da solicitação anterior, a solicitação será ignorada.
conferenceData.createRequest.status	nested object	O status da solicitação de criação de videoconferê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 da conferência foi concluída, e os pontos de entrada foram preenchidos. "failure": ocorreu uma falha no pedido de criação de videoconferência. Não há pontos de entrada.
conferenceData.entryPoints[]	list	Informações sobre pontos de entrada de videoconferência individuais, como URLs ou números de telefone. Todos eles devem pertencer à mesma conferência. É necessário conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.entryPoints[].accessCode	string	O código de acesso para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondam à terminologia usada pelo provedor da videoconferência. Somente os campos preenchidos serão mostrados. Opcional.
conferenceData.entryPoints[].entryPointType	string	O tipo de ponto de entrada da conferência. Os valores possíveis são: "video": participando de uma conferência por HTTP. Uma videoconferência pode ter nenhum ou um ponto de entrada video. "phone": participar de uma conferência discando um número de telefone. Uma videoconferência pode ter zero ou mais phone pontos de entrada. "sip" - participando de uma conferência por SIP. Uma videoconferência pode ter nenhum ou um ponto de entrada sip. "more" – outras instruções para participar da conferência, como números de telefone adicionais. Uma videoconferência pode ter nenhum ou um ponto de entrada more. Uma conferência com apenas um ponto de entrada more não é válida.
conferenceData.entryPoints[].label	string	A etiqueta do URI. Visível para os usuários finais. Não localizada. O tamanho máximo é de 512 caracteres. Exemplos: para video: meet.google.com/aaa-bbbb-fc para phone: [phone] para sip: [e-mail] para more: não deve ser preenchido Opcional.
conferenceData.entryPoints[].meetingCode	string	O código da reunião para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondam à terminologia usada pelo provedor da videoconferência. Somente os campos preenchidos serão mostrados. Opcional.
conferenceData.entryPoints[].passcode	string	A senha para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondam à terminologia usada pelo provedor da videoconferência. Somente os campos preenchidos serão exibidos.
conferenceData.entryPoints[].password	string	A senha para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondam à terminologia usada pelo provedor da videoconferência. Somente os campos preenchidos serão mostrados. Opcional.
conferenceData.entryPoints[].pin	string	O PIN para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Ao criar novos dados de videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondam à terminologia usada pelo provedor da videoconferência. Somente os campos preenchidos serão mostrados. Opcional.
conferenceData.entryPoints[].uri	string	URI do ponto de entrada. O tamanho máximo é de 1.300 caracteres. Formato: para o esquema video, 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 o esquema more, http: ou https:.
conferenceData.notes	string	Observações adicionais (como instruções do administrador do domínio, avisos legais) a serem exibidas 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 videoconferência com uma solicitação de criação com falha. Opcional para uma videoconferê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, se disponível.
creator.email	string	O endereço de e-mail do criador, se disponível.
creator.id	string	O ID do perfil do criador de conteúdo, se disponível.
creator.self	boolean	Se o criador corresponde à agenda em que essa 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. No caso de um evento recorrente, é 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	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
endTimeUnspecified	boolean	Se o horário de término realmente não foi especificado. Por motivos de compatibilidade, um horário de término ainda é fornecido, 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 que dura o dia inteiro e tem recorrência anual. "default" - Um evento regular ou não especificado de outra forma. "focusTime": um evento de tempo de foco. "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 na agenda.	gravável
extendedProperties.private.(key)	string	O nome da propriedade particular e o valor correspondente.
extendedProperties.shared	object	Propriedades que são compartilhadas entre as cópias do evento nos outros participantes. agendas.	gravável
extendedProperties.shared.(key)	string	O nome da propriedade compartilhada e o valor correspondente.
focusTimeProperties	nested object	Dados do evento "Horário de concentração". Usado se eventType for focusTime.	gravável
focusTimeProperties.autoDeclineMode	string	Se você quer recusar convites de reunião que se sobrepõem aos eventos "Horário de concentração". Os valores válidos são declineNone, o que significa que nenhum convite de reunião é recusado; declineAllConflictingInvitations, o que significa que todos os convites de reunião em conflito com o evento são recusados; e declineOnlyNewConflictingInvitations, o que significa que apenas novos convites de reunião em conflito que chegam enquanto o evento "Tempo de foco" está presente são recusados.
focusTimeProperties.chatStatus	string	O status para marcar o usuário no Chat e produtos relacionados. Os valores podem ser available ou doNotDisturb.
focusTimeProperties.declineMessage	string	Mensagem de resposta para definir se um evento existente ou novo convite é automaticamente recusado pelo Agenda.
gadget	object	Um gadget que estende esse evento. Os gadgets foram descontinuados; essa estrutura é usada apenas para retornar metadados da agenda de aniversários.
gadget.display	string	O modo de exibição do gadget. Obsoleto. Os valores possíveis são: "icon" - O gadget é exibido ao lado do título do evento na visualização da agenda. "chip": o gadget aparece 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 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.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 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
hangoutLink	string	Um link absoluto para o Hangout do Google 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 em RFC5545. Ele é usado para identificar eventos de maneira exclusiva nos sistemas de agenda e precisa ser fornecido ao importar eventos por meio do método import. iCalUID e id não são idênticos, e apenas um deles precisa ser informado no momento da criação do evento. Uma diferença na semântica deles é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todas compartilham os mesmos iCalUIDs. Para recuperar um evento usando o iCalUID, chame o método events.list usando o parâmetro iCalUID. Para recuperar um evento usando o id, chame o método events.get.
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: 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 agenda Devido à natureza distribuída globalmente do sistema, não podemos garantir que os conflitos de ID sejam detectados no momento da criação do evento. Para minimizar o risco de colisões, recomendamos o uso de um algoritmo UUID estabelecido, como o descrito na RFC4122. Se você não especificar um ID, ele será gerado automaticamente pelo servidor. icalUID e id não são idênticos, e apenas um deles precisa ser informado no momento da criação do evento. Uma diferença na semântica deles é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todas compartilham os mesmos icalUIDs.	gravável
kind	string	Tipo do recurso ("calendar#event").
location	string	A localização geográfica do evento como texto em formato livre. Opcional.	gravável
locked	boolean	Indica se esta é uma cópia do evento bloqueado em que nenhuma mudança pode ser feita nos campos "resumo", "descrição", "local", "início" e "término" do evento. 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, conforme o 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, este é o horário em que o evento começaria de acordo com os dados de recorrência no evento recorrente identificado por reCAPTCHAEventId. Identifica de forma exclusiva a instância dentro da série de eventos recorrentes, mesmo que a instância tenha sido movida para um horário diferente. Imutá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
outOfOfficeProperties.autoDeclineMode	string	Se você quer recusar convites para reuniões que se sobrepõem a eventos "Fora do escritório". Os valores válidos são declineNone, o que significa que nenhum convite de reunião é recusado. declineAllConflictingInvitations, o que significa que todos os convites de reunião conflitantes que entram em conflito com o evento são recusados; e declineOnlyNewConflictingInvitations, o que significa que apenas os novos convites de reunião conflitantes que chegarem enquanto o evento "Fora do escritório" estiver presente serão recusados.
outOfOfficeProperties.declineMessage	string	Mensagem de resposta para definir se um evento existente ou novo convite é automaticamente recusado pelo Agenda.
privateCopy	boolean	Se definido como "True", a propagação de eventos será desativada. Observação: 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 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
recurringEventId	string	Para uma instância de um evento recorrente, é o id do evento recorrente a que essa instância pertence. Imutável.
reminders	object	Informações sobre os lembretes do evento para o usuário autenticado. A mudança de lembretes não altera também a propriedade updated do evento de inclusão.
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: "email" - Os lembretes são enviados por e-mail. "popup" - Os lembretes são enviados por uma janela pop-up na interface. 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	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 do URL precisa ser HTTP ou HTTPS.	gravável
start	nested object	O horário de início do evento. 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	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: "confirmed" - O evento foi confirmado. Esse é o status padrão. "tentative" - O evento está temporariamente confirmado. "cancelled": o evento foi cancelado (excluído). O método list retorna eventos cancelados somente na sincronização incremental (quando syncToken ou updatedMin são especificados) ou se a flag showDeleted está definida como true. O método get sempre os retorna. Um status cancelado representa dois estados diferentes, dependendo do tipo de evento: As 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 devem armazenar esses eventos durante todo o ciclo de vida do evento recorrente pai. Só é garantido que as exceções canceladas terão valores para os campos id, recurringEventId e originalStartTime preenchidos. 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 em algum momento. Por isso, não espere que eles fiquem disponíveis indefinidamente. Só é garantido que os eventos excluídos terão o campo id preenchido. Na agenda do organizador, os eventos cancelados continuam expondo os detalhes deles (resumo, local etc.) para que possam ser restaurados (cancelar exclusão). 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 falso não vão retornar esses detalhes. Se um evento alterar o organizador (por exemplo, com a operação move) e o organizador original não estiver na lista de participantes, o evento cancelado será mantido, e apenas o campo id será preenchido.	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 horário na agenda. Isso equivale a definir Mostrar-me como como Ocupado na interface do Agenda. "transparent": o evento não bloqueia o horário na agenda. Isso equivale a definir Mostrar-me como como Disponível na interface do Agenda.	gravável
updated	datetime	Hora da última modificação dos dados do evento principal (como um carimbo de data/hora RFC3339). A atualização de lembretes de evento não causará a alteração. 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 dele ficam visíveis para todos os leitores da agenda. "private" - O evento é privado e somente os participantes podem visualizar os detalhes. "confidential" - O evento é privado. Esse valor é fornecido por motivos de compatibilidade.	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ê 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: "homeOffice" - O usuário está trabalhando em casa. "officeLocation" - O usuário está trabalhando em um escritório. "customLocation" - O usuário está trabalhando de 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 serã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 com o parâmetro iCalUID.

import

Importa um evento. Essa operação é usada para adicionar uma cópia particular de um evento a uma agenda. Apenas eventos com um eventType de default podem ser importados.

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

inserir

Cria um evento.

instâncias

Retorna instâncias do evento recorrente especificado.

list

Retorna eventos da agenda especificada.

mover

Move um evento para outra agenda, ou seja, altera o organizador do evento. Apenas eventos default podem ser movidos. Não é possível mover os eventos birthday, focusTime, fromGmail, outOfOffice e workingLocation.

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 uma get seguida por uma update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Campos de matriz, se especificados, substituem as matrizes existentes. isso descartará os elementos anteriores da matriz.

quickAdd

Cria um evento baseado em uma string de texto simples.

update

Atualiza um evento. Esse método não oferece suporte à semântica de patch e sempre atualiza todo o recurso do evento. Para fazer uma atualização parcial, execute uma get seguida por uma update usando ETags para garantir a atomicidade.

watch

Monitore as mudanças nos recursos de eventos.