Google Calendar
Visão geral
Seção intitulada “Visão geral”O Google Agenda é um serviço de gerenciamento e agendamento de tempo que ajuda equipes e indivíduos a organizar reuniões, lembretes e disponibilidade. Com a integração do Google Agenda no SquadOS, seus agentes podem criar, atualizar, pesquisar e gerenciar eventos em calendários, bem como consultar informações de disponibilidade.
- Site oficial: https://calendar.google.com/
- Documentação na Composio: docs.composio.dev/toolkits/googlecalendar
Autenticação
Seção intitulada “Autenticação”Esta ferramenta utiliza OAuth 2.0 (OAUTH2) para conectar. Na maioria dos casos, você só precisa autorizar o acesso durante o fluxo de conexão.
Você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
N/A | Não | A autenticação é feita via fluxo OAuth no navegador durante a conexão. |
Como obter a credencial
Seção intitulada “Como obter a credencial”- Se sua organização exigir o uso de seu próprio aplicativo Google OAuth (em vez do aplicativo gerenciado pelo Composio), abra o Console do Google Cloud e crie/selecione um projeto.
- Ative a Google Calendar API para esse projeto (APIs e serviços).
- Configure a tela de consentimento do OAuth (interna/externa) e adicione as informações necessárias do aplicativo.
- Crie um ID do cliente OAuth (aplicativo da Web) e adicione o URI de redirecionamento autorizado fornecido pelo Composio para Google Apps.
- Copie o ID do cliente e o Segredo do cliente e use-os ao criar/configurar sua autenticação do Google Apps no Composio.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
Google Calendar. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth do Google.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Como configuro credenciais personalizadas do Google OAuth para o Google Agenda?
Seção intitulada “Como configuro credenciais personalizadas do Google OAuth para o Google Agenda?”Para obter um guia passo a passo sobre como criar e configurar suas próprias credenciais do Google OAuth com Composio, consulte How to create OAuth2 credentials for Google Apps.
Por que vejo “Aplicativo bloqueado” ao conectar o Google Agenda?
Seção intitulada “Por que vejo “Aplicativo bloqueado” ao conectar o Google Agenda?”O cliente OAuth está solicitando escopos que o Google não verificou para esse cliente. Isso geralmente acontece quando você adiciona escopos extras além dos padrões.
Remova os escopos adicionais da sua configuração de autenticação ou crie seu próprio aplicativo OAuth e envie os escopos para verificação. Consulte How to create OAuth2 credentials for Google Apps.
Por que estou recebendo o erro “A API do Google Agenda não foi usada no projeto”?
Seção intitulada “Por que estou recebendo o erro “A API do Google Agenda não foi usada no projeto”?”Ao usar credenciais OAuth personalizadas, a API Google Calendar deve estar ativada no projeto do Google Cloud que possui essas credenciais. Ative-o no Console do Google Cloud em APIs e serviços, aguarde alguns minutos e tente novamente.
Por que estou recebendo “Erro 400: invalid_scope”?
Seção intitulada “Por que estou recebendo “Erro 400: invalid_scope”?”Os escopos solicitados são inválidos ou estão formatados incorretamente no URL de autorização. Verifique os valores do seu escopo em relação ao Google OAuth scopes docs. Se você estiver criando configurações de autenticação programaticamente, consulte programmatic auth config guide.
Por que a tela de consentimento do OAuth mostra “Composio” em vez do meu aplicativo?
Seção intitulada “Por que a tela de consentimento do OAuth mostra “Composio” em vez do meu aplicativo?”Por padrão, a tela de consentimento usa o aplicativo OAuth da Composio. Para mostrar o nome e logotipo do seu próprio aplicativo, crie seu próprio aplicativo OAuth e defina um URL de redirecionamento personalizado. Consulte White-labeling authentication.
Por que estou recebendo erros 401 nas chamadas de ferramentas?
Seção intitulada “Por que estou recebendo erros 401 nas chamadas de ferramentas?”O token de acesso do usuário não é mais válido. Causas comuns: o usuário revogou o acesso, alterou a senha ou 2FA, uma política de administrador do Workspace foi alterada ou o limite de token de atualização do Google (cerca de 50 por conta) foi excedido. A reautenticação do usuário normalmente resolve isso.
Ações disponíveis
Seção intitulada “Ações disponíveis”Excluir regra ACL
Seção intitulada “Excluir regra ACL”GOOGLECALENDAR_ACL_DELETE
Exclui uma regra de controle de acesso de um Google Agenda. Use quando precisar remover permissões de compartilhamento de um usuário, grupo ou domínio.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
rule_id | string | Sim | Identificador de regra ACL. |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha a regra ACL
Seção intitulada “Obtenha a regra ACL”GOOGLECALENDAR_ACL_GET
Recupera uma regra de controle de acesso específica para um calendário. Use quando precisar verificar as permissões de um usuário, grupo ou domínio específico.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
rule_id | string | Sim | Identificador de regra ACL. Formato: ‘scope_type:scope_value’ ou ‘default’. Tipos de escopo válidos: ‘usuário’ (e-mail), ‘grupo’ (e-mail de grupo), ‘domínio’ (nome de domínio), ‘padrão’ (acesso público). Exemplos: ‘usuário:john@example.com’, ‘grupo:equipe@example.com’, ‘domínio:example.com’, ‘padrão’. Nota: ‘eu’ NÃO é válido; use e-mail/domínio real. A regra deve existir - use GOOGLECALENDAR_LIST_ACL_RULES para encontrar IDs válidos. |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Criar regra ACL
Seção intitulada “Criar regra ACL”GOOGLECALENDAR_ACL_INSERT
Cria uma regra de controle de acesso para um calendário. Use quando precisar conceder permissões de compartilhamento a um usuário, grupo ou domínio.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
role | string (“none” | Não | ”leitor” |
scope | object | Sim | A extensão em que o acesso ao calendário é concedido por esta regra da ACL. Especifica quem obtém o acesso (usuário, grupo, domínio ou padrão). |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
send_notifications | boolean | Não | Se deseja enviar notificações sobre a alteração no compartilhamento do calendário. Opcional. O padrão é verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar regras ACL
Seção intitulada “Listar regras ACL”GOOGLECALENDAR_ACL_LIST
Recupera a lista de regras de controle de acesso (ACLs) para um calendário especificado, fornecendo os valores de ‘rule_id’ necessários para atualizar regras de ACL específicas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pageToken | string | Não | Token especificando qual página de resultados retornar. Opcional. |
syncToken | string | Não | Token obtido do campo nextSyncToken retornado na última página de uma operação de lista anterior. Faz com que o resultado desta operação de lista contenha apenas entradas que foram alteradas desde então. Opcional. O padrão é recuperar todas as entradas. |
calendarId | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
maxResults | integer | Não | Número máximo de entradas retornadas em uma página de resultados. Opcional. O padrão é 100. |
showDeleted | boolean | Não | Se devem ser incluídas ACLs excluídas no resultado. Opcional. O padrão é Falso. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Regra de patch ACL
Seção intitulada “Regra de patch ACL”GOOGLECALENDAR_ACL_PATCH
Atualiza uma regra de controle de acesso existente para um calendário usando semântica de patch (atualização parcial). Isto permite modificar campos específicos sem afetar outras propriedades. IMPORTANTE: A regra ACL já deve existir no calendário. Esta ação não pode criar novas regras. Se você receber um erro 404 Not Found, a regra não existe - use a inserção de ACL para criá-la primeiro ou use a lista de ACL para verificar as regras disponíveis. Cada solicitação de patch consome três unidades de cota. Para regras ACL do tipo domínio, se PATCH falhar com erro 500, esta ação retornará automaticamente para o método UPDATE.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
role | string | Não | A função atribuída ao escopo. Os valores possíveis são: “none” – Não fornece acesso; “freeBusyReader” - Fornece acesso de leitura a informações de livre/ocupado; “leitor” - Fornece acesso de leitura ao calendário (os eventos privados aparecem, mas os detalhes ficam ocultos); “escritor” - Fornece acesso de leitura e gravação ao calendário (eventos privados e detalhes são visíveis); “proprietário” - Fornece propriedade do calendário (todas as permissões do escritor, além da capacidade de ver e manipular ACLs). |
scope | object | Não | A extensão em que o acesso ao calendário é concedido por esta regra da ACL. Opcional para operações de patch. Deve incluir type (um de: ‘usuário’, ‘grupo’, ‘domínio’, ‘padrão’) e value (endereço de e-mail ou nome de domínio) para todos os tipos, exceto ‘padrão’. |
rule_id | string | Sim | Identificador de regra ACL de uma regra existente. IMPORTANTE: A regra já deve existir no calendário - esta ação não pode criar novas regras, apenas modificar as existentes. Use a ação de lista de ACL para localizar IDs de regras existentes ou use a ação de inserção de ACL para criar uma nova regra primeiro. Formato: ‘tipo:valor’, como ‘usuário:email@example.com’ ou ‘grupo:grupo@example.com’. |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
send_notifications | boolean | Não | Se deseja enviar notificações sobre a alteração no compartilhamento do calendário. Observe que não há notificações sobre remoção de acesso. Opcional. O padrão é Verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Atualizar regra ACL
Seção intitulada “Atualizar regra ACL”GOOGLECALENDAR_ACL_UPDATE
Atualiza uma regra de controle de acesso para o calendário especificado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
role | string | Sim | A função atribuída ao escopo. Os valores possíveis são: - “none” - Não fornece acesso. - “freeBusyReader” - Fornece acesso de leitura a informações de livre/ocupado. - “leitor” - Fornece acesso de leitura ao calendário. Os eventos privados aparecerão para usuários com acesso de leitor, mas os detalhes do evento ficarão ocultos. - “escritor” - Fornece acesso de leitura e gravação ao calendário. Os eventos privados aparecerão para usuários com acesso de gravador e os detalhes do evento ficarão visíveis. - “proprietário” - Fornece propriedade do calendário. Esta função tem todas as permissões da função de escritor com a capacidade adicional de ver e manipular ACLs. |
rule_id | string | Sim | Identificador de regra ACL. |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
send_notifications | boolean | Não | Se deseja enviar notificações sobre a alteração no compartilhamento do calendário. Observe que não há notificações sobre remoção de acesso. Opcional. O padrão é Verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Observe as alterações da ACL
Seção intitulada “Observe as alterações da ACL”GOOGLECALENDAR_ACL_WATCH
Ferramenta para observar alterações nos recursos ACL. Use quando precisar configurar notificações em tempo real para modificações na lista de controle de acesso em um calendário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Um UUID ou sequência exclusiva semelhante que identifica este canal. |
type | string | Não | O tipo de mecanismo de entrega usado para este canal. Os valores válidos são “web_hook” ou “webhook”. |
token | string | Não | Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por meio deste canal. Opcional. |
params | object | Não | Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional. |
address | string | Sim | O endereço onde as notificações são entregues para este canal. |
calendarId | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Eventos em lote
Seção intitulada “Eventos em lote”GOOGLECALENDAR_BATCH_EVENTS
Execute até 1.000 mutações de eventos (criar/corrigir/excluir) em uma solicitação em lote HTTP do Google Agenda com status/resultados por item. Use isso para reduzir significativamente as viagens de ida e volta para operações em massa, como migrações, limpeza ou atualizações em grande escala.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
fail_fast | boolean | Não | Se for verdade, pare o processamento após o primeiro lote contendo qualquer erro 4xx (exceto 404 em DELETE). O padrão é falso. |
operations | array | Sim | Lista de operações em lote a serem executadas. Máximo de 1.000 operações por solicitação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Remover calendário da lista
Seção intitulada “Remover calendário da lista”GOOGLECALENDAR_CALENDAR_LIST_DELETE
Ferramenta para remover um calendário da lista de calendários do usuário. Use quando precisar cancelar a assinatura ou ocultar um calendário da lista de usuários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave ‘primary’. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha um calendário único por ID
Seção intitulada “Obtenha um calendário único por ID”GOOGLECALENDAR_CALENDAR_LIST_GET
Recupera metadados para um ÚNICO calendário específico da lista de calendários do usuário por seu ID de calendário. Esta ação requer um parâmetro calendarId e retorna detalhes apenas sobre esse calendário. NOTA: Isto NÃO lista todos os calendários. Para listar todos os calendários na lista de calendários do usuário, use GOOGLECALENDAR_CALENDAR_LIST_LIST.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendarId | string | Sim | Obrigatório. O identificador do calendário único a ser recuperado. Use ‘primário’ para o calendário principal do usuário autenticado ou forneça um ID de calendário específico (por exemplo, um endereço de e-mail ou ID de calendário de grupo). Para encontrar IDs de agendas, primeiro use GOOGLECALENDAR_CALENDAR_LIST_LIST para listar todas as agendas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Inserir calendário na lista
Seção intitulada “Inserir calendário na lista”GOOGLECALENDAR_CALENDAR_LIST_INSERT
Insere um calendário existente na lista de calendários do usuário, tornando-o visível na UI. Calendários (por exemplo, os recém-criados) não aparecerão na lista ou na interface do usuário até serem inseridos explicitamente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | O identificador do calendário a ser inserido. Deve ser um ID de calendário válido em formato de e-mail (por exemplo, ‘user@example.com’ para um calendário de usuário ou ‘calendarid@group.calendar.google.com’ para um calendário compartilhado). Observação: a palavra-chave ‘primária’ não é suportada para esta operação. Em vez disso, use o endereço de e-mail real da agenda principal. O calendário deve existir e você deve ter permissões de acesso apropriadas. |
hidden | boolean | Não | Se o calendário foi ocultado da lista. Aceita apenas valores booleanos: verdadeiro ou falso. Se não for especificado, o padrão da API será falso. |
colorId | string | Não | A cor do calendário. Este é um ID referente a uma entrada na paleta de cores calendarCore. |
selected | boolean | Não | Se o calendário está selecionado e visível na lista de calendários. Aceita apenas valores booleanos: verdadeiro ou falso. Se não for especificado, o padrão da API será falso. |
backgroundColor | string | Não | A cor de fundo do calendário na UI da Web. (Código de cores hexadecimal) |
foregroundColor | string | Não | A cor de primeiro plano do calendário na UI da Web. (Código de cores hexadecimal) |
summaryOverride | string | Não | O resumo que o usuário autenticado definiu para este calendário. |
color_rgb_format | boolean | Não | Se deve usar os campos foregroundColor e backgroundColor para escrever as cores do calendário (RGB). Se esse recurso for usado, o campo colorId baseado em índice será definido automaticamente para a melhor opção de correspondência. Opcional. O padrão é Falso. |
defaultReminders | array | Não | Os lembretes padrão que o usuário autenticado possui para este calendário. |
notificationSettings | object | Não | As notificações que o usuário autenticado está recebendo para este calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Entrada na lista do calendário de patches
Seção intitulada “Entrada na lista do calendário de patches”GOOGLECALENDAR_CALENDAR_LIST_PATCH
Atualiza um calendário existente na lista de calendários do usuário usando a semântica de patch. Este método permite atualizações parciais, modificando apenas os campos especificados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hidden | boolean | Não | Se o calendário está oculto. |
colorId | string | Não | ID da cor do calendário do ponto final de cores. |
selected | boolean | Não | Se o conteúdo do calendário é exibido na IU. |
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Use a palavra-chave “primária” para o calendário principal do usuário conectado no momento. |
colorRgbFormat | boolean | Não | Se deve usar RGB para cores de primeiro plano/fundo. |
backgroundColor | string | Não | Cor hexadecimal para plano de fundo do calendário. |
foregroundColor | string | Não | Cor hexadecimal para o primeiro plano do calendário. |
summaryOverride | string | Não | Resumo definido pelo usuário para o calendário. |
defaultReminders | array | Não | Lista de lembretes padrão. |
notificationSettings | object | Não | Configurações de notificação para o calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Atualizar entrada da lista de calendário
Seção intitulada “Atualizar entrada da lista de calendário”GOOGLECALENDAR_CALENDAR_LIST_UPDATE
Atualiza as configurações de exibição/assinatura de uma entrada de lista de calendário (cor, visibilidade, lembretes, seleção) para o usuário autenticado — não modifica o recurso de calendário subjacente (título, fuso horário, etc.). Para modificar o próprio calendário, use GOOGLECALENDAR_CALENDARS_UPDATE.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
hidden | boolean | Não | Se o calendário está oculto. |
colorId | string | Não | ID da cor do calendário do ponto final de cores. |
selected | boolean | Não | Se o conteúdo do calendário é exibido na IU. |
calendar_id | string | Sim | Identificador de calendário. Deve ser um ID de calendário real (por exemplo, “examplecalendar@group.calendar.google.com” ou “c_abc123…@group.calendar.google.com”). Para recuperar IDs de calendário válidos, use primeiro a ação GOOGLECALENDAR_LIST_CALENDARS. O alias “primário” não é válido para calendarList.update. |
colorRgbFormat | boolean | Não | Se deve usar RGB para cores de primeiro plano/fundo. |
backgroundColor | string | Não | Cor hexadecimal para plano de fundo do calendário. |
foregroundColor | string | Não | Cor hexadecimal para o primeiro plano do calendário. |
summaryOverride | string | Não | Resumo definido pelo usuário para o calendário. |
defaultReminders | array | Não | Lista de lembretes padrão. |
notificationSettings | object | Não | Configurações de notificação para o calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Assistir lista de calendário
Seção intitulada “Assistir lista de calendário”GOOGLECALENDAR_CALENDAR_LIST_WATCH
Fique atento às alterações nos recursos do CalendarList usando notificações push. Use isto para receber atualizações em tempo real quando as entradas da lista de calendário forem modificadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Um UUID ou sequência exclusiva semelhante que identifica este canal. Máximo de 64 caracteres. |
type | string | Sim | O tipo de mecanismo de entrega usado para este canal. Deve ser “web_hook” ou “webhook”. |
token | string | Não | Uma string arbitrária entregue ao endereço de destino com cada notificação. Máximo de 256 caracteres. Usado para verificação de canal e roteamento de mensagens. |
params | object | Não | Parâmetros adicionais que controlam o comportamento do canal de entrega. |
address | string | Sim | O URL HTTPS onde as notificações são entregues para este canal. Deve ter um certificado SSL válido. |
expiration | integer | Não | Carimbo de data/hora Unix em milissegundos indicando quando a API deve parar de enviar notificações. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Excluir calendário
Seção intitulada “Excluir calendário”GOOGLECALENDAR_CALENDARS_DELETE
Exclui um calendário secundário de sua propriedade ou no qual você tem permissão de exclusão. A exclusão é permanente e irreversível — verifique o calendário_id correto antes de ligar. Você não pode excluir seu calendário principal ou calendários aos quais você só tem acesso de leitura/gravação. Use calendarList.list para encontrar calendários com accessRole de proprietário. Para calendários primários, use calendars.clear. Chamadas paralelas podem acionar userRateLimitExceeded; exclusões em massa de sequência.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendar_id | string | Sim | Identificador de calendário de um calendário secundário que você possui ou no qual tem permissão de exclusão. Use calendarList.list para encontrar IDs de calendário que podem ser excluídos (procure accessRole “proprietário”). Os calendários principais não podem ser excluídos; use a ação Limpar calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Atualizar calendário
Seção intitulada “Atualizar calendário”GOOGLECALENDAR_CALENDARS_UPDATE
Atualização completa no estilo PUT que substitui todos os campos de metadados do calendário; campos opcionais não especificados são desmarcados. Use GOOGLECALENDAR_PATCH_CALENDAR para atualizar apenas um subconjunto de campos. Muda o recurso de calendário subjacente (título, descrição, fuso horário, etc.); use GOOGLECALENDAR_CALENDAR_LIST_UPDATE para alterar as propriedades de exibição por usuário, como cor.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Sim | Título do calendário. Deve ser uma string não vazia; passar uma string vazia limpa o título do calendário. |
location | string | Não | Localização geográfica do calendário como texto de formato livre. Opcional. |
timeZone | string | Não | O fuso horário do calendário. (Formatado como um nome de banco de dados de fuso horário da IANA, por exemplo, “Europa/Zurique”.) Opcional. |
calendarId | string | Sim | Identificador de calendário. Use ‘principal’ para atualizar a agenda principal do usuário conectado no momento ou forneça um ID de agenda específico (normalmente em formato de e-mail como ‘abc123@group.calendar.google.com’). Para recuperar IDs de calendário, chame o método calendarList.list. IMPORTANTE: Este NÃO é o nome/título de exibição do calendário. NOTA: Para obter melhor desempenho, prefira fornecer o ID real do calendário em vez de ‘primário’, pois o alias ‘primário’ requer uma chamada de API adicional para ser resolvido. |
description | string | Não | Descrição do calendário. Opcional. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Parar canal
Seção intitulada “Parar canal”GOOGLECALENDAR_CHANNELS_STOP
Ferramenta para deixar de monitorar recursos através de canal de notificação. Use quando precisar descontinuar notificações push para uma assinatura de canal específica.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Um UUID ou sequência exclusiva semelhante que identifica este canal. |
token | string | Não | Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por meio deste canal. Opcional. |
resourceId | string | Sim | Um ID opaco que identifica o recurso que está sendo monitorado neste canal. Estável em diferentes versões de API. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Limpar calendário
Seção intitulada “Limpar calendário”GOOGLECALENDAR_CLEAR_CALENDAR
Limpa um calendário principal excluindo todos os eventos dele. O próprio calendário é preservado; apenas seus eventos são removidos. Os calendários principais não podem ser totalmente excluídos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendar_id | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha definições de cores
Seção intitulada “Obtenha definições de cores”GOOGLECALENDAR_COLORS_GET
Retorna as definições de cores para calendários e eventos. Use quando precisar recuperar a paleta de cores disponível para estilizar calendários ou eventos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Criar Evento
Seção intitulada “Criar Evento”GOOGLECALENDAR_CREATE_EVENT
Crie um evento do Google Agenda usando start_datetime mais campos de duração. O organizador é adicionado como participante, a menos que exclude_organizer seja True. Por padrão, adiciona o link do Google Meet (funciona para o Workspace, mas volta normalmente para o Gmail pessoal). Os participantes podem ser strings de e-mail (obrigatório) ou objetos com e-mail e campos opcionais. Nenhuma verificação de conflito é executada; use GOOGLECALENDAR_FREE_BUSY_QUERY para detectar sobreposições antes de criar. Retorna o ID do evento e o htmlLink aninhados em data.response_data. Exemplo: { “start_datetime”: “2025-01-16T13:00:00”, “timezone”: “America/New_York”, “event_duration_hour”: 1, “event_duration_minutos”: 30, “summary”: “Sincronização do cliente”, “attendees”: [“required@example.com”, {“email”: “opcional@exemplo.com”, “opcional”: verdadeiro}] }
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Não | Resumo (título) do evento. |
location | string | Não | Localização geográfica do evento em texto de formato livre. |
timezone | string | Não | Nome do fuso horário IANA do banco de dados de fuso horário (por exemplo, ‘América/Nova_Iorque’, ‘Europa/Londres’, ‘Ásia/Jerusalém’, ‘UTC’). Obrigatório se datetime for ingênuo. Para eventos recorrentes, o início e o fim devem incluir um fuso horário. Se não for fornecido, o UTC será usado. Se datetime incluir informações de fuso horário (Z ou deslocamento), esse campo será opcional e o padrão será UTC. IMPORTANTE: deve ser um identificador de fuso horário válido da IANA. Valores como ‘EST’, ‘PST’, ‘ISRAEL TIME’ ou outras abreviações NÃO são nomes válidos de fuso horário da IANA. |
attendees | array | Não | Lista de participantes. Cada participante pode ser: (1) Um endereço de e-mail de string (por exemplo, ‘user@example.com’) ou (2) Um objeto com ‘email’ (obrigatório), ‘opcional’ (booleano, padrão falso), ‘displayName’ (string), ‘comment’ (string), ‘additionalGuests’ (inteiro) e ‘resource’ (booleano). Para marcar um participante como opcional (não obrigatório), use o formato do objeto: {‘email’: ‘user@example.com’, ‘optional’: true}. IMPORTANTE: Somente endereços de e-mail válidos são aceitos. Nomes simples não podem ser usados. |
eventType | string (“birthday” | Não | ”focoTempo” |
recurrence | array | Não | Lista de linhas RRULE, EXRULE, RDATE, EXDATE para eventos recorrentes. Frequências suportadas: DIÁRIO, SEMANAL, MENSAL, ANUAL. Para eventos recorrentes, start.timeZone e end.timeZone devem estar presentes. Os valores UNTIL seguem RFC 5545: somente data (AAAAMMDD) para eventos de dia inteiro ou data e hora UTC com sufixo Z (AAAAMMDDTHHMMSSZ) para eventos cronometrados. Valores UNTIL com tempo, mas com sufixo Z ausente, são corrigidos automaticamente. Forneça uma lista vazia para remover a recorrência para que o evento se torne não recorrente. |
visibility | string (“default” | Não | ”privado” |
calendar_id | string | Não | Identificador de calendário. Use ‘primário’ (recomendado) para o calendário principal do usuário. Como alternativa, use um ID de calendário da lista de calendários acessíveis do usuário. Os IDs de agenda se parecem com endereços de e-mail (por exemplo, ‘xyz@group.calendar.google.com’ para agendas compartilhadas). Importante: Endereços de e-mail arbitrários NÃO funcionarão – o calendário deve existir na lista de calendários do usuário com permissões de acesso apropriadas. Use GOOGLECALENDAR_LIST_CALENDARS para recuperar IDs de calendário válidos. |
description | string | Não | Descrição do evento. Pode conter HTML. Opcional. Deve ser omitido para o tipo de evento ‘aniversário’. |
end_datetime | string | Não | Hora de término do evento no formato ISO 8601: AAAA-MM-DDTHH:MM:SS. Quando fornecido, esse parâmetro tem precedência sobre event_duration_hour e event_duration_minutos. Se não for fornecido, o horário de término será calculado usando start_datetime + duração. Deve ser depois de start_datetime. Segundos fracionários e informações de fuso horário serão automaticamente removidos, se fornecidos. Exemplos: ‘2025-01-16T14:30:00’, ‘2025-01-16T14:30’. |
send_updates | string (“all” | Não | ”nenhum”) |
transparency | string (“opaque” | Não | Não |
start_datetime | string | Sim | OBRIGATÓRIO. Hora de início do evento no formato ISO 8601: AAAA-MM-DDTHH:MM:SS. IMPORTANTE: Expressões em linguagem natural como ‘amanhã’, ‘próxima segunda-feira’, ‘14h de amanhã’ NÃO são suportadas e serão rejeitadas. Você deve fornecer a data e hora exatas no formato ISO. Segundos fracionários (por exemplo, 0,000) e informações de fuso horário (Z, +, -) serão automaticamente removidos, se fornecidos. Exemplos: ‘2025-01-16T13:00:00’, ‘2025-01-16T13:00’. |
guestsCanModify | boolean | Não | Se for True, os convidados poderão modificar o evento. |
exclude_organizer | boolean | Não | Se for True, o organizador NÃO será adicionado como participante. O padrão é False (o organizador está incluído). |
birthdayProperties | object | Não | Propriedades para eventos de aniversário. |
create_meeting_room | boolean | Não | O padrão é Verdadeiro. Quando True, para operações CREATE cria um link do Google Meet; para operações UPDATE preserva os dados de conferência existentes, se presentes, ou adiciona um novo link do Meet, se não existir nenhum. As contas do Google Workspace receberão um link do Meet. Contas pessoais do Gmail e outras contas não suportadas retornarão normalmente à criação de um evento sem um link do Meet quando a criação da conferência falhar. Defina como falso para ignorar as operações de link do Meet (não criará novos dados de conferência nem modificará os existentes). O substituto garante que a criação de eventos seja bem-sucedida mesmo quando os recursos de conferência não estiverem disponíveis devido a limitações da conta. |
event_duration_hour | integer | Não | Número de horas para a duração do evento. Suporta eventos de vários dias (por exemplo, 240 horas = 10 dias). Para durações inferiores a 1 hora, use event_duration_minutos. Ignorado se end_datetime for fornecido. |
extended_properties | object | Não | Propriedades estendidas do evento para armazenar metadados customizados. Contém dicionários ‘privados’ (visíveis apenas neste calendário) e/ou ‘compartilhados’ (visíveis para todos os participantes) que mapeiam chaves de string para valores de string. Exemplo: {‘privado’: {‘chave1’: ‘valor1’}, ‘compartilhado’: {‘chave2’: ‘valor2’}} |
focusTimeProperties | object | Não | Propriedades para eventos focusTime. EXIGE uma conta do Google Workspace Enterprise com o recurso Focus Time ativado. |
guestsCanInviteOthers | boolean | Não | Se outros participantes além do organizador podem convidar outras pessoas para o evento. |
outOfOfficeProperties | object | Não | Propriedades para eventos outOfOffice. |
event_duration_minutes | integer | Não | Duração em minutos (SOMENTE 0-59). NUNCA use mais de 60 minutos - em vez disso, use event_duration_hour=1. O valor máximo é 59. A duração combinada (horas + minutos) deve ser maior que 0. Ignorado se end_datetime for fornecido. |
guestsCanSeeOtherGuests | boolean | Não | Se outros participantes além do organizador podem ver quem são os participantes do evento. |
workingLocationProperties | object | Não | Propriedades para eventos WorkingLocation. EXIGE o Google Workspace Enterprise. Restrições descobertas nos testes: - Deve ser definida transparência=‘transparent’ e visibilidade=‘public’ - A descrição deve ser omitida - Dependendo do ‘tipo’, inclua ‘homeOffice’, ‘officeLocation’ ou ‘customLocation’ |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Excluir evento
Seção intitulada “Excluir evento”GOOGLECALENDAR_DELETE_EVENT
Exclui um evento especificado por event_id de um Google Agenda (calendar_id); idempotente – um 404 para um evento já excluído é autônomo. Exclusões em massa podem acionar rateLimitExceeded ou userRateLimitExceeded; limitar a simultaneidade para 5 a 10 solicitações e aplicar espera exponencial.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador exclusivo do evento a ser excluído. Para eventos autônomos, use o ID do evento base (por exemplo, ‘abc123def456’). Para instâncias de eventos recorrentes, use o formato de ID da instância ‘baseEventId_YYYYMMDDTHHMMSSZ’ (por exemplo, ‘abc123def456_20260522T093000Z’), onde o sufixo do carimbo de data/hora representa o horário de início original da instância em UTC. IDs de instância podem ser obtidos na ação EVENTS_INSTANCES. Para excluir TODAS as ocorrências de um evento recorrente, use o ID do evento base sem o sufixo de carimbo de data/hora. Deve ser o identificador interno da API de uma resposta anterior da API. Identificadores visíveis na IU, variantes codificadas em URL ou IDs abreviados são inválidos e causam erros 404/validação. |
calendar_id | string | Não | Identificador do Google Agenda (por exemplo, endereço de e-mail, ID específico ou ‘primário’ da agenda principal do usuário autenticado) do qual o evento será excluído. Calendários somente leitura ou assinados (calendários que não pertencem ao usuário autenticado) retornam 403 nas tentativas de exclusão. |
send_updates | string (“all” | Não | ”nenhum”) |
send_notifications | boolean | Não | Obsoleto. Se deseja enviar notificações sobre a exclusão do evento. Observe que alguns e-mails ainda podem ser enviados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Crie um calendário
Seção intitulada “Crie um calendário”GOOGLECALENDAR_DUPLICATE_CALENDAR
Cria um novo Google Agenda vazio com o título especificado (resumo). Os calendários recém-criados têm como padrão o fuso horário UTC; use GOOGLECALENDAR_PATCH_CALENDAR posteriormente para definir o fuso horário desejado, se necessário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Sim | Título do novo Google Agenda a ser criado. Obrigatório e deve ser uma string não vazia. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obter evento
Seção intitulada “Obter evento”GOOGLECALENDAR_EVENTS_GET
Recupera um evento SINGLE por seu event_id exclusivo (REQUIRED). Esta ação NÃO lista ou pesquisa eventos - ela busca UM evento específico quando você já conhece seu ID. Se você quiser listar eventos dentro de um intervalo de tempo, pesquisar eventos ou filtrar por critérios como time_min/time_max, use GOOGLECALENDAR_EVENTS_LIST.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | OBRIGATÓRIO. O identificador exclusivo do evento específico a ser recuperado. Você já deve conhecer esse ID (por exemplo, de uma chamada EVENTS_LIST anterior ou de uma resposta de criação de evento). Esta ação busca UM evento por ID - ela não pode listar ou pesquisar eventos. Para encontrar eventos por intervalo de tempo ou critérios de pesquisa, use GOOGLECALENDAR_EVENTS_LIST. |
time_zone | string | Não | Fuso horário usado na resposta. Se não for especificado, o fuso horário do calendário será usado. |
calendar_id | string | Não | Identificador do Google Agenda (por exemplo, endereço de e-mail, ID específico ou ‘primário’ da agenda principal do usuário autenticado) do qual recuperar o evento. |
max_attendees | integer | Não | Número máximo de participantes a serem incluídos na resposta. Se houver mais do que o número especificado, apenas o participante será devolvido. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Evento de importação
Seção intitulada “Evento de importação”GOOGLECALENDAR_EVENTS_IMPORT
Ferramenta para importar um evento como cópia privada para um calendário. Use quando precisar adicionar um evento existente a um calendário usando seu iCalUID. Somente eventos com eventType=‘default’ podem ser importados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
end | object | Sim | O horário de término (exclusivo) do evento. Para eventos de dia inteiro, use o campo ‘data’; para eventos cronometrados, use os campos ‘dateTime’ e ‘timeZone’. |
start | object | Sim | A hora de início (inclusive) do evento. Para eventos de dia inteiro, use o campo ‘data’; para eventos cronometrados, use os campos ‘dateTime’ e ‘timeZone’. dateTime deve estar no formato ISO 8601 (por exemplo, '2024-01-15T10:00:00'); timeZone deve corresponder ao fuso horário do calendário para evitar mudanças de horário. |
source | object | Não | Fonte da qual o evento foi criado. |
status | string | Não | Situação do evento. Valores possíveis: ‘confirmado’, ‘provisório’, ‘cancelado’. |
colorId | string | Não | A cor do evento. Este é um ID referente a uma entrada na definição de cores do evento. |
iCalUID | string | Sim | Identificador exclusivo do evento conforme definido em RFC5545. Isso é necessário para identificar o evento que está sendo importado. |
summary | string | Não | Título do evento. |
location | string | Não | Localização geográfica do evento em texto de formato livre. |
sequence | integer | Não | Número de sequência conforme iCalendar. |
attendees | array | Não | Os participantes do evento. |
reminders | object | Não | Informações sobre os lembretes do evento para o usuário autenticado. |
recurrence | array | Não | Lista de linhas RRULE, EXRULE, RDATE e EXDATE para um evento recorrente, conforme especificado em RFC5545. Cada string deve incluir o prefixo completo (por exemplo, 'RRULE:FREQ=WEEKLY;BYDAY=MO'); omitir o prefixo causa um erro 400. |
visibility | string | Não | Visibilidade do evento. Valores possíveis: ‘padrão’, ‘público’, ‘privado’, ‘confidencial’. Padrão: ‘padrão’. |
attachments | array | Não | Anexos de arquivos do evento. |
calendar_id | string | Não | Identificador de calendário. Use ‘principal’ para o calendário principal do usuário conectado ou para o endereço de e-mail do calendário. |
description | string | Não | Descrição do evento. Pode conter HTML. |
transparency | string | Não | Se o evento bloqueia o horário no calendário. Valores possíveis: ‘opaco’ (bloqueia o tempo), ‘transparente’ (não bloqueia o tempo). Padrão: ‘opaco’. |
guestsCanModify | boolean | Não | Se outros participantes além do organizador podem modificar o evento. Padrão: Falso. |
extendedProperties | object | Não | Propriedades estendidas do evento. |
supportsAttachments | boolean | Não | Se a operação de execução do cliente API suporta anexos de eventos. Padrão: Falso. |
conferenceDataVersion | integer | Não | Número de versão dos dados de conferência suportados pelo cliente API. A versão 0 não pressupõe suporte a dados de conferência e ignora os dados de conferência no corpo do evento. A versão 1 permite a cópia de ConferenceData, bem como a criação de novas conferências usando o campo createRequest de ConferenceData. Padrão: 0. |
guestsCanInviteOthers | boolean | Não | Se outros participantes além do organizador podem convidar outras pessoas para o evento. Padrão: Verdadeiro. |
guestsCanSeeOtherGuests | boolean | Não | Se outros participantes além do organizador podem ver quem são os participantes do evento. Padrão: Verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha instâncias de eventos
Seção intitulada “Obtenha instâncias de eventos”GOOGLECALENDAR_EVENTS_INSTANCES
Retorna instâncias do evento recorrente especificado. Use timeMin/timeMax para restringir a janela; omitir limites pode retornar grandes conjuntos de resultados e exige muitas cotas. Em chamadas de alto volume, podem ocorrer 403 rateLimitExceeded ou 429 too_many_requests; aplique espera exponencial (1s, 2s, 4s) antes de tentar novamente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
eventId | string | Sim | OBRIGATÓRIO. O ID do evento recorrente cujas instâncias você deseja recuperar. Você deve primeiro usar GOOGLECALENDAR_FIND_EVENT ou GOOGLECALENDAR_EVENTS_LIST para encontrar eventos recorrentes e obter seus IDs. Esta ação só funciona com eventos recorrentes que possuem uma regra de recorrência. |
timeMax | string | Não | Limite superior (exclusivo) do horário de início de um evento para filtragem. Opcional. O padrão é não filtrar por horário de início. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório. |
timeMin | string | Não | Limite inferior (inclusive) do horário de término de um evento para filtragem. Opcional. O padrão é não filtrar por horário de término. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório. |
timeZone | string | Não | Fuso horário usado na resposta. Opcional. O padrão é o fuso horário do calendário. |
pageToken | string | Não | Token especificando qual página de resultados retornar. Opcional. |
calendarId | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
maxResults | integer | Não | Número máximo de eventos retornados em uma página de resultados. Por padrão, o valor é 250 eventos. O tamanho da página nunca pode ser maior que 2.500 eventos. Opcional. |
showDeleted | boolean | Não | Se devem ser incluídos eventos excluídos (com status igual a “cancelado”) no resultado. Instâncias canceladas de eventos recorrentes ainda serão incluídas se singleEvents for False. Opcional. O padrão é Falso. |
maxAttendees | integer | Não | O número máximo de participantes a serem incluídos na resposta. Se houver mais do que o número especificado de participantes, apenas o participante será devolvido. Opcional. |
originalStart | string | Não | A hora de início original da instância no resultado. Opcional. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar eventos
Seção intitulada “Listar eventos”GOOGLECALENDAR_EVENTS_LIST
Retorna eventos no calendário especificado. AVISO DE FUSO HORÁRIO: Ao usar timeMin/timeMax com carimbos de data e hora UTC (terminando em ‘Z’), a janela de tempo é interpretada em UTC, independentemente do fuso horário do calendário. Por exemplo, consultar ‘2026-01-19T00:00:00Z’ para ‘2026-01-20T00:00:00Z’ em um calendário na América/Los_Angeles (UTC-8) abrange 18/01/2026 às 16h00 até 19/01/2026 às 16h00, horário local, potencialmente faltando eventos na data local pretendida. Para consultar uma data local específica, use carimbos de data/hora com o deslocamento de fuso horário apropriado em timeMin/timeMax (por exemplo, ‘2026-01-19T00:00:00-08:00’ para PST).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Não | Termos de pesquisa de texto livre para encontrar eventos que correspondam a esses termos em vários campos. Opcional. |
iCalUID | string | Não | Especifica um ID de evento no formato iCalendar a ser fornecido na resposta. Opcional. Use isto se quiser procurar um evento pelo seu ID iCalendar. |
orderBy | string | Não | A ordem dos eventos retornados no resultado. Opcional. O padrão é uma ordem estável e não especificada. Os valores aceitáveis são: “startTime”, “updated”. Quando definido como “startTime”, singleEvents deve ser verdadeiro. A ação define automaticamente singleEvents=true quando orderBy=‘startTime’. |
timeMax | string | Não | Limite superior (exclusivo) do horário de início de um evento para filtragem. Opcional. Se não for definido, nenhum limite superior de horário de início será aplicado. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório (por exemplo, 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z). Milissegundos podem ser fornecidos, mas são ignorados. Se timeMin estiver definido, timeMax deverá ser maior que timeMin. AVISO DE FUSO HORÁRIO: Se estiver usando horários UTC (terminando em ‘Z’), mas o calendário estiver em um fuso horário diferente, a janela de horário pode não estar alinhada com as datas do calendário local. Por exemplo, ‘2026-01-19T00:00:00Z’ a ‘2026-01-20T00:00:00Z’ cobre 2026-01-19 16h00 a 2026-01-19 16h00 na América/Los_Angeles (UTC-8). Para consultar uma data local específica, use carimbos de data/hora com o deslocamento de fuso horário local apropriado (por exemplo, ‘2026-01-19T00:00:00-08:00’ para PST). NOTA: Expressões de linguagem natural como ‘hoje’, ‘amanhã’, ‘próxima semana’ NÃO são suportadas. |
timeMin | string | Não | Limite inferior (exclusivo) do horário de término de um evento para filtragem. Opcional. Se não for definido, nenhum limite inferior de horário de término será aplicado. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório (por exemplo, 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z). Milissegundos podem ser fornecidos, mas são ignorados. Se timeMax estiver definido, timeMin deverá ser menor que timeMax. AVISO DE FUSO HORÁRIO: Se estiver usando horários UTC (terminando em ‘Z’), mas o calendário estiver em um fuso horário diferente, a janela de horário pode não estar alinhada com as datas do calendário local. Por exemplo, ‘2026-01-19T00:00:00Z’ a ‘2026-01-20T00:00:00Z’ cobre 2026-01-19 16h00 a 2026-01-19 16h00 na América/Los_Angeles (UTC-8). Para consultar uma data local específica, use carimbos de data/hora com o deslocamento de fuso horário local apropriado (por exemplo, ‘2026-01-19T00:00:00-08:00’ para PST). NOTA: Expressões de linguagem natural como ‘hoje’, ‘amanhã’, ‘próxima semana’ NÃO são suportadas. |
timeZone | string | Não | Fuso horário usado na resposta para formatar horários de eventos. Opcional. Use um identificador de fuso horário da IANA (por exemplo, América/Los_Angeles). O padrão é o fuso horário principal do usuário. Deslocamentos (por exemplo, ‘-03:00’, ‘UTC+0’) e abreviações (por exemplo, ‘IST’, ‘PST’) são inválidos. NOTA: Este parâmetro afeta apenas como os tempos dos eventos são exibidos na resposta. Isso NÃO altera a forma como a filtragem timeMin/timeMax é interpretada. Para consultar uma data local específica, use carimbos de data/hora com o deslocamento de fuso horário apropriado diretamente em timeMin/timeMax (por exemplo, ‘2026-01-19T00:00:00-08:00’). |
pageToken | string | Não | Token de paginação opaco do campo nextPageToken de uma resposta anterior. Deve ser a string exata retornada pela API - não use valores de espaço reservado como ‘NEXT’, ‘next’, ‘1’, ‘2’, etc. Omita este parâmetro inteiramente para a primeira página de resultados. Opcional. |
syncToken | string | Não | Token de nextSyncToken para retornar apenas entradas alteradas desde a última lista. Não pode ser combinado com iCalUID, orderBy, privateExtendedProperty, q, sharedExtendedProperty, timeMin, timeMax ou updateMin. As exclusões desde a lista anterior são sempre incluídas; showDeleted não pode ser falso neste modo. A ação remove automaticamente parâmetros conflitantes quando o syncToken é fornecido. |
calendarId | string | Não | Identificador de calendário. Use “principal” para o calendário principal do usuário ou um ID de calendário da lista de calendários acessíveis do usuário. Endereços de e-mail arbitrários NÃO funcionarão - o calendário deve existir na lista de calendários do usuário. Use GOOGLECALENDAR_LIST_CALENDARS para recuperar IDs de calendário válidos. O padrão é “primário”. Strings vazias serão tratadas como “primárias”. NÃO use IDs internos do Composio, como ConnectedAccountId (que começam com “ca_”) - eles serão automaticamente substituídos por “primary”. |
eventTypes | string | Não | Tipos de eventos a serem retornados. Opcional. Passe apenas um único valor. Se não estiver definido, retorna todos os tipos de eventos. Os valores aceitáveis são: “birthday”, “default”, “focusTime”, “fromGmail”, “outOfOffice”, “workingLocation”. |
maxResults | integer | Não | Número máximo de eventos retornados em uma página de resultados. O número de eventos na página resultante pode ser menor que esse valor ou nenhum, mesmo que haja mais eventos correspondentes à consulta. Páginas incompletas podem ser detectadas por um campo nextPageToken não vazio na resposta. Por padrão, o valor é 250 eventos. O tamanho da página nunca pode ser maior que 2.500 eventos. Opcional. Deve ser >= 1, se fornecido. |
updatedMin | string | Não | Limite inferior para o horário da última modificação de um evento (RFC3339). Quando especificado, as entradas excluídas desde então são sempre incluídas, independentemente de showDeleted. Opcional. |
showDeleted | boolean | Não | Inclui eventos cancelados (status=“cancelled”). Opcional; o padrão é falso. Isso exibe eventos cancelados (excluídos de forma reversível), não itens na Lixeira. Quando syncToken ou updateMin é usado, as exclusões desde esses marcadores são incluídas independentemente de showDeleted. Interação recorrente: se singleEvents=false e showDeleted=false, instâncias canceladas de uma série recorrente ainda poderão ser incluídas; se showDeleted=true e singleEvents=true, apenas instâncias excluídas únicas (não séries pai) serão retornadas. |
maxAttendees | integer | Não | O número máximo de participantes a serem incluídos na resposta. Se houver mais do que o número especificado de participantes, apenas o participante será devolvido. Opcional. Deve ser >= 1, se fornecido. |
singleEvents | boolean | Não | Se deve expandir eventos recorrentes em instâncias e retornar apenas eventos únicos e instâncias de eventos recorrentes. Opcional. O padrão é Falso. |
alwaysIncludeEmail | boolean | Não | Obsoleto e ignorado. |
showHiddenInvitations | boolean | Não | Se incluir convites ocultos no resultado. Opcional. O padrão é Falso. Convites ocultos são eventos em que a entrada do participante tem responseStatus=‘needsAction’ e participantes[].self==true. Quando verdadeiro, esses convites estão incluídos. |
sharedExtendedProperty | string | Não | Restrição de propriedades estendidas especificada como propertyName=value. Corresponde apenas a propriedades compartilhadas. Este parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições fornecidas. |
privateExtendedProperty | string | Não | Restrição de propriedades estendidas especificada como propertyName=value. Corresponde apenas a propriedades privadas. Este parâmetro pode ser repetido várias vezes para retornar eventos que correspondam a todas as restrições fornecidas. |
composio_replaced_calendar_id | string | Não | Campo interno para rastrear se o calendárioId foi substituído |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar eventos de todos os calendários
Seção intitulada “Listar eventos de todos os calendários”GOOGLECALENDAR_EVENTS_LIST_ALL_CALENDARS
Retorna uma lista de eventos unificada em todos os calendários da lista de calendários do usuário para um determinado intervalo de tempo. Use quando precisar de uma visualização única de todos os eventos em vários calendários. Um intervalo de tempo invertido ou incorreto retorna silenciosamente resultados vazios em vez de um erro. Uma lista items vazia significa que nenhum evento corresponde aos filtros – ajuste time_min, time_max ou q antes de concluir que não existe nenhum evento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Não | Termos de pesquisa de texto livre para localizar eventos que correspondam a esses termos em qualquer campo, exceto propriedades estendidas. Opcional. |
time_max | string | Sim | Limite superior (exclusivo) do horário de início de um evento para filtragem. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório (por exemplo, 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z). Se a diferença de fuso horário estiver faltando, UTC (Z) será anexado automaticamente. Obrigatório. |
time_min | string | Sim | Limite inferior (inclusive) do horário de término de um evento para filtragem. Deve ser um carimbo de data/hora RFC3339 com deslocamento de fuso horário obrigatório (por exemplo, 2011-06-03T10:00:00-07:00 ou 2011-06-03T10:00:00Z). Se a diferença de fuso horário estiver faltando, UTC (Z) será anexado automaticamente. Obrigatório. |
event_types | array | Não | Tipos de eventos a serem retornados. Opcional. |
calendar_ids | array | Não | Lista opcional de IDs de calendário específicos a serem consultados. Se não for fornecido, todos os calendários da lista de calendários do usuário serão consultados. |
show_deleted | boolean | Não | Se devem ser incluídos eventos excluídos (com status igual a ‘cancelado’) no resultado. Opcional. O padrão é Falso. |
single_events | boolean | Não | Se deve expandir eventos recorrentes em instâncias e retornar apenas eventos únicos e instâncias de eventos recorrentes. Opcional. O padrão é Verdadeiro. |
response_detail | string (“minimal” | Não | Não |
max_results_per_calendar | integer | Não | Número máximo de eventos retornados por calendário. Opcional. Se não for fornecido, o padrão será o padrão da API (250). Os resultados podem ser paginados; siga nextPageToken na resposta até ausente para recuperar a lista completa de eventos. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Mover Evento
Seção intitulada “Mover Evento”GOOGLECALENDAR_EVENTS_MOVE
Move um evento para outro calendário, ou seja, altera o organizador de um evento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador do evento. Para recuperar identificadores de eventos, chame o método events.list. |
calendar_id | string | Sim | Identificador de calendário do calendário de origem. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
destination | string | Sim | Identificador de calendário do calendário de destino. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
send_updates | string (“all” | Não | ”nenhum”) |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Assistir eventos
Seção intitulada “Assistir eventos”GOOGLECALENDAR_EVENTS_WATCH
Fique atento às alterações nos recursos de eventos. Assistir canais expirarem; persista o canal id por calendarId para restabelecer os monitoramentos após a expiração ou reinicialização.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Um UUID ou sequência exclusiva semelhante que identifica este canal. |
type | string | Não | O tipo de mecanismo de entrega usado para este canal. |
token | string | Não | Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por meio deste canal. Opcional. |
params | object | Não | Parâmetros adicionais que controlam o comportamento do canal de entrega. Opcional. |
address | string | Sim | O endereço onde as notificações são entregues para este canal. Deve ser um URL HTTPS acessível publicamente; URLs http:// ou localhost não receberão notificações. |
payload | boolean | Não | Um valor booliano para indicar se a carga útil é desejada. Opcional. |
calendarId | string | Sim | Identificador de calendário. Para recuperar IDs de calendário, chame o método calendarList.list. Se você deseja acessar o calendário principal do usuário conectado no momento, use a palavra-chave “primary”. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Encontrar evento
Seção intitulada “Encontrar evento”GOOGLECALENDAR_FIND_EVENT
Encontra eventos em um Google Agenda especificado usando consulta de texto, intervalos de tempo (início/fim do evento, última modificação) e tipos de evento. Certifique-se de que timeMin não esteja cronologicamente após timeMax se ambos forem fornecidos. Os resultados podem abranger várias páginas; sempre siga nextPageToken até ausente para evitar eventos perdidos silenciosamente. Valide a correspondência correta dos resultados verificando summary, start.dateTime e organizador.email antes de usar event_id para mutações. Um array items vazio significa que nenhum evento corresponde – amplie os filtros em vez de tratá-lo como um erro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Termos de pesquisa de texto livre para encontrar eventos. Esta consulta é comparada com vários campos do evento, incluindo resumo, descrição, localização, detalhes dos participantes (displayName, email) e detalhes do organizador. Não é possível pesquisar por event_id. Executa correspondência de texto completo (não exata); termos amplos podem retornar eventos não relacionados. Para correspondência baseada em pessoa, prefira participantes[].email em vez de nomes de exibição. Se os resultados parecerem incompletos, use GOOGLECALENDAR_EVENTS_LIST com filtragem do lado do cliente. |
order_by | string | Não | Ordem dos eventos: ‘startTime’ (crescente pela hora de início) ou ‘updated’ (crescente pela hora da última modificação). Nota: ‘startTime’ requer single_events=true. Use ‘atualizado’ se precisar incluir masters recorrentes (por exemplo, séries canceladas). |
time_max | string | Não | Limite superior (exclusivo) do horário de início de um evento para filtragem. Apenas eventos iniciados antes deste horário estão incluídos. Aceita vários formatos: 1. Registro de data e hora RFC3339 (por exemplo, ‘2024-12-06T13:00:00Z’) 2. Partes de data/hora separadas por vírgula (por exemplo, ‘2024,12,06,13,00,00’) 3. String de data e hora simples (por exemplo, ‘2024-12-06 13:00:00’) Defina para o primeiro instante após o período desejado para evitar a perda de eventos de limite, especialmente eventos de dia inteiro (campos somente de data). Intervalos excessivamente amplos expandem muitas instâncias recorrentes, causando grandes cargas e alta latência — restringindo a janela mínima exigida. |
time_min | string | Não | Limite inferior (exclusivo) do horário de término de um evento para filtragem. Somente eventos que terminam após esse horário são incluídos. Aceita vários formatos: 1. Registro de data e hora RFC3339 (por exemplo, ‘2024-12-06T13:00:00Z’) 2. Partes de data/hora separadas por vírgula (por exemplo, ‘2024,12,06,13,00,00’) 3. String de data e hora simples (por exemplo, ‘2024-12-06 13:00:00’) Os carimbos de data/hora RFC3339 devem incluir compensações de fuso horário explícitas; deslocamentos ausentes ou incompatíveis podem excluir silenciosamente eventos correspondentes. Para alinhar com o fuso horário do calendário, recupere-o via GOOGLECALENDAR_GET_CALENDAR. |
page_token | string | Não | Token do nextPageToken de uma resposta anterior para buscar a página de resultados subsequente. Sempre siga cada nextPageToken até ausente; pular a paginação omite silenciosamente eventos em calendários ocupados. |
calendar_id | string | Não | Identificador do Google Agenda a ser consultado. IMPORTANTE: Este deve ser um identificador de calendário válido, NÃO um nome/título de calendário. Os formatos válidos são: ‘principal’ (a agenda principal do usuário autenticado), um endereço de e-mail (por exemplo, ‘usuário@example.com’) ou um ID de agenda (por exemplo, ‘abc123xyz@group.calendar.google.com’). Para encontrar o ID de um calendário nomeado, primeiro use a ação Listar calendários (GOOGLECALENDAR_LIST_CALENDARS) para recuperar todos os calendários disponíveis com seus IDs. ‘primário’ pesquisa apenas o calendário principal do usuário autenticado; para pesquisar todos os calendários, recupere cada ID via GOOGLECALENDAR_LIST_CALENDARS e consulte separadamente. |
event_types | array | Não | Tipos de eventos a serem incluídos. Valores suportados: ‘aniversário’, ‘padrão’, ‘focusTime’, ‘outOfOffice’, ‘workingLocation’. |
max_results | integer | Não | Número máximo de eventos por página (1-2500). |
updated_min | string | Não | Limite inferior (exclusivo) do horário da última modificação de um evento para filtrar. Somente eventos atualizados após esse horário serão incluídos. Quando especificado, os eventos excluídos desde então também são incluídos, independentemente do parâmetro show_deleted. Aceita vários formatos: 1. Registro de data e hora RFC3339 (por exemplo, ‘2024-12-06T13:00:00Z’) 2. Partes de data/hora separadas por vírgula (por exemplo, ‘2024,12,06,13,00,00’) 3. String de data e hora simples (por exemplo, ‘2024-12-06 13:00:00’) |
show_deleted | boolean | Não | Inclui eventos cujo status é ‘cancelado’. Isso mostra eventos cancelados/excluídos, não uma visualização de ‘lixeira’ separada. Comportamento com eventos recorrentes: quando single_events=true, apenas instâncias individuais canceladas são retornadas (o mestre recorrente é omitido); para incluir mestres recorrentes cancelados, defina single_events=false. Se update_min for fornecido, os eventos excluídos desde então serão incluídos independentemente desse sinalizador. |
single_events | boolean | Não | Quando verdadeiro, as séries de eventos recorrentes são expandidas em suas instâncias individuais. Quando falso, apenas os eventos mestres recorrentes são retornados. Nota: Ordenar por ‘startTime’ requer singleEvents=true. Para calendários grandes, é altamente recomendável especificar timeMin e timeMax para limitar a janela de expansão e melhorar o desempenho. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Encontre slots grátis
Seção intitulada “Encontre slots grátis”GOOGLECALENDAR_FIND_FREE_SLOTS
Encontra horários livres e ocupados no Google Agenda para calendários específicos dentro de um intervalo de tempo definido. Se time_min não for fornecido, o padrão é o carimbo de data/hora atual no fuso horário especificado. Se time_max não for fornecido, o padrão será 23:59:59 do dia especificado em time_min (se fornecido), caso contrário, o padrão será 23:59:59 do dia atual no fuso horário especificado. Retorna intervalos ocupados e calcula slots livres encontrando intervalos entre períodos ocupados; time_min deve preceder time_max se ambos forem fornecidos. Esta ação recupera intervalos de tempo livre e ocupado para os calendários especificados durante um determinado período. Ele analisa os intervalos de maior movimento dos calendários e fornece slots livres calculados com base nas lacunas nos períodos de maior movimento. Os slots gratuitos retornados não são filtrados por duração; os chamadores devem filtrar os intervalos para aqueles que contenham totalmente a duração da reunião necessária. Nenhum metadado de evento (títulos, descrições, links) é retornado; use GOOGLECALENDAR_EVENTS_LIST para detalhes do evento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
items | array | Não | Lista de identificadores de calendário para consultar informações de disponibilidade. Passe como uma lista simples de strings, por exemplo, [‘primary’] ou [‘primary’, ‘user@example.com’]. Os valores válidos incluem: ‘principal’ (agenda principal do usuário autenticado), IDs de agenda da lista de agendas do usuário (normalmente terminando em @group.calendar.google.com) ou endereços de e-mail de usuários cujas informações de disponibilidade você deseja consultar. A API FreeBusy retornará informações de erro para quaisquer calendários que não estejam acessíveis ou sejam inválidos na resposta na chave ‘errors’ de cada calendário. Calendários omitidos de items ou inacessíveis são tratados como gratuitos (não desconhecidos), o que pode produzir silenciosamente resultados de disponibilidade incorretos. |
time_max | string | Não | Data e hora de término do intervalo de consulta. Aceita formatos de data e hora ISO, separados por vírgula ou simples. Se fornecido sem um fuso horário explícito, será interpretado no timezone especificado. Se não for fornecido, o padrão é 23:59:59 do dia especificado em time_min (se fornecido), caso contrário, o padrão é 23:59:59 do dia atual no timezone especificado. O intervalo máximo entre time_min e time_max é de aproximadamente 90 dias por limite da API freeBusy do Google Agenda. time_max é exclusivo; para cobrir um dia inteiro, defina time_max como 00:00:00 do dia seguinte no fuso horário de destino em vez de 23:59:59. |
time_min | string | Não | Data e hora de início para o intervalo de consulta. Aceita formatos de data e hora ISO, separados por vírgula ou simples. Se fornecido sem um fuso horário explícito, será interpretado no timezone especificado. Se não for fornecido, o padrão é o carimbo de data/hora atual no timezone especificado para garantir que apenas slots futuros/reserváveis sejam retornados. O intervalo máximo entre time_min e time_max é de aproximadamente 90 dias por limite da API freeBusy do Google Agenda. |
timezone | string | Não | Identificador de fuso horário da IANA (por exemplo, ‘América/Nova_Iorque’, ‘Europa/Londres’, ‘Ásia/Tóquio’). Determina quão ingênuos time_min/time_max são interpretados e o fuso horário usado na resposta para timeMin, timeMax, períodos de ocupação e slots livres calculados. Nota: ‘local’ não é suportado; use um nome de fuso horário específico da IANA. |
group_expansion_max | integer | Não | Máximo de identificadores de calendário a serem retornados para um único grupo. Deve estar entre 1 e 100 (inclusive). Valores superiores a 100 serão rejeitados. |
calendar_expansion_max | integer | Não | Máximo de calendários para os quais as informações de FreeBusy são fornecidas. Deve estar entre 1 e 50 (inclusive). Valores superiores a 50 serão rejeitados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Consultar informações de disponibilidade (obsoleto)
Seção intitulada “Consultar informações de disponibilidade (obsoleto)”GOOGLECALENDAR_FREE_BUSY_QUERY
DEPRECADO: use GOOGLECALENDAR_FIND_FREE_SLOTS (embora esta ferramenta forneça uma cobertura mais ampla de calendário secundário/compartilhado). Retorna apenas intervalos ocupados opacos — sem títulos ou detalhes de eventos; use GOOGLECALENDAR_EVENTS_LIST quando detalhes do evento forem necessários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
items | array | Sim | Lista de calendários e/ou grupos a serem consultados. Aceita strings (por exemplo, [‘primary’, ‘user@example.com’]) ou objetos com um campo ‘id’ (por exemplo, [{‘id’: ‘primary’}]). Os valores de string são convertidos automaticamente para o formato adequado. Somente calendários com pelo menos acesso no nível freeBusyReader são consultados; omitir calendários compartilhados/secundários pode ocultar conflitos reais. Agrupe todos os participantes em uma chamada para evitar erros 403 rateLimitExceeded ou 429 tooManyRequests. |
timeMax | string | Sim | O final do intervalo da consulta formatada conforme RFC3339. Limite exclusivo; deve ser maior que timeMin. Mantenha a janela timeMin–timeMax dentro de aproximadamente 90 dias; extensões maiores podem retornar resultados vazios ou degradados. |
timeMin | string | Sim | O início do intervalo para a consulta formatada conforme RFC3339. Deve ser estritamente menor que timeMax. Para janelas de dia inteiro, use 00:00 local no fuso horário de destino para evitar erros de horário de verão/off-by-one. |
timeZone | string | Não | Fuso horário usado na resposta. Opcional. O padrão é UTC. O padrão é UTC, que distorce a análise do horário de trabalho para usuários em outros fusos horários; sempre forneça um fuso horário IANA válido (por exemplo, ‘América/Nova_Iorque’). |
groupExpansionMax | integer | Não | Número máximo de identificadores de calendário a serem fornecidos para um único grupo. Opcional. Um erro é retornado para um grupo com mais membros que esse valor. O valor máximo é 100. |
calendarExpansionMax | integer | Não | Número máximo de calendários para os quais as informações de FreeBusy devem ser fornecidas. Opcional. O valor máximo é 50. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha o Google Agenda
Seção intitulada “Obtenha o Google Agenda”GOOGLECALENDAR_GET_CALENDAR
Recupera um Google Agenda específico, identificado por calendar_id, ao qual o usuário autenticado tem acesso. A resposta inclui timeZone (formato IANA, por exemplo, ‘América/Los_Angeles’) — use-o diretamente ao construir timeMin/timeMax em outras ferramentas para evitar erros de horário de verão. Uma lista defaultReminders vazia é válida (nenhum padrão configurado). accessRole insuficiente pode omitir campos como defaultReminders e colorId.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
calendar_id | string | Não | Identificador do Google Agenda a ser recuperado. Deve ser ‘primário’ (o padrão) para a agenda principal do usuário ou um identificador semelhante a e-mail (por exemplo, ‘usuário@exemplo.com’ ou ‘en.usa#holiday@group.v.calendar.google.com’). IMPORTANTE: Os nomes/títulos de exibição do calendário (por exemplo, ‘Trabalho’, ‘Férias’) NÃO são identificadores válidos e resultarão em erros. Para encontrar o ID de um calendário, use a ação LIST_CALENDARS que retorna o campo ‘id’ para cada calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obter perfil do calendário (obsoleto)
Seção intitulada “Obter perfil do calendário (obsoleto)”GOOGLECALENDAR_GET_CALENDAR_PROFILE
DEPRECADO: Use CalendarListGet em vez disso. Ferramenta para recuperar o perfil de calendário principal do usuário autenticado. Use quando precisar obter informações sobre o calendário principal do usuário, incluindo fuso horário, configurações e preferências.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obtenha data e hora atuais
Seção intitulada “Obtenha data e hora atuais”GOOGLECALENDAR_GET_CURRENT_DATE_TIME
Obtém a data e a hora atuais, permitindo um deslocamento de fuso horário específico. Chame esta ferramenta antes de calcular datas relativas (por exemplo, ‘amanhã’, ‘próxima segunda-feira’) para evitar erros de um dia entre fusos horários.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
timezone | string | Não | Especificação de fuso horário. Aceita: (1) identificador de fuso horário IANA (por exemplo, ‘América/Nova_York’, ‘Ásia/Kolkata’, ‘Europa/Londres’) - RECOMENDADO, (2) Abreviações de fuso horário comuns (por exemplo, ‘PST’, ‘EST’, ‘CST’, ‘GMT’, ‘UTC’) - serão convertidos automaticamente para IANA ou (3) deslocamento UTC numérico em horas (por exemplo, -5, 5,5). Use valores positivos para leste do UTC e negativos para oeste. O padrão 0 é UTC. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar edifícios
Seção intitulada “Listar edifícios”GOOGLECALENDAR_LIST_BUILDINGS
Lista todos os edifícios de uma conta de cliente do Google Workspace com detalhes completos, incluindo endereços, coordenadas e nomes de andares. Use esta ação quando precisar recuperar a lista completa de locais de edifícios físicos configurados nos recursos do Google Workspace Agenda. Isso é útil para administradores de espaço de trabalho que gerenciam salas de conferência e agendamento de recursos em vários edifícios de escritórios. Requer privilégios de administrador do Google Workspace com acesso à API Directory.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
customer | string | Não | O ID exclusivo da conta do Google Workspace do cliente. Use o alias ‘my_customer’ para representar o ID de cliente da sua conta. Como administrador de conta, esse alias representa o ID de cliente da sua conta. |
pageToken | string | Não | Token para especificar a próxima página na lista. Obtido de nextPageToken em uma resposta anterior. Omitir na primeira página. |
maxResults | integer | Não | Número máximo de edifícios a serem retornados por página. O padrão é 25 para desempenho ideal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar recursos do calendário
Seção intitulada “Listar recursos do calendário”GOOGLECALENDAR_LIST_CALENDAR_RESOURCES
Recupera recursos da agenda (como salas de conferência) de um domínio do Google Workspace usando a API Admin SDK Directory. Use esta ação quando precisar listar salas de reuniões, espaços de conferência ou outros recursos de calendário disponíveis em uma organização. A ação oferece suporte à filtragem por categoria de recurso, capacidade, localização do edifício e outros critérios. IMPORTANTE: isso requer acesso à API Admin SDK Directory e permissões de administrador apropriadas. NÃO está disponível para contas pessoais do Gmail, apenas para domínios do Google Workspace.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta de pesquisa para filtrar recursos do calendário. Cada cláusula é ‘valor do operador de campo’. Operadores suportados: ’=’ (correspondência exata), ’!=’ (incompatibilidade), ’:’ (correspondência de prefixo/HAS — para correspondência de prefixo, siga o valor com ’*’). Operadores lógicos suportados: AND, NOT (nessa ordem de precedência). IMPORTANTE: operadores de comparação numérica (>, <, >=, <=) NÃO são suportados pela API Google Admin Directory para este endpoint e causarão uma solicitação incorreta de 400 — ‘capacidade’ só pode ser filtrada por igualdade exata (por exemplo, ‘capacidade=10’). Campos suportados: generateResourceName, nome, buildingId, floor_name, capacidade, featureInstances.feature.name, resourceEmail, resourceCategory. |
orderBy | string | Não | Especifica a ordem de classificação dos resultados. Use nomes de campos como ‘resourceId’, ‘resourceName’, ‘capacity’, ‘buildingId’, ‘floorName’ opcionalmente seguidos de ‘desc’ para ordem decrescente. Vários campos podem ser separados por vírgulas (por exemplo, ‘buildingId,capacidade desc’). |
customer | string | Não | O ID exclusivo da conta do Google Workspace do cliente. Use ‘my_customer’ como alias para o ID do cliente da conta. |
pageToken | string | Não | Token para recuperar páginas subsequentes em resultados paginados. Use o nextPageToken de uma resposta anterior. |
maxResults | integer | Não | Número máximo de resultados a serem retornados por página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar calendários do Google
Seção intitulada “Listar calendários do Google”GOOGLECALENDAR_LIST_CALENDARS
Recupera calendários da lista do Google Agenda do usuário, com opções de paginação e filtragem. Percorra todas as páginas usando nextPageToken até ausentar-se para evitar a perda de calendários. Use o sinalizador primário e o campo accessRole da resposta para identificar calendários – os nomes de exibição não são valores calendário_id válidos. O acesso de leitura (listagem) não implica escopos OAuth de gravação.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_token | string | Não | Token para a página de resultados retornar, de uma resposta anterior. |
sync_token | string | Não | Token de sincronização de uma solicitação de lista anterior para obter apenas entradas alteradas; showDeleted, showHidden e pageToken serão ignorados se fornecidos. Também ignora minAccessRole. Uma resposta HTTP 410 Gone significa que o token expirou; execute uma ressincronização completa omitindo sync_token. |
max_results | integer | Não | Número máximo de calendários a serem retornados por página. Máximo 250. |
show_hidden | boolean | Não | Inclui calendários que normalmente não são mostrados na IU. |
show_deleted | boolean | Não | Incluir calendários excluídos no resultado. |
min_access_role | string | Não | Função de acesso mínimo para calendários retornada. Os valores válidos são ‘freeBusyReader’, ‘owner’, ‘reader’, ‘writer’. Os calendários freeBusyReader expõem apenas slots de livre/ocupado — nenhum detalhe do evento e as gravações falham com 403. Omita esse filtro para incluir calendários somente leitura. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Listar configurações de calendário (obsoleto)
Seção intitulada “Listar configurações de calendário (obsoleto)”GOOGLECALENDAR_LIST_SETTINGS
DEPRECADO: use GOOGLECALENDAR_SETTINGS_LIST. Ferramenta para retornar todas as configurações do usuário autenticado. Use quando precisar recuperar as configurações do calendário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pageToken | string | Não | Token para paginação para recuperar páginas de resultados subsequentes |
maxResults | integer | Não | Número máximo de configurações a serem retornadas |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Calendário de patches
Seção intitulada “Calendário de patches”GOOGLECALENDAR_PATCH_CALENDAR
Atualiza parcialmente (PATCHes) um Google Agenda existente, modificando apenas os campos fornecidos. Pelo menos um resumo, descrição, local ou fuso horário deve ser fornecido. Strings vazias para description ou location limpam-nas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Não | Novo título para o calendário; não pode ser uma string vazia quando fornecida. Pelo menos um resumo, descrição, local ou fuso horário deve ser fornecido. |
location | string | Não | Nova localização geográfica do calendário (por exemplo, ‘Paris, França’). |
timezone | string | Não | Novo nome do banco de dados de fuso horário da IANA para o calendário (por exemplo, ‘Europa/Zurique’, ‘América/Nova_Iorque’). Calendários duplicados via GOOGLECALENDAR_DUPLICATE_CALENDAR podem ter como padrão UTC; defina o fuso horário correto explicitamente após a duplicação. |
calendar_id | string | Sim | O identificador exclusivo do Google Agenda a ser atualizado. Use ‘principal’ para a agenda principal ou o ID exclusivo de uma agenda (geralmente em formato de e-mail, como ‘abc123@group.calendar.google.com’). IMPORTANTE: Este NÃO é o nome/título de exibição do calendário - use GOOGLECALENDAR_LIST_CALENDARS para encontrar o campo ‘id’ de um calendário. |
description | string | Não | Nova descrição para o calendário. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Evento de correção
Seção intitulada “Evento de correção”GOOGLECALENDAR_PATCH_EVENT
Atualizar campos especificados de um evento existente em um Google Agenda usando semântica de patch (campos de matriz como attendees são totalmente substituídos, se fornecidos); certifique-se de que calendar_id e event_id sejam válidos e que o usuário tenha acesso de gravação ao calendário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
source | object | Não | Modelo de entrada para origem do evento. |
status | string (“confirmed” | Não | ”cancelado”) |
summary | string | Não | Novo título para o evento. |
color_id | string | Não | ID da cor do evento (1-11). Use GOOGLECALENDAR_COLORS_GET para recuperar as cores disponíveis. |
end_time | string | Não | Novo horário de término (carimbo de data/hora RFC3339, por exemplo, ‘2024-07-01T11:00:00-07:00’). Usa timezone se fornecido, caso contrário, UTC. Para eventos de dia inteiro, use o formato AAAA-MM-DD (data de término exclusiva). Opcional ao atualizar start_time - a duração original do evento será preservada se end_time não for especificado. Deve ser estritamente após start_time; formatos incompatíveis ou mistos causam HTTP 400 timeRangeEmpty. |
event_id | string | Sim | O identificador técnico exclusivo do evento a ser atualizado. IMPORTANTE: Este NÃO é o título/nome do evento. IDs de evento são strings opacas normalmente codificadas em base32hex (5-1024 caracteres usando a-v minúsculo e dígitos 0-9). Para instâncias de eventos recorrentes, o formato do ID é ‘baseEventId_YYYYMMDDTHHMMSSZ’ com um separador de sublinhado (por exemplo, ‘abc123def456_20260115T100000Z’). Para obter um ID de evento, primeiro use GOOGLECALENDAR_FIND_EVENT ou GOOGLECALENDAR_EVENTS_LIST para pesquisar eventos e recuperar seus IDs. Use o ID do evento mestre para atualizar toda a série recorrente; use o ID da instância para atualizar apenas essa ocorrência – confirme o escopo antes de aplicar o patch. |
location | string | Não | Nova localização geográfica (endereço físico ou link de reunião virtual). |
sequence | integer | Não | Número de sequência de acordo com a especificação do iCalendar. Incrementado em cada atualização de evento. |
timezone | string | Não | Nome do banco de dados de fuso horário da IANA para horários de início/término (por exemplo, ‘América/Los_Angeles’). Usado se start_time e end_time forem fornecidos e não datas de dia inteiro; o padrão é UTC se não estiver definido. Fuso horário incompatível ou ausente com carimbos de data e hora deslocados muda silenciosamente o evento para a hora do relógio de parede não intencional. |
attendees | array | Não | Lista de endereços de e-mail válidos para os participantes (por exemplo, ‘user@example.com’). Substitui os participantes existentes. Forneça uma lista vazia para remover tudo. |
reminders | object | Não | Modelo de entrada para lembretes. |
recurrence | array | Não | Linhas RRULE, EXRULE, RDATE e EXDATE por RFC5545 para eventos recorrentes. Substitui as regras de recorrência existentes, se fornecidas. |
start_time | string | Não | Nova hora de início (carimbo de data/hora RFC3339, por exemplo, ‘2024-07-01T10:00:00-07:00’). Usa timezone se fornecido, caso contrário, UTC. Para eventos de dia inteiro, use o formato AAAA-MM-DD. Quando apenas start_time é fornecido sem end_time, a duração original do evento é preservada automaticamente. |
visibility | string (“default” | Não | ”privado” |
attachments | array | Não | Anexos de arquivo (máximo 25). Cada um com ‘fileUrl’ (obrigatório) e ‘title’ opcional, ‘mimeType’. Requer supportAttachments=true. |
calendar_id | string | Sim | Identificador do calendário. Use ‘principal’ para o calendário principal do usuário conectado. Para encontrar outros IDs de calendário, use o método calendarList.list. Deve ser fornecido no formato Snake_case. |
description | string | Não | Nova descrição do evento; pode incluir HTML. |
send_updates | string (“all” | Não | ”nenhum”) |
transparency | string (“opaque” | Não | Não |
max_attendees | integer | Não | Máximo de participantes em resposta; não afeta a contagem de convidados. Se for mais, a resposta inclui apenas o organizador. Deve ser positivo. |
rsvp_response | string (“needsAction” | Não | ”tentativa” |
conference_data | object | Não | Modelo de entrada para dados de conferência. |
attendees_omitted | boolean | Não | Se os participantes podem ter sido omitidos da representação do evento. |
guests_can_modify | boolean | Não | Se outros participantes além do organizador podem modificar o evento (padrão: falso). |
anyone_can_add_self | boolean | Não | Se alguém pode se convidar para o evento (padrão: falso). |
extended_properties | object | Não | Modelo de entrada para propriedades estendidas. |
supports_attachments | boolean | Não | O aplicativo cliente oferece suporte a anexos de eventos. Defina como True se for o caso. |
focus_time_properties | object | Não | Modelo de entrada para propriedades de tempo de foco. |
conference_data_version | integer | Não | Versão de suporte a dados de conferência do cliente API. Defina como 1 para gerenciar detalhes da conferência (por exemplo, links do Google Meet); 0 (padrão) ignora os dados da conferência. Definir como 1 permite a leitura/preservação de dados da conferência, mas não gera um novo link do Meet. Use GOOGLECALENDAR_UPDATE_EVENT com create_meeting_room=true para criar um. |
guests_can_invite_others | boolean | Não | Se outros participantes além do organizador podem convidar outras pessoas (padrão: verdadeiro). |
out_of_office_properties | object | Não | Modelo de entrada para propriedades fora do escritório. |
guests_can_see_other_guests | boolean | Não | Se os participantes podem ver quem são os participantes do evento (padrão: verdadeiro). |
working_location_properties | object | Não | Modelo de entrada para propriedades do local de trabalho. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Evento de adição rápida
Seção intitulada “Evento de adição rápida”GOOGLECALENDAR_QUICK_ADD
Analisa texto em linguagem natural para criar rapidamente um evento básico do Google Agenda com título, data e hora, adequado para agendamento simples; não suporta adição direta de participantes ou eventos recorrentes, e calendar_id deve ser válido, se não for ‘primário’.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
text | string | Não | Entrada em linguagem natural descrevendo o evento; O Google Agenda analisa detalhes do evento, como título, data e hora. |
calendar_id | string | Não | Identificador do calendário do evento. Use ‘principal’ para o calendário principal ou forneça um ID de calendário específico (por exemplo, endereço de e-mail). |
send_updates | string (“all” | Não | ”nenhum”) |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Remover participante do evento
Seção intitulada “Remover participante do evento”GOOGLECALENDAR_REMOVE_ATTENDEE
Remove um participante de um evento específico em um Google Agenda; o calendário e o evento devem existir. Chamadas simultâneas no mesmo evento podem substituir as listas de participantes – aplique as alterações sequencialmente por evento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event_id | string | Sim | Identificador exclusivo do evento. Para eventos recorrentes, direcione o ID da série mestre ou um ID de instância específico; remover um participante de uma instância não afeta outras instâncias da série. |
calendar_id | string | Não | Identificador do Google Calendar ao qual pertence o evento; ‘primário’ significa o calendário principal do usuário. |
attendee_email | string | Sim | Endereço de e-mail do participante a ser removido. Deve corresponder ao e-mail de um participante presente no evento. Se nenhuma correspondência for encontrada, o participante já foi removido ou nunca esteve no evento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Obter configuração de calendário
Seção intitulada “Obter configuração de calendário”GOOGLECALENDAR_SETTINGS_GET
Ferramenta para retornar uma configuração de usuário único para o usuário autenticado. Use quando precisar recuperar um valor específico de configuração de calendário.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
setting | string | Sim | O identificador da configuração do usuário a ser recuperada. Os valores válidos incluem: autoAddHangouts, dateFieldOrder, defaultEventLength, format24HourTime, hideInvitations, hideWeekends, locale, lembreteOnRespondedEventsOnly, showDeclinedEvents, fuso horário, useKeyboardShortcuts, weekStart |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Configurações de lista
Seção intitulada “Configurações de lista”GOOGLECALENDAR_SETTINGS_LIST
Retorna todas as configurações do usuário autenticado. Os resultados incluem múltiplas configurações digitadas por id (por exemplo, timeZone); localize uma configuração específica por seu campo id. Os valores timeZone são identificadores IANA (por exemplo, America/New_York) — usados diretamente na lógica de data e hora e de eventos; alinhe-se com timeZone do GOOGLECALENDAR_GET_CALENDAR para tempos de notificação consistentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pageToken | string | Não | Token especificando qual página de resultados retornar. |
syncToken | string | Não | Token obtido do campo nextSyncToken retornado na última página de resultados da solicitação de lista anterior. Faz com que o resultado desta solicitação de lista contenha apenas entradas que foram alteradas desde então. Se o syncToken expirar, o servidor responderá com um código de resposta 410 GONE e o cliente deverá limpar seu armazenamento e realizar uma sincronização completa sem qualquer syncToken. |
maxResults | integer | Não | Número máximo de entradas retornadas em uma página de resultados. Por padrão, o valor é 100 entradas. O tamanho da página nunca pode ser maior que 250 entradas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Configurações do relógio
Seção intitulada “Configurações do relógio”GOOGLECALENDAR_SETTINGS_WATCH
Fique atento às alterações nos recursos de configurações.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Um UUID ou sequência exclusiva semelhante que identifica este canal. |
type | string | Sim | O tipo de mecanismo de entrega usado para este canal. Deve ser “web_hook”. |
token | string | Não | Uma string arbitrária entregue ao endereço de destino com cada notificação entregue por meio deste canal. |
params | object | Não | Parâmetros adicionais que controlam o comportamento do canal de entrega. |
address | string | Sim | O endereço onde as notificações são entregues para este canal. |
expiration | integer | Não | Timestamp Unix em milissegundos especificando quando a API deve parar de enviar notificações para este canal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Sincronizar eventos (obsoleto)
Seção intitulada “Sincronizar eventos (obsoleto)”GOOGLECALENDAR_SYNC_EVENTS
DEPRECADO: use GOOGLECALENDAR_EVENTS_LIST. EventsList já lida com syncToken com remoção automática de parâmetros. Sincroniza eventos do Google Agenda, realizando uma sincronização completa se nenhum sync_token for fornecido ou se um erro 410 GONE (devido a um token expirado) exigir isso, caso contrário, executa uma sincronização incremental para eventos alterados desde que o sync_token foi emitido.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
pageToken | string | Não | Token para paginação de resultados, de nextPageToken de uma resposta anterior. Repita com cada nextPageToken retornado até que nenhum nextPageToken seja retornado; parar cedo omite silenciosamente os eventos restantes. |
sync_token | string | Não | Token para sincronização incremental, recuperando apenas as alterações desde a emissão. Uma resposta 410 GONE indica um token expirado, exigindo uma sincronização completa. Não pode ser combinado com timeMin, timeMax, orderBy, query ou updatedMin; misturá-los faz com que a solicitação falhe. |
calendar_id | string | Não | Identificador do Google Agenda; ‘primário’ refere-se ao calendário principal do usuário autenticado. |
event_types | array | Não | Filtra eventos por tipos especificados (por exemplo, ‘default’, ‘focusTime’, ‘outOfOffice’, ‘workingLocation’). Todos os tipos retornados se omitidos. |
max_results | integer | Não | Máximo de eventos por página (máximo 2.500); O padrão do Google Agenda é usado se não for especificado. |
single_events | boolean | Não | Se True, expande eventos recorrentes em instâncias individuais (excluindo evento mestre); caso contrário, aplicar-se-á o tratamento padrão do Google. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Atualizar evento do Google
Seção intitulada “Atualizar evento do Google”GOOGLECALENDAR_UPDATE_EVENT
Atualiza um evento existente no Google Agenda. REQUER event_id - você DEVE primeiro pesquisar o evento usando GOOGLECALENDAR_FIND_EVENT ou GOOGLECALENDAR_EVENTS_LIST para obter o event_id. Esta é uma substituição completa do PUT: os campos omitidos (incluindo participantes, lembretes, recorrência, conferência) são apagados. Sempre forneça o estado completo do evento desejado. Use GOOGLECALENDAR_PATCH_EVENT para edições parciais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
summary | string | Não | Resumo (título) do evento. |
event_id | string | Sim | OBRIGATÓRIO. O identificador exclusivo do evento a ser atualizado. Este parâmetro é OBRIGATÓRIO - os eventos não podem ser atualizados por título, data ou outros critérios. Você DEVE primeiro recuperar o event_id usando GOOGLECALENDAR_FIND_EVENT ou GOOGLECALENDAR_EVENTS_LIST para pesquisar o evento e, em seguida, usar o campo ‘id’ retornado aqui. |
location | string | Não | Localização geográfica do evento em texto de formato livre. |
timezone | string | Não | Nome do fuso horário IANA do banco de dados de fuso horário (por exemplo, ‘América/Nova_Iorque’, ‘Europa/Londres’, ‘Ásia/Jerusalém’, ‘UTC’). Obrigatório se datetime for ingênuo. Para eventos recorrentes, o início e o fim devem incluir um fuso horário. Se não for fornecido, o UTC será usado. Se datetime incluir informações de fuso horário (Z ou deslocamento), esse campo será opcional e o padrão será UTC. IMPORTANTE: deve ser um identificador de fuso horário válido da IANA. Valores como ‘EST’, ‘PST’, ‘ISRAEL TIME’ ou outras abreviações NÃO são nomes válidos de fuso horário da IANA. |
attendees | array | Não | Lista de participantes. Cada participante pode ser: (1) Um endereço de e-mail de string (por exemplo, ‘user@example.com’) ou (2) Um objeto com ‘email’ (obrigatório), ‘opcional’ (booleano, padrão falso), ‘displayName’ (string), ‘comment’ (string), ‘additionalGuests’ (inteiro) e ‘resource’ (booleano). Para marcar um participante como opcional (não obrigatório), use o formato do objeto: {‘email’: ‘user@example.com’, ‘optional’: true}. IMPORTANTE: Somente endereços de e-mail válidos são aceitos. Nomes simples não podem ser usados. |
eventType | string (“birthday” | Não | ”focoTempo” |
recurrence | array | Não | Lista de linhas RRULE, EXRULE, RDATE, EXDATE para eventos recorrentes. Frequências suportadas: DIÁRIO, SEMANAL, MENSAL, ANUAL. Para eventos recorrentes, start.timeZone e end.timeZone devem estar presentes. Os valores UNTIL seguem RFC 5545: somente data (AAAAMMDD) para eventos de dia inteiro ou data e hora UTC com sufixo Z (AAAAMMDDTHHMMSSZ) para eventos cronometrados. Valores UNTIL com tempo, mas com sufixo Z ausente, são corrigidos automaticamente. Forneça uma lista vazia para remover a recorrência para que o evento se torne não recorrente. |
visibility | string (“default” | Não | ”privado” |
calendar_id | string | Não | Identificador do Google Agenda onde reside o evento. O valor ‘principal’ tem como alvo o calendário principal do usuário. |
description | string | Não | Descrição do evento. Pode conter HTML. Opcional. Deve ser omitido para o tipo de evento ‘aniversário’. |
end_datetime | string | Não | Hora de término do evento no formato ISO 8601: AAAA-MM-DDTHH:MM:SS. Quando fornecido, esse parâmetro tem precedência sobre event_duration_hour e event_duration_minutos. Se não for fornecido, o horário de término será calculado usando start_datetime + duração. Deve ser depois de start_datetime. Segundos fracionários e informações de fuso horário serão automaticamente removidos, se fornecidos. Exemplos: ‘2025-01-16T14:30:00’, ‘2025-01-16T14:30’. |
send_updates | string (“all” | Não | ”nenhum”) |
transparency | string (“opaque” | Não | Não |
start_datetime | string | Sim | OBRIGATÓRIO. Hora de início do evento no formato ISO 8601: AAAA-MM-DDTHH:MM:SS. IMPORTANTE: Expressões em linguagem natural como ‘amanhã’, ‘próxima segunda-feira’, ‘14h de amanhã’ NÃO são suportadas e serão rejeitadas. Você deve fornecer a data e hora exatas no formato ISO. Segundos fracionários (por exemplo, 0,000) e informações de fuso horário (Z, +, -) serão automaticamente removidos, se fornecidos. Exemplos: ‘2025-01-16T13:00:00’, ‘2025-01-16T13:00’. |
guestsCanModify | boolean | Não | Se for True, os convidados poderão modificar o evento. |
birthdayProperties | object | Não | Propriedades para eventos de aniversário. |
create_meeting_room | boolean | Não | O padrão é Verdadeiro. Quando True, para operações CREATE cria um link do Google Meet; para operações UPDATE preserva os dados de conferência existentes, se presentes, ou adiciona um novo link do Meet, se não existir nenhum. As contas do Google Workspace receberão um link do Meet. Contas pessoais do Gmail e outras contas não suportadas retornarão normalmente à criação de um evento sem um link do Meet quando a criação da conferência falhar. Defina como falso para ignorar as operações de link do Meet (não criará novos dados de conferência nem modificará os existentes). O substituto garante que a criação de eventos seja bem-sucedida mesmo quando os recursos de conferência não estiverem disponíveis devido a limitações da conta. |
event_duration_hour | integer | Não | Número de horas para a duração do evento. Suporta eventos de vários dias (por exemplo, 240 horas = 10 dias). Para durações inferiores a 1 hora, use event_duration_minutos. Ignorado se end_datetime for fornecido. |
extended_properties | object | Não | Propriedades estendidas do evento para armazenar metadados customizados. Contém dicionários ‘privados’ (visíveis apenas neste calendário) e/ou ‘compartilhados’ (visíveis para todos os participantes) que mapeiam chaves de string para valores de string. Exemplo: {‘privado’: {‘chave1’: ‘valor1’}, ‘compartilhado’: {‘chave2’: ‘valor2’}} |
focusTimeProperties | object | Não | Propriedades para eventos focusTime. EXIGE uma conta do Google Workspace Enterprise com o recurso Focus Time ativado. |
guestsCanInviteOthers | boolean | Não | Se outros participantes além do organizador podem convidar outras pessoas para o evento. |
outOfOfficeProperties | object | Não | Propriedades para eventos outOfOffice. |
event_duration_minutes | integer | Não | Duração em minutos (SOMENTE 0-59). NUNCA use mais de 60 minutos - em vez disso, use event_duration_hour=1. O valor máximo é 59. A duração combinada (horas + minutos) deve ser maior que 0. Ignorado se end_datetime for fornecido. |
guestsCanSeeOtherGuests | boolean | Não | Se outros participantes além do organizador podem ver quem são os participantes do evento. |
workingLocationProperties | object | Não | Propriedades para eventos WorkingLocation. EXIGE o Google Workspace Enterprise. Restrições descobertas nos testes: - Deve ser definida transparência=‘transparent’ e visibilidade=‘public’ - A descrição deve ser omitida - Dependendo do ‘tipo’, inclua ‘homeOffice’, ‘officeLocation’ ou ‘customLocation’ |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados da execução da ação |
error | string | Não | Erro, se algum ocorreu durante a execução da ação |
successful | boolean | Sim | Se a execução da ação foi bem-sucedida ou não |
Gatilhos disponíveis
Seção intitulada “Gatilhos disponíveis”Resposta do participante alterada
Seção intitulada “Resposta do participante alterada”GOOGLECALENDAR_ATTENDEE_RESPONSE_CHANGED_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Evento cancelado ou excluído
Seção intitulada “Evento cancelado ou excluído”GOOGLECALENDAR_EVENT_CANCELED_DELETED_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Evento começando em breve
Seção intitulada “Evento começando em breve”GOOGLECALENDAR_EVENT_STARTING_SOON_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Alterações em eventos do calendário
Seção intitulada “Alterações em eventos do calendário”GOOGLECALENDAR_GOOGLE_CALENDAR_EVENT_CHANGE_TRIGGER
Tipo: webhook
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Evento criado
Seção intitulada “Evento criado”GOOGLECALENDAR_GOOGLE_CALENDAR_EVENT_CREATED_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Sincronização de eventos do calendário
Seção intitulada “Sincronização de eventos do calendário”GOOGLECALENDAR_GOOGLE_CALENDAR_EVENT_SYNC_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|
Evento atualizado
Seção intitulada “Evento atualizado”GOOGLECALENDAR_GOOGLE_CALENDAR_EVENT_UPDATED_TRIGGER
Tipo: enquete
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|
| Nome | Tipo | Obrigatório | Descrição |
|---|