Criar interfaces do Google Agenda

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Google Workspace Os complementos podem fornecer interfaces personalizadas quando o usuário está visualizando ou editando agendas e eventos do Agenda. Isso permite que você forneça ao usuário mais informações relevantes, automatize tarefas e conecte sistemas de terceiros ao Google Agenda.

Ao criar uma interface de complemento para o Google Agenda, você pode fornecer uma página inicial. Você pode usar a mesma página inicial para vários hosts ou criar um específico para o Google Agenda.

Seu complemento também pode definir uma interface que aparece quando o usuário tem um evento do Agenda aberto.

Como acessar a IU do complemento

Dependendo da forma como ele é aberto, um Google Workspace Complemento pode definir uma interface de página inicial, uma interface de evento do Agenda, uma interface de seleção de anexos ou todas as três opções:

  • Se um usuário clicar no ícone do complemento em uma visualização da agenda, ele executará a função calendar.homepageTrigger correspondente (se presente). Essa função cria e retorna um card da página inicial para o Google Agenda para exibição. Se nenhuma função calendar.homepageTrigger for definida, um card genérico da página inicial será exibido.
  • Quando o usuário abre um evento do Agenda e clica no ícone do complemento ou ele abre o evento, o complemento executa a função eventOpenTrigger correspondente (se presente). Essa função cria a interface de eventos do Agenda do complemento e retorna ao Google Agenda para exibição.
  • Se o complemento definir uma função eventAttachmentTrigger, ele aparecerá como um provedor de anexos quando o usuário clicar em Adicionar anexo ao editar um evento do Agenda. Quando o complemento é selecionado, a função eventAttachmentTrigger cria a interface de seleção de anexos do complemento e a retorna ao Google Agenda para exibição.

Criar a interface do Agenda de complementos

Para estender o Google Agenda com um Google Workspace complemento, siga estas etapas:

  1. Decida se você quer que seu complemento tenha uma página inicial específica do Agenda. Decida também se você quer fornecer uma interface personalizada enquanto o usuário estiver editando eventos do Agenda.
  2. Adicione os campos addOns.common e addOns.calendar adequados ao manifesto do projeto de script de complementos, incluindo todos os escopos necessários.
  3. Se você estiver fornecendo uma página inicial específica do Agenda, implemente a função calendar.homepageTrigger para criar essa interface. Também é possível usar a interface common.homepageTrigger para vários Google Workspace hosts.
  4. Se você estiver fornecendo uma interface de eventos do Agenda, implemente uma função calendar.eventOpenTrigger para criar essa interface. Veja mais detalhes em Estender a interface do evento do Agenda.
  5. Implemente as funções de callback associadas para responder às interações da IU do usuário, como cliques em botões.

Páginas iniciais do Agenda

O Google Agenda é compatível com a exibição de Google Workspace páginas iniciais complementares. Para mostrar a página inicial comum dos seus complementos no Google Agenda, verifique se há um campo addOns.calendar no manifesto do complemento.

Como alternativa, adicione um calendar.homepageTrigger ao manifesto do complemento para fornecer uma página inicial específica da agenda.

Nos dois casos, é preciso fornecer o nome de uma função de gatilho da página inicial no projeto de script do complemento. Essa função é chamada automaticamente para criar a página inicial do Agenda quando necessário. Implemente essa função para criar e retornar uma única Card ou uma matriz de objetos Card que compõem a página inicial. A função de gatilho da página inicial recebe um objeto de evento como um parâmetro que contém algumas informações gerais, como a plataforma do cliente. Você pode usar os dados do objeto de evento para personalizar a construção da página inicial.

Ampliar a interface do evento do Agenda

O Google Agenda usa um acionador contextual para determinar qual interface será exibida quando o usuário editar um evento do Agenda. Quando o gatilho é disparado, ele executa a função de acionador contextual especificada pelo campo calendar.eventOpenTrigger no manifesto do complemento.

Implemente a função nomeada no campo calendar.eventOpenTrigger. Essa função aceita um objeto de evento como argumento e precisa retornar um único objeto Card ou uma matriz de objetos Card que o Agenda exibe quando o evento está aberto.

Objetos de evento

Um objeto de evento é criado e transmitido para a função de gatilho contextual calendar.eventOpenTrigger quando um usuário abre um evento do Agenda. A função de gatilho pode usar as informações deste objeto de evento para determinar como criar cards de complementos ou controlar o comportamento do complemento. Objetos de evento também são criados e transmitidos para funções homepageTrigger quando um complemento é aberto pela primeira vez e quando o usuário clica ou seleciona widgets interativos.

A estrutura completa dos objetos de evento é descrita em Objetos de evento. Quando o Agenda é o app host de atuação do complemento, os objetos de evento de acionador contextual e de interação com o widget incluem o campo Objeto de evento de agenda que transporta informações específicas do cliente do Agenda.

Atualizar eventos do Agenda

Além do calendar.eventOpenTrigger contextual que é acionado quando um usuário abre um evento do Agenda para edição, também é possível definir um calendar.eventUpdateTrigger que é acionado quando o usuário atualiza e salva um evento do Agenda. Esse acionador só será disparado se o usuário fizer uma ou mais das seguintes edições:

  • Adiciona um ou mais participantes.
  • Remove um ou mais participantes.
  • Adiciona ou alterna para uma solução de videoconferência diferente.

Quando esse acionador é disparado, ele executa a função de acionador especificada pelo campo de manifesto calendar.eventUpdateTrigger. A função é executada antes de o evento do Agenda ser salvo.

O calendar.eventUpdateTrigger geralmente é usado para executar um ou mais dos seguintes procedimentos:

  • Atualizar a interface do evento do Agenda em resposta às mudanças que o usuário faz no evento do Agenda.
  • Sincronizar dados de eventos do Agenda com um sistema de terceiros, como um sistema de videoconferência conectado ao Google Agenda.

Se você precisar de um complemento para fazer ajustes nos dados de um evento do Agenda (por exemplo, a lista de convidados), defina o campo de manifesto calendar.currentEventAccess do complemento como WRITE ou READ_WRITE. Isso também exige que o complemento tenha o escopo https://www.googleapis.com/auth/calendar.addons.current.event.write.

Adicionar soluções de videoconferência

As soluções de videoconferência representam uma opção de videoconferência de terceiros que os usuários podem anexar aos eventos do Google Agenda. A documentação de Visão geral de videoconferências de terceiros mostra detalhes sobre como criar um complemento que adiciona novas soluções de videoconferência. Não é necessário criar uma IU para esse tipo de extensão. As soluções adicionadas simplesmente aparecem como opções no menu suspenso da IU de eventos do Google Agenda.