Events

A API Calendar oferece diferentes opções de recursos de evento. 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 arquivo do evento.

Para modificar os anexos, o parâmetro de 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, 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 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[].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, essa opção só pode ser usada 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 participantes 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 convidado, se disponível. Opcional. gravável
attendees[].email string O endereço de e-mail do convidado, se disponível. Este campo deve estar presente ao adicionar um convidado. Ele precisa ser um endereço de e-mail válido de acordo com o RFC5322 (link em inglês).

Obrigatório ao adicionar um convidado.

 gravável
attendees[].id string O ID do perfil do convidado, se disponível.
attendees[].optional boolean 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. As 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 convidado não respondeu ao convite (recomendado para novos eventos).
  • "declined": o convidado recusou o convite.
  • "tentative": o convidado aceitou o convite provisoriamente.
  • "accepted": o convidado aceitou o convite.
 gravável
attendees[].self boolean Indica se a entrada representa a agenda em que a 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 à videoconferência, como os detalhes de uma videoconferência do Google Meet. Para criar novos detalhes de videoconferência, use o campo createRequest. Para manter suas mudanças, defina o parâmetro de solicitação conferenceDataVersion como 1 para todas as solicitações de modificação de eventos. gravável
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 videoconferência foi descontinuado.
  • hangoutsMeet: 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 videoconferência, como o Google Meet.

Não definido para uma conferência com uma solicitação de criação com falha.

É necessário ter conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.conferenceSolution.iconUri string O ícone visível ao usuário dessa solução.
conferenceData.conferenceSolution.key nested object A chave que pode identificar de forma exclusiva a solução da 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 poderá mostrar os pontos de entrada. No entanto, ela deve impedir modificações.

