Páginas iniciais

As páginas iniciais são um novo recurso de complementos do Google Workspace que permite definir um ou mais cartões não contextuais. Os cards não contextuais são usados para exibir uma interface do usuário quando ele está fora de um contexto específico, por exemplo, quando o usuário está visualizando a Caixa de entrada do Gmail, mas não abriu uma mensagem ou um rascunho.

As páginas iniciais permitem exibir conteúdo não contextual, assim como os apps do Google no painel lateral de acesso rápido (Keep, Agenda e Tarefas). As páginas iniciais também podem fornecer um ponto de partida inicial para quando um usuário abrir seu complemento pela primeira vez e são úteis para ensinar os novos usuários a interagir com o complemento.

Para definir uma página inicial do complemento, especifique-a no manifesto do projeto e implemente uma ou mais funções homepageTrigger. Consulte Configuração da página inicial.

É possível ter várias páginas iniciais, uma para cada aplicativo host que o complemento estende. Também é possível definir uma única página inicial comum usada em hosts em que uma página inicial personalizada não tenha sido especificada.

A página inicial do complemento será exibida quando uma das seguintes condições for atendida:

  • Quando o complemento é aberto pela primeira vez no host (após a autorização).
  • Quando o usuário alterna de um contexto contextual para um contexto não contextual enquanto o complemento está aberto. Por exemplo, da edição de um evento do Agenda para o Agenda principal.
  • Quando o usuário clicar no botão "Voltar" o suficiente para remover todos os outros cards das pilhas internas.
  • Quando uma interação da IU em um card não contextual resulta em uma chamada Navigation.popToRoot().

Projetar uma página inicial não é obrigatório, mas altamente recomendado. Se você não definir um padrão, um cartão genérico contendo o nome do seu complemento será usado sempre que um usuário navegar até a página inicial.

Configuração da página inicial

Os complementos do Google Workspace usam o campo addOns.common.homepageTrigger para configurar o conteúdo do complemento padrão da página inicial (não contextual) de todos os aplicativos host no manifesto:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }

  • runFunction: o nome da função do Apps Script que o framework de complementos do Google Workspace invoca para renderizar os cards de complementos da página inicial. Esta é a função de acionamento da página inicial. Essa função precisa criar e retornar uma matriz de objetos Card que compõem a IU da página inicial. Se mais de um cartão for retornado, o aplicativo host mostrará os cabeçalhos do cartão em uma lista em que o usuário pode selecionar. Consulte Como retornar vários cartões.

  • enabled: se os cards da página inicial precisam ser ativados para este escopo. Esse campo é opcional e o padrão é true. Definir como false faz com que os cards da página inicial sejam desativados para todos os hosts, a menos que sejam modificados para esse host. Veja abaixo.

Além da configuração comum, também há modificações por host com estrutura estruturada disponíveis na configuração de cada aplicativo host em addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger e assim por diante:

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

Isso é equivalente ao seguinte trecho do manifesto:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

Nenhuma das seções de homepageTrigger é obrigatória. No entanto, a IU mostrada para um complemento em qualquer produto host depende da presença do campo de manifesto correspondente e da presença de um homepageTrigger associado. O exemplo a seguir mostra quais funções de gatilho de complemento são executadas (se houver) para criar uma IU de página inicial para diferentes configurações de manifesto:

Fluxo da página inicial

Objetos de evento da página inicial

Quando chamada, a função de acionamento da página inicial (runFunction) descrita acima recebe um objeto de evento contendo dados do contexto de invocação.

Os objetos de evento da página inicial não incluem informações contextuais ou de widget. As informações transmitidas são limitadas aos seguintes campos do objeto de evento comum:

Consulte Objeto de evento para mais detalhes.

Outros cards não contextuais

A IU do complemento pode conter outros cards não contextuais que não são páginas iniciais. Por exemplo, sua página inicial pode ter um botão que abre um card "Configurações" em que o usuário pode ajustar as configurações de complementos. Na maioria dos casos, essas configurações seriam independentes do contexto e, portanto, não contextuais.

Os cartões não contextuais são criados como qualquer outro. A única diferença é qual ação ou evento gera e exibe o cartão. Consulte Métodos de navegação para ver detalhes sobre como criar transições entre cards.