Páginas de inicio

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Las páginas principales son una nueva función de los complementos de Google Workspace que permite definir una o más tarjetas no contextuales. Las tarjetas no contextuales se usan para mostrar una interfaz de usuario cuando el usuario está fuera de un contexto específico, como cuando está viendo su carpeta Recibidos de Gmail, pero no abrió un mensaje o borrador.

Las páginas principales te permiten mostrar contenido no contextual, al igual que las apps de Google en el panel lateral de acceso rápido (Keep, Calendario y Tasks). Las páginas principales también pueden proporcionar un punto de partida inicial para cuando un usuario abre tu complemento por primera vez y son útiles para enseñarles a los usuarios nuevos cómo interactuar con tu complemento.

Puedes definir una página principal para el complemento especificándola en el manifiesto del proyecto e implementando una o más funciones homepageTrigger (consulta Configuración de la página principal).

Puedes tener varias páginas principales, una para cada aplicación host que se extienda tu complemento. También puedes decidir definir una única página principal predeterminada que se usa en hosts en los que no especificaste una página principal personalizada.

La página principal del complemento se muestra cuando se cumple una de las siguientes condiciones:

  • Cuando el complemento se abre por primera vez en el host (después de la autorización).
  • Cuando el usuario cambia de un contexto contextual a uno no contextual mientras el complemento está abierto Por ejemplo, desde la edición de un evento de Calendario hasta el Calendario principal.
  • Cuando el usuario hace clic en el botón Atrás lo suficiente como para mostrar las demás tarjetas fuera de las pilas internas.
  • Cuando una interacción de la IU en una tarjeta no contextual da como resultado una llamada Navigation.popToRoot().

Diseñar una página principal no es obligatorio, pero altamente recomendable. Si no defines ninguna, se usará una tarjeta genérica que contenga tu nombre de complemento cada vez que un usuario navegue de otra forma a la página principal.

Configuración de la página principal

Los complementos de Google Workspace usan el campo addOns.common.homepageTrigger para configurar el contenido del complemento de la página principal predeterminado (no contextual) para todas las aplicaciones host en el manifiesto del complemento:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }
  • runFunction: Es el nombre de la función de Apps Script que invoca el framework de complementos de Google Workspace para procesar las tarjetas de complementos de la página principal. Esta función es la función activadora de la página principal. Esta función debe compilar y mostrar un arreglo de objetos Card que conforman la IU de la página principal. Si se muestra más de una tarjeta, la aplicación host muestra los encabezados de la tarjeta en una lista que el usuario puede seleccionar (consulta Cómo mostrar varias tarjetas).

  • enabled: Indica si se deben habilitar las tarjetas de la página principal para este alcance. Este campo es opcional y su valor predeterminado es true. Si se configura en false, se inhabilitan las tarjetas de la página principal para todos los hosts (a menos que se anulen para ese host; consulta a continuación).

Además de la configuración común, también hay anulaciones por host estructuradas de forma idéntica en la configuración de cada aplicación host, en addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, etcétera:

    {
      ...
      "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 }
        },
        ...
      }
    }

Ten en cuenta que esto equivale al siguiente extracto del manifiesto:

    {
      ...
      "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": { /* ... */ },
        ...
      }
    }

Ninguna de las secciones de homepageTrigger es obligatoria. Sin embargo, la IU que se muestra para un complemento en cualquier producto host determinado depende de la presencia del campo del manifiesto correspondiente y de si existe un homepageTrigger asociado. En el siguiente ejemplo, se muestra qué funciones del activador se ejecutan (si las hay) a fin de crear una IU en la página principal para diferentes configuraciones del manifiesto:

Flujo de la página principal

Objetos de eventos de la página principal

Cuando se llama a la función activadora de la página principal (runFunction) descrita anteriormente, se pasa un objeto de evento que contiene datos del contexto de invocación.

Los objetos de eventos de la página principal no incluyen información contextual ni de widgets. La información que se transmite se limita a los siguientes campos de objetos de eventos comunes:

Consulta Objeto de evento para obtener más detalles.

Otras tarjetas no contextuales

La IU del complemento puede contener tarjetas no contextuales adicionales que no son páginas principales. Por ejemplo, tu página principal puede tener un botón que abra una tarjeta "Configuración" en la que el usuario pueda ajustar la configuración del complemento (en la mayoría de los casos, esta configuración sería independiente del contexto y, por lo tanto, no contextual).

Las tarjetas no contextuales se compilan como cualquier otra tarjeta; la única diferencia es qué acción o evento genera y muestra la tarjeta. Consulta Métodos de navegación para obtener detalles sobre cómo crear transiciones entre tarjetas.