Pages d'accueil

Les pages d'accueil sont une nouvelle fonctionnalité des modules complémentaires Google Workspace qui permet de définir une ou plusieurs fiches non contextuelles. Les fiches non contextuelles sont utilisées pour afficher une interface utilisateur lorsque l'utilisateur en dehors d'un contexte spécifique, par exemple lorsque l'utilisateur consulte sa boîte de réception Gmail. mais qu'il n'a pas ouvert de message ou de brouillon.

Les pages d'accueil vous permettent d'afficher du contenu non contextuel, comme Applications Google du panneau latéral d'accès rapide (Keep, Agenda et Tasks). Les pages d'accueil peuvent également constituer Emplacement lorsqu'un utilisateur ouvre le module complémentaire pour la première fois. Ils sont utiles pour enseigner pour expliquer aux nouveaux utilisateurs comment interagir avec votre module complémentaire.

Vous pouvez définir une page d'accueil pour votre module complémentaire en la spécifiant dans votre projet fichier manifeste et implémenter une ou plusieurs fonctions homepageTrigger (voir Configuration de la page d'accueil).

Vous pouvez avoir plusieurs pages d'accueil, une pour chaque application hôte utilisée par votre module complémentaire. s'étend. Vous pouvez également décider de définir une seule page d'accueil par défaut commune utilisés dans des hôtes pour lesquels vous n'avez pas spécifié de page d'accueil personnalisée.

La page d'accueil du module complémentaire s'affiche lorsque l'une des conditions suivantes est remplie:

  • Lorsque le module complémentaire est ouvert pour la première fois sur l'hôte (après l'autorisation).
  • Lorsque l'utilisateur passe d'un contexte contextuel à un contexte non contextuel lorsque le module complémentaire est ouvert. Par exemple, de la modification d'un événement d'agenda à Agenda principal.
  • Lorsque l'utilisateur clique sur le bouton Retour suffisamment de fois pour faire sortir toutes les autres cartes des piles internes.
  • Lorsqu'une interaction de l'interface utilisateur dans une fiche non contextuelle entraîne une Navigation.popToRoot() .

La conception d'une page d'accueil n'est pas obligatoire, mais fortement recommandée ; si vous n'en définissez pas, une fiche générique contenant votre nom de module complémentaire est utilisé chaque fois qu'un utilisateur navigue à la page d'accueil.

Configuration de la page d'accueil

Les modules complémentaires Google Workspace utilisent addOns.common.homepageTrigger permettant de configurer le contenu complémentaire (non contextuel) de la page d'accueil par défaut pour toutes les applications hôtes du module manifest:

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

  • runFunction: nom de la fonction Apps Script que le Le framework de modules complémentaires Google Workspace appelle pour afficher les fiches de modules complémentaires de la page d'accueil. Il s'agit de la fonction de déclencheur de la page d'accueil. Cette fonction doit créer et renvoyer un tableau de Card objets qui composent l'interface utilisateur de la page d'accueil. Si plusieurs cartes sont retournées, la L'application hôte affiche les en-têtes de carte dans une liste que l'utilisateur peut sélectionner. de (voir Retourner plusieurs cartes)

  • enabled: indique si les fiches de la page d'accueil doivent être activées pour ce champ d'application. Ce est facultatif et est défini par défaut sur true. Définir ce paramètre sur false entraîne les fiches de la page d'accueil doivent être désactivées pour tous les hôtes (sauf si vous remplacez host; voir ci-dessous).

En plus de la configuration courante, des remplacements par hôte structurés de manière identique sont disponibles dans les applications à l'emplacement addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, et ainsi de suite:

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

Notez que cela équivaut à l'extrait de fichier manifeste suivant:

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

Aucune des sections homepageTrigger n'est obligatoire. Cependant, l'UI affichée pour un module complémentaire dans un produit hôte donné dépend de la présence du dans le champ du fichier manifeste correspondant, et s'il existe homepageTrigger L'exemple suivant montre les fonctions de déclenchement du module complémentaire sont exécutées (le cas échéant) afin de créer une UI de page d'accueil pour différents fichiers manifestes. Configurations:

Flux de la page d'accueil

Objets d'événement sur la page d'accueil

Lorsqu'elle est appelée, la fonction de déclencheur de la page d'accueil (runFunction) décrite ci-dessus est a transmis un objet événement. contenant les données du contexte de l'appel.

Les objets "Événement de la page d'accueil" n'incluent pas de widget ni d'informations contextuelles. la les informations transmises sont limitées objet d'événement commun :

Pour en savoir plus, consultez la section Objet événement.

Autres fiches non contextuelles

L'interface utilisateur de votre module complémentaire peut contenir d'autres fiches non contextuelles qui ne sont pas pages d'accueil. Par exemple, votre page d'accueil peut avoir un bouton qui ouvre un "Paramètres" où l'utilisateur peut modifier les paramètres du module complémentaire sont, dans la plupart des cas, indépendantes du contexte.

Les cartes sans contexte sont conçues comme n'importe quelle autre fiche. la seule différence est l'action ou l'événement qui génère et affiche la fiche. Voir Méthodes de navigation pour savoir comment créer des transitions entre les fiches.