Como criar as interfaces do Google Agenda

Os complementos do Google Workspace oferecem recursos interfaces quando o usuário está visualizando ou editando agendas e eventos do Google Agenda. Isso permite que você forneça ao usuário informações relevantes adicionais, automatize tarefas e conectar 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 crie uma específica para o Google Agenda.

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

Como acessar a interface do complemento

Dependendo de como é aberto, um complemento do Google Workspace pode definir uma interface de página inicial, uma interface de eventos do Google Agenda, uma interface de seleção de anexos ou as três opções a seguir:

• Se um usuário clicar no ícone do complemento enquanto estiver em uma visualização da agenda, o complemento será executado o calendar.homepageTrigger correspondente (se presente). A função cria e retorna um card da página inicial e o Google Agenda para exibição. Em caso negativo calendar.homepageTrigger for definida, um card genérico de página inicial será exibido.
• Se o usuário abrir um evento da Agenda e clicar no ícone do complemento ou o complemento está aberto quando o usuário abre um evento, executa o comando eventOpenTrigger (se presente). Esta função cria o evento da Agenda do complemento interface e retorna ao Google Agenda para exibição.
• Se o complemento definir uma função eventAttachmentTrigger, o complemento aparecerá como um provedor de anexos quando o usuário clicar em Adicionar anexo ao editar um evento do Google Agenda. Quando o complemento é selecionado, a função eventAttachmentTrigger cria o anexo do complemento. interface de seleção e retorna ao Google Agenda para exibição.

Como criar a interface de complementos do Agenda

Você pode estender o Google Agenda com uma Complemento do Google Workspace, seguindo estas etapas:

1. Decida se você quer que seu complemento tenha uma funcionalidade específica do Google Agenda página inicial. Decida também se você quer oferecer uma interface personalizada enquanto o usuário edição de eventos do Google Agenda.
2. Adicione o addOns.common e addOns.calendar ao manifesto do projeto de script de complemento, incluindo os escopos necessários.
3. Se você fornecer um documento do Google Agenda página inicial, implementar calendar.homepageTrigger para criar essa interface. Você também pode optar por usar common.homepageTrigger para vários hosts do Google Workspace.
4. Se você estiver fornecendo uma interface de eventos do Google Agenda, deverá implementar um calendar.eventOpenTrigger para criar essa interface. Consulte Ampliar a interface de eventos do Agenda para mais detalhes.
5. Implementar as funções de callback associadas necessárias para responder ao comando Interações da interface, como cliques em botões.

Páginas iniciais do Google Agenda

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

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

Em ambos os casos, é necessário fornecer o nome de uma função de acionamento da página inicial no seu do seu complemento. Essa função é chamada automaticamente para criar a na página inicial do Google Agenda quando necessário. Você precisa implementar essa função para criar e retornam uma única Card ou uma matriz de 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 o URL de plataforma. Você pode usar os dados do objeto de evento para personalizar a construção do página inicial.

Estender a interface de eventos do Agenda

O Google Agenda usa um gatilho contextual para determinar qual interface (se houver) para ser exibido quando o usuário editar um evento da agenda. Quando o gatilho for disparado, ele executa a função de acionamento contextual especificada pelo calendar.eventOpenTrigger no manifesto do complemento.

Você deve implementar a função nomeada no calendar.eventOpenTrigger . Essa função aceita um objeto de evento como um e deve retornar um único objeto Card ou uma matriz de Objetos Card para o Agenda serão mostrados enquanto o usuário estiver com o evento aberto.

Objetos de evento

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

Observação :o termo "evento" em "objeto de evento" refere-se a uma ação realizada pelo usuário na interface do complemento e na resposta associada, não em um evento da Agenda. Para manter clara, os eventos do Google Agenda são sempre chamados de "Eventos da agenda" nesta documentação.

A estrutura completa dos objetos de evento é descrita em Objetos de evento Quando o Google Agenda é o app host de ação do complemento, o gatilho contextual e Os objetos de evento de interação com widget incluem Objeto de evento da agenda que contém informações do cliente específicas do Google Agenda.

Atualizar eventos do Google Agenda

Além dos anúncios contextuais calendar.eventOpenTrigger acionado quando um usuário abre um evento da Agenda para edição, você também pode definir calendar.eventUpdateTrigger acionado quando o usuário atualiza e salva um evento da Agenda. Somente este acionador é disparado se o usuário fizer uma ou mais das seguintes edições:

• Adiciona um ou mais convidados.
• Remove um ou mais convidados.
• Adiciona ou muda para outra solução de videoconferência.

Quando o acionador é disparado, ele executa o função de gatilho especificada pelo calendar.eventUpdateTrigger manifest. A função é executada antes que a edição do evento da Agenda seja salvas.

O calendar.eventUpdateTrigger normalmente é usado para realizar uma ou mais das seguintes ações:

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

Se você precisar que o complemento faça ajustes nos dados de um evento do Google Agenda (como como sua lista de participantes), será preciso configurar o complemento calendar.currentEventAccess campo de manifesto como WRITE ou READ_WRITE. Isso também exige que o complemento tenha https://www.googleapis.com/auth/calendar.addons.current.event.write escopo.

Adicionar soluções de conferência

Observação :a adição de soluções de conferência só é útil para desenvolvedores que querem integrar um sistema de videoconferência de terceiros ao Google Agenda. Essa funcionalidade foi lançada na versão Beta como Complementos de videoconferência do Agenda, mas agora estão disponíveis no Complementos do Google Workspace.

Soluções para conferências representar uma opção de videoconferência de terceiros que os usuários podem anexar Eventos do Google Agenda. A Visão geral das videoconferências com terceiros documentação fornece detalhes sobre como criar um complemento que adiciona novos e conferências. Não é necessário criar uma interface para esse tipo de extensão; as soluções adicionadas são mostradas como opções no menu suspenso a interface de eventos do Google Agenda.