Os valores possíveis são:

  • "eventHangout" para Hangouts para consumidores (descontinuado. Os eventos existentes podem mostrar esse tipo de solução de conferência, mas não é possível criar conferências novas)
  • "eventNamedHangout" para usuários do Hangouts clássico para usuários do Google Workspace (descontinuado. Os eventos existentes podem mostrar esse tipo de solução de videoconferência, mas não é possível criar novas conferências)
  • "hangoutsMeet" para o Google Meet (http://meet.google.com)
  • "addOn" para provedores de conferência terceirizados

conferenceData.conferenceSolution.name string Nome da solução visível ao usuário. Não localizado.
conferenceData.createRequest nested object Uma solicitação para gerar uma nova videoconferê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 ter conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.createRequest.conferenceSolutionKey nested object A solução de videoconferência, como o Hangouts ou o 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 poderá mostrar os pontos de entrada. No entanto, ela deve impedir modificações.

Os valores possíveis são:

  • "eventHangout" para Hangouts para consumidores (descontinuado. Os eventos existentes podem mostrar esse tipo de solução de conferência, mas não é possível criar conferências novas)
  • "eventNamedHangout" para usuários do Hangouts clássico para usuários do Google Workspace (descontinuado. Os eventos existentes podem mostrar esse tipo de solução de videoconferência, mas não é possível criar novas conferências)
  • "hangoutsMeet" para o Google Meet (http://meet.google.com)
  • "addOn" para provedores de conferência terceirizados

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 videoconferência. Somente leitura.

Os valores possíveis são:

  • "pending": a solicitação de criação de videoconferência ainda está sendo processada.
  • "success": a solicitação de criação de videoconferência foi concluída, os pontos de entrada foram preenchidos.
  • "failure": ocorreu uma falha na solicitação de criação de videoconferência. Não há pontos de entrada.

conferenceData.entryPoints[] list Informações sobre pontos de entrada de conferência individuais, como URLs ou números de telefone.

Todos eles precisam pertencer à mesma conferência.

É necessário ter conferenceSolution e pelo menos um entryPoint ou createRequest.
conferenceData.entryPoints[].accessCode string O código de acesso para acessar a conferê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 correspondem à terminologia usada pelo provedor de videoconferência. Somente os campos preenchidos devem ser exibidos.

Opcional.
conferenceData.entryPoints[].entryPointType string O tipo de ponto de entrada da conferência.

Os valores possíveis são:

  • "video": para participar de uma videoconferência por HTTP. Uma videoconferência pode ter nenhum ou um ponto de entrada video.
  • "phone": para participar de uma videoconferência, discando um número de telefone. Uma videoconferência pode ter zero ou mais pontos de entrada do phone.
  • "sip": para participar de uma videoconferência por SIP. Uma videoconferência pode ter nenhum ou um ponto de entrada sip.
  • "more": outras instruções para participar de conferências, como números de telefone. Uma videoconferência pode ter nenhum ou um ponto de entrada more. Uma videoconferê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.

Por exemplo:

  • para video: meet.google.com/aaa-bbbb-Files
  • para phone: +1 123 268 2601
  • para sip: 12345678@altostrat.com
  • para more: não deve ser preenchido

Opcional.
conferenceData.entryPoints[].meetingCode string 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 correspondem à terminologia usada pelo provedor de videoconferência. Somente os campos preenchidos devem ser exibidos.

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 correspondem à terminologia usada pelo provedor de videoconferência. Somente os campos preenchidos devem ser 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 correspondem à terminologia usada pelo provedor de videoconferência. Somente os campos preenchidos devem ser exibidos.

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 correspondem à terminologia usada pelo provedor de videoconferência. Somente os campos preenchidos devem ser exibidos.

Opcional.
conferenceData.entryPoints[].uri string O 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 deve incluir toda a sequência de discagem (por exemplo, tel:+12345678900,,,123456789;1234).
  • para sip, o esquema sip: é obrigatório, por exemplo, sip:12345678@myprovider.com.
  • 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 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 de 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, 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, este é 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-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário 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, este 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/término do evento. gravável
endTimeUnspecified boolean Se o horário de término realmente não está especificado. Um horário de término ainda é fornecido por motivos de compatibilidade, mesmo que esse atributo seja 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:
  • "default": um evento regular ou não especificado.
  • "outOfOffice": um evento fora do escritório.
  • "focusTime": um evento "Horário de concentração".
  • "workingLocation": um evento de local de trabalho.
 gravável
extendedProperties object Propriedades estendidas do evento.
extendedProperties.private object São as propriedades particulares à cópia do evento que aparece nessa 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 do evento "Horário de concentração". Usado se eventType for focusTime. gravável
focusTimeProperties.autoDeclineMode string Define se você quer recusar convites para reuniões 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, que significa que todos os convites de reunião conflitantes em conflito com o evento serão recusados; e declineOnlyNewConflictingInvitations, o que significa que apenas novos convites de reunião conflitantes que chegarem enquanto o evento "Horário de concentração" estiver presente serão recusados.
focusTimeProperties.chatStatus string Status para marcar o usuário no Chat e produtos relacionados. Os valores podem ser available ou doNotDisturb.
focusTimeProperties.declineMessage string Mensagem de resposta a ser definida se um evento existente ou novo convite for recusado automaticamente pelo Google Agenda.
gadget object Um gadget que estende esse evento. Os gadgets estão obsoletos. Esta estrutura é usada apenas para retornar metadados de calendários 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 é 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 zero. Opcional. 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 zero. Opcional. Obsoleto. gravável
guestsCanInviteOthers boolean Se participantes que não sejam o 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
iCalUID string Identificador exclusivo do evento, conforme definido no RFC5545. Ele é usado para identificar eventos de forma exclusiva em sistemas de agenda e precisa ser fornecido durante a importação de eventos pelo método import.

Observe que iCalUID e id não são idênticos. Apenas um deles precisa 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, embora todas compartilhem as mesmas 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. 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 a-v e dígitos 0-9, consulte a seção 3.1.2 em RFC2938 (link em inglês).
  • o comprimento do ID deve ter entre 5 e 1024 caracteres
  • o ID precisa ser exclusivo por agenda
Devido à natureza distribuída globalmente do sistema, não podemos garantir a detecção de conflitos de ID 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 (link em inglês).

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

Observe que icalUID e id não são idênticos. Apenas um deles precisa 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, embora todas compartilhem as mesmas 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 de evento bloqueada, em que nenhuma alteração pode ser feita nos campos principais do evento "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 convidado, isso será indicado em uma entrada separada no arquivo attendees com o campo organizer definido como "True". Para alterar o organizador, use a operação mover. 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 o RFC5322 (link em inglês). gravável
organizer.id string O ID do perfil do organizador, se disponível.
organizer.self boolean Indica 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, esse é o horário em que o evento começa de acordo com os dados de recorrência do evento recorrente identificado por recorrenteEventId. Ela identifica exclusivamente 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-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário 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, este 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/término do evento. gravável
outOfOfficeProperties nested object Dados de eventos fora do escritório. Usado se eventType for outOfOffice. gravável
outOfOfficeProperties.autoDeclineMode string Define se os convites de reunião que se sobrepõem a eventos "fora do escritório" serão recusados. Os valores válidos são declineNone, o que significa que nenhum convite de reunião é recusado; declineAllConflictingInvitations, que significa que todos os convites de reunião conflitantes que estiverem em conflito com o evento serão recusados; e declineOnlyNewConflictingInvitations, o que significa que apenas 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 a ser definida se um evento existente ou novo convite for recusado automaticamente pelo Google Agenda.
privateCopy boolean Se for definido como verdadeiro, a Propagação de eventos será desativada. Elas não são a mesma coisa que as 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 em RFC5545. As linhas DTSTART e DTEND não são permitidas nesse campo. Os horários de início e término do evento são especificados nos campos start e end. Este 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 ao qual a instância pertence. Imutável.
reminders object Informações sobre os lembretes do evento para o usuário autenticado.
reminders.overrides[] list Se o evento não usar os lembretes padrão, os lembretes específicos serão listados ou, se não for definido, indica que nenhum lembrete foi definido para o evento. O número máximo de lembretes de substituição é 5. 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 em 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 Define se os lembretes padrão da agenda se aplicam ao evento. gravável
sequence integer Número de sequência de acordo com o iAgenda. gravável
source object Origem da criação do evento. 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 O título da fonte, por exemplo, o título de uma página da Web ou o assunto de um e-mail. gravável
source.url string URL da origem que aponta para um recurso. O esquema de URL precisa ser HTTP ou HTTPS. gravável
start nested object O horário (inclusive) de início do evento. Para um evento recorrente, é 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-hora (formatado de acordo com RFC3339). É necessário um deslocamento de fuso horário, a menos que um fuso horário 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, este 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/término 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 foi confirmado temporariamente.
  • "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 sinalização showDeleted estiver definida como true. O método get sempre as retorna.

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

    1. 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 o ciclo de vida do evento recorrente pai.

      As exceções canceladas só garantem o preenchimento dos valores dos campos id, recurringEventId e originalStartTime. Os outros campos podem estar vazios.

    2. Todos os outros eventos cancelados representam eventos excluídos. Os clientes devem remover as cópias sincronizadas localmente. Esses eventos cancelados desaparecerão em algum momento. Portanto, não espere que eles fiquem disponíveis indefinidamente.

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

    Na agenda do organizador, os eventos cancelados continuam a exibir detalhes (resumo, local etc.) para que possam ser restaurados (cancelar a exclusão). Da mesma forma, os eventos para os quais o usuário foi convidado e que ele removeu manualmente continuam a fornecer 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 seu organizador (por exemplo, por meio da operação mover) e o organizador original não estiver na lista de participantes, ele deixará um evento cancelado em que apenas o campo id será preenchido.

gravável
summary string Título do evento. gravável
transparency string Define 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 configurar Mostrar-me como como Ocupado na interface do Google Agenda.
  • "transparent": o evento não bloqueia o horário na agenda. Isso equivale a configurar Mostrar-me como como Disponível na interface do Google Agenda.
 gravável
updated datetime Horário da última modificação do evento (como um carimbo de data/hora RFC3339). Somente leitura.
visibility string Visibilidade do evento. Opcional. Os valores possíveis são:
  • "default": usa a visibilidade padrão para eventos da agenda. Esse é o valor padrão.
  • "public": o evento é público, e os detalhes dele são visíveis para todos os leitores da agenda.
  • "private": o evento é privado e somente os participantes podem ver os detalhes.
  • "confidential": o evento é particular. 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 rótulo extra opcional para mais informações. gravável
workingLocationProperties.homeOffice any value Se presente, especifica que o usuário está trabalhando em casa. gravável
workingLocationProperties.officeLocation object Se presente, especifica que o usuário está trabalhando em um escritório. gravável
workingLocationProperties.officeLocation.buildingId string Um identificador de edifício opcional. Ele deve fazer referência a um ID de edifício no banco de dados de Recursos da organização. gravável
workingLocationProperties.officeLocation.deskId string um identificador de espaço de trabalho opcional. gravável
workingLocationProperties.officeLocation.floorId string Um identificador de andar opcional. gravável
workingLocationProperties.officeLocation.floorSectionId string Um identificador opcional da seção do andar. gravável
workingLocationProperties.officeLocation.label string O nome do escritório que é exibido nos clientes Web do Google Agenda e 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 em um local personalizado.
Todos os detalhes são especificados em um subcampo do nome indicado, mas esse campo poderá estar ausente se estiver vazio. Todos os outros campos serão ignorados.

Obrigatório ao adicionar propriedades do local de trabalho.

 gravável

Métodos

excluir
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 privada de um evento a uma agenda. Apenas eventos com eventType de default podem ser importados.

Comportamento descontinuado:se um evento não default for importado, o tipo dele vai 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 da agenda especificada.
mover
Move um evento para outra agenda, ou seja, altera o organizador de um evento. Apenas eventos default podem ser movidos; eventos outOfOffice, focusTime e workingLocation não podem ser movidos.
patch
Atualiza um evento. Este método oferece suporte à semântica de patches. Observe que cada solicitação de patch consome três unidades de cota. Prefira usar um get seguido por um update. Os valores de campo especificados substituem os atuais. Os campos não especificados na solicitação permanecem inalterados. Os campos de matriz, se especificados, substituem as matrizes existentes. Isso descarta todos os elementos anteriores da matriz.
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 do evento. Para fazer uma atualização parcial, execute uma get seguida por uma update usando etags para garantir a atomicidade.
relógio
Acompanhe as mudanças nos recursos de Eventos.