Events

A API Calendar fornece diferentes variações de recursos de eventos. Mais informações podem ser encontradas em 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
    }
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Nome da propriedade Valor Descrição Observações
anyoneCanAddSelf boolean Se alguém pode se convidar para o evento (obsoleto). Opcional. O valor padrão é falso. gravável
attachments[] list Anexos do 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.

Nos arquivos do Google Drive, esse é o ID da entrada de recurso Files correspondente na API Drive.

attachments[].fileUrl string URL para o anexo.

Para adicionar 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[].mimeType string Tipo de mídia da Internet (MIME) do anexo.
attachments[].title string Título do anexo.
attendeesOmitted boolean Se os participantes foram omitidos da representação do evento. Ao recuperar um evento, isso pode ser 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 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 adicionais. Opcional. O padrão é 0. gravável
attendees[].comment string O comentário da 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. Este campo precisa estar presente ao adicionar um participante. Precisa ser um endereço de e-mail válido de acordo com a RFC5322 (em inglês).

Obrigatório ao adicionar um participante.

gravável
attendees[].id string O ID do perfil do participante, 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 serã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 convidado não respondeu ao convite (recomendado para novos eventos).
  • "declined" - O convidado recusou o convite.
  • "tentative": o participante aceitou o convite provisoriamente.
  • "accepted": o participante aceitou o convite.
gravável
attendees[].self boolean Se essa entrada representa a agenda na qual esta cópia do evento aparece. Somente leitura. O valor padrão é falso.
colorId string A cor do evento. Esse é um ID referente 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 suas alterações, 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 conferência.

Pode ser usado por desenvolvedores para acompanhar conferências, não deve ser exibido para usuários.

O valor do ID é formado de forma diferente para cada tipo de solução de conferência:

  • eventHangout: o ID não foi definido. Esse tipo de conferência está obsoleto.
  • eventNamedHangout: ID é o nome do Hangout. Esse tipo de conferência está obsoleto.
  • hangoutsMeet: código é o código da reunião com 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 que falhou.

É necessário usar conferenceSolution e pelo menos um entryPoint ou createRequest.

conferenceData.conferenceSolution.iconUri string O ícone visível para o usuário desta 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, as modificações não serão permitidas.

Os valores possíveis são:

  • "eventHangout" para Hangouts para consumidores (uso suspenso. 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 o Google Workspace (descontinuado). Os eventos atuais 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 de terceiros

conferenceData.conferenceSolution.name string O nome visível desta solução 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 ver se os dados estão presentes, verifique o campo status.

É necessário usar 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, ele ainda poderá exibir os pontos de entrada. No entanto, as modificações não serão permitidas.

Os valores possíveis são:

  • "eventHangout" para Hangouts para consumidores (uso suspenso. 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 o Google Workspace (descontinuado). Os eventos atuais 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 de terceiros

conferenceData.createRequest.requestId string O ID exclusivo gerado pelo cliente para esta solicitação.

Os clientes devem 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 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, os pontos de entrada são preenchidos.
  • "failure": falha na solicitação de criação de conferência. 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 eles precisam pertencer à mesma conferência.

É necessário usar conferenceSolution e pelo menos um entryPoint ou createRequest.

conferenceData.entryPoints[].accessCode string O código de acesso à 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 da conferência. Somente os campos preenchidos serão exibidos.

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 conferência pode ter zero ou um ponto de entrada video.
  • "phone" - ao participar de uma conferência, discando um número de telefone. Uma conferência pode ter zero ou mais pontos de entrada phone.
  • "sip" - participando de uma conferência por SIP. Uma conferência pode ter zero ou um ponto de entrada sip.
  • "more": instruções adicionais sobre como participar da conferência, como números de telefone adicionais Uma conferência pode ter zero ou um ponto de entrada more. Uma conferência com apenas um ponto de entrada more não é uma conferência 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: +1 123 268 2601
  • para sip: 12345678@altostrat.com
  • para more: não deve 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 videoconferência, preencha apenas o subconjunto de campos {meetingCode, accessCode, passcode, password, pin} que correspondem à terminologia usada pelo provedor da conferência. Somente os campos preenchidos serão exibidos.

Opcional.

conferenceData.entryPoints[].passcode string A senha 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 da conferência. Somente os campos preenchidos serão exibidos.

conferenceData.entryPoints[].password string A senha 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 da conferência. Somente os campos preenchidos serão exibidos.

Opcional.

conferenceData.entryPoints[].pin string O PIN 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 da conferência. Somente os campos preenchidos serão 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: é obrigatório.
  • 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: é obrigatório.

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 pelo servidor.

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

Opcional para uma conferência com uma solicitação de criação pendente.

created datetime Hora da criação do evento (como um timestamp 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 de conteúdo, se disponível.
creator.id string O ID do perfil do criador, se disponível.
creator.self boolean Indica se o criador de conteúdo corresponde à agenda em que a 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 de data e hora combinado (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja explicitamente especificado em timeZone. gravável
end.timeZone string O fuso horário em que a hora é especificada. Formatado como um nome do banco de dados 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/fim do evento. gravável
endTimeUnspecified boolean Indica se o horário de término não está 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 poderá ser modificado depois que o evento for criado. Os valores possíveis são:
  • "default": um evento normal ou não especificado.
  • "outOfOffice" - um evento fora do escritório.
  • "focusTime": um evento "Hora de se concentrar".
  • "workingLocation": um evento do local de trabalho.
No momento, apenas eventos "default " e "workingLocation" podem ser criados usando a API. O suporte estendido para outros tipos de evento será disponibilizado em versões futuras.
gravável
extendedProperties object Propriedades estendidas do evento.
extendedProperties.private object Propriedades que são particulares à cópia do evento que aparece nesta agenda. gravável
extendedProperties.private.(key) string O nome da propriedade privada 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.
gadget object Um gadget que estende este evento. Os gadgets estão obsoletos. 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 é 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 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 outras pessoas além do organizador podem convidar outras pessoas para o evento. Opcional. O padrão é "True". gravável
guestsCanModify boolean Se convidados que não sejam o organizador podem modificar o evento. Opcional. O valor padrão é falso. gravável
guestsCanSeeOtherGuests boolean Se outras pessoas além do organizador podem ver quem são os participantes do evento. Opcional. O padrão é "True". gravável
iCalUID string Identificador exclusivo de evento, conforme definido em RFC5545. Ele é usado para identificar de forma exclusiva eventos em sistemas de agenda e precisa ser fornecido ao importar eventos por meio do método import.

Observe que iCalUID e 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 deles é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todas compartilham 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 deles. Os IDs fornecidos devem seguir estas regras:
  • caracteres permitidos no código são aqueles usados na codificação base32hex, isto é, letras minúsculas a-v e dígitos de 0-9, consulte a seção 3.1.2 em RFC2938
  • o ID deve ter entre 5 e 1024 caracteres
  • o código precisa ser exclusivo por agenda
Devido à natureza distribuída globalmente do sistema, não podemos garantir que os conflitos de ID serão detectados 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.

Observe que icalUID e 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 deles é que, em eventos recorrentes, todas as ocorrências de um evento têm ids diferentes, enquanto todas compartilham as mesmas icalUIDs.

gravável
kind string Tipo de recurso ("calendar#event").
location string É a localização geográfica do evento como texto de formato livre. Opcional. gravável
locked boolean Se for uma cópia de evento bloqueada em que nenhuma alteração pode ser feita nos campos do evento principal "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 alterar 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. Precisa ser um endereço de e-mail válido de acordo com a RFC5322 (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 a 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 esse evento iniciaria de acordo com os dados de recorrência no evento recorrente identificado por "eventEventId". Ele identifica a instância de maneira exclusiva 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 de data e hora combinado (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja explicitamente especificado em timeZone. gravável
originalStartTime.timeZone string O fuso horário em que a hora é especificada. Formatado como um nome do banco de dados 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/fim do evento. gravável
privateCopy boolean Se definido como verdadeiro, a Propagação do evento será desativada. Não é o mesmo que propriedades de eventos privados. 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. 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 ao qual esta 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, essa ação listará os lembretes específicos do evento ou, se não forem definidos, indica que nenhum lembrete foi definido para o evento. O número máximo de lembretes de modificação é cinco. 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 IU.

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 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 da sequência de acordo com o iCalendar. gravável
source object Origem em que 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 de um assunto de 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 (inclusivo) do evento. Para um evento recorrente, este é 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 de data e hora combinado (formatado de acordo com RFC3339). Um ajuste de fuso horário é obrigatório, a menos que um fuso horário seja explicitamente especificado em timeZone. gravável
start.timeZone string O fuso horário em que a hora é especificada. Formatado como um nome do banco de dados 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/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á confirmado provisoriamente.
  • "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. 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 a vida útil do evento recorrente pai.

      As exceções canceladas só têm valores garantidos para os 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 eventualmente. Portanto, não dependa que eles estejam disponíveis indefinidamente.

      Os eventos excluídos só têm o campo id preenchido.

    Na agenda do organizador, os eventos cancelados continuam expondo os detalhes (resumo, local etc.) para que possam ser restaurados. 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 incrementais com showDeleted definido como falso não retornarão esses detalhes.

    Se um evento alterar o organizador (por exemplo, por meio da operação move) e o organizador original não estiver na lista de participantes, ele deixará um evento cancelado onde somente 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 tempo na agenda. Isso equivale a definir Mostrar-me como como Ocupado na interface do usuário do Google Agenda.
  • "transparent": o evento não bloqueia o tempo na agenda. Isso equivale a definir Mostrar-me como como Disponível na interface do usuário 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 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 apenas os convidados dele podem ver os detalhes.
  • "confidential": o evento é particular. Esse valor é fornecido por motivos de compatibilidade.
gravável
workingLocationProperties nested object Dados de evento 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 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 edifício opcional. Ele deve fazer referência a um código 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 de seção mínimo opcional. gravável
workingLocationProperties.officeLocation.label string O nome do escritório exibido nos clientes do Agenda na Web e para dispositivos móveis. Recomendamos que você faça referência a um nome de edifício 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.
Quaisquer detalhes são especificados em um subcampo do nome especificado, mas este campo poderá 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.
importar
Importa um evento. Esta operação é usada para adicionar uma cópia particular de um evento existente a uma agenda.
inserir
Cria um evento.
instâncias
Retorna instâncias do evento recorrente especificado.
list
Retorna eventos na agenda especificada.
mover
Move um evento para outra agenda, por exemplo, altera o organizador de um evento.
patch
Atualiza um evento. Este método oferece suporte à semântica de patches. Cada solicitação de patch consome três unidades de cota. Use uma get seguida por um update. Os valores de campo especificados substituem os valores existentes. Os campos que você não especificar na solicitação permanecerão inalterados. Se forem especificados, os campos de matriz substituirão as matrizes existentes. Isso descartará os elementos de matriz anteriores.
quickAdd (em inglês)
Cria um evento com base em uma string de texto simples.
update
Atualiza um evento. Este 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 por um update usando etags para garantir a atomicidade.
assistir
Fique atento a alterações nos recursos de Eventos.