Páginas de inicio

Las páginas principales son una función nueva de 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 se encuentra fuera de un contexto específico, como cuando ve su carpeta Recibidos de Gmail, pero no abrió un mensaje o un 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 a interactuar con tu complemento.

A fin de definir una página principal para tu complemento, especifícala en el manifiesto del proyecto e implementa una o más funciones homepageTrigger (consulta la configuración de la página principal).

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

La página principal de tu 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, para editar un evento de Calendario en el Calendario principal.
• Cuando el usuario hace clic en el botón Atrás suficientes veces para que se abra cada dos tarjetas de las pilas internas
• Cuando una interacción de la IU en una tarjeta no contextual genera una llamada a Navigation.popToRoot().

Diseñar una página principal no es obligatorio, pero es muy recomendable. Si no defines ninguna, se usa una tarjeta genérica con el nombre del complemento cada vez que un usuario navegaría 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 predeterminado de la página principal (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 renderizar las tarjetas de complementos de la página principal. Esta función es la función de activador de la página principal. Esta función debe compilar y mostrar un array 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 tarjetas 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 establece en false, las tarjetas de la página principal se inhabilitan para todos los hosts (a menos que se anulen para ese host; consulta a continuación).

Nota: Para que un host use la página principal común, tanto addOns.common.homepageTrigger como el recurso de nivel superior del host deben estar presentes en el manifiesto del complemento. Por ejemplo, si addOns.gmail no está presente en el manifiesto, el complemento está inhabilitado para Gmail y no mostrará una página principal (ni ninguna otra funcionalidad en ese host).

Además de la configuración común, también hay anulaciones por host estructuradas de forma idéntica disponibles 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 de 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": { /* ... */ },
        ...
      }
    }

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

Objetos de eventos de la página principal

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

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

• commonEventObject.clientPlatform
• commonEventObject.hostApp
• commonEventObject.userLocale y commonEventObject.userTimezone (pero consulta Cómo acceder a la configuración regional y a la zona horaria del usuario para obtener información sobre las restricciones)

Consulta Objeto de evento para obtener más detalles.

Otras tarjetas no contextuales

Tu IU complementaria puede contener tarjetas adicionales no contextuales que no sean páginas principales. Por ejemplo, tu página principal podría tener un botón que abra una tarjeta "Configuración" en la que el usuario puede ajustar la configuración de los complementos (esta configuración, en la mayoría de los casos, 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.