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 permettent d'afficher une interface utilisateur lorsque l'utilisateur se trouve en dehors d'un contexte spécifique, par exemple lorsqu'il consulte sa boîte de réception Gmail sans ouvrir de message ni de brouillon.

Tout comme les applications Google dans le panneau latéral d'accès rapide (Keep, Agenda et Tasks), les pages d'accueil vous permettent d'afficher du contenu non contextuel. Les pages d'accueil peuvent également servir de point de départ initial lorsqu'un utilisateur ouvre votre module complémentaire pour la première fois. Elles sont utiles pour apprendre aux nouveaux utilisateurs à interagir avec votre module complémentaire.

Vous pouvez définir une page d'accueil pour votre module complémentaire en la spécifiant dans le fichier manifeste de votre projet et en implémentant 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 que votre module complémentaire étend. Vous pouvez également définir une seule page d'accueil par défaut commune aux hôtes pour lesquels vous n'avez pas spécifié de page d'accueil personnalisée.

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

• Première ouverture du module complémentaire dans l'hôte (après autorisation).
• Lorsque l'utilisateur passe d'un contexte contextuel à un contexte non contextuel pendant que le module complémentaire est ouvert (modification d'un événement d'agenda au calendrier principal, par exemple).
• Lorsque l'utilisateur clique sur le bouton "Retour" suffisamment de fois pour retirer toutes les autres cartes des piles internes.
• Lorsqu'une interaction de l'interface utilisateur dans une fiche non contextuelle entraîne un appel Navigation.popToRoot().

La conception d'une page d'accueil n'est pas obligatoire, mais vivement recommandée. Si vous n'en définissez pas, une fiche générique contenant le nom de votre module complémentaire sera utilisée chaque fois qu'un utilisateur accéderait à la page d'accueil.

Configuration de la page d'accueil

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

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

• runFunction: nom de la fonction Apps Script que le framework des modules complémentaires Google Workspace appelle pour afficher les fiches des modules complémentaires de la page d'accueil. Il s'agit de la fonction de déclenchement de la page d'accueil. Cette fonction doit compiler et renvoyer un tableau d'objets Card qui composent l'interface utilisateur de la page d'accueil. Si plusieurs cartes sont renvoyées, l'application hôte affiche les en-têtes de carte sous forme de liste que l'utilisateur peut sélectionner (voir la section Renvoyer plusieurs cartes).

• enabled: indique si les fiches de la page d'accueil doivent être activées pour ce champ d'application. Ce champ est facultatif et affiche par défaut la valeur true. Si vous définissez ce paramètre sur false, les fiches de la page d'accueil sont désactivées pour tous les hôtes (sauf s'ils sont remplacés par cet hébergeur, voir ci-dessous).

Remarque :Pour qu'un hôte puisse utiliser la page d'accueil commune, addOns.common.homepageTrigger et la ressource de premier niveau de l'hôte doivent tous deux être présents dans le fichier manifeste du module complémentaire. Par exemple, si addOns.gmail n'est pas présent dans le fichier manifeste, le module complémentaire est désactivé pour Gmail et n'affiche pas de page d'accueil (ni aucune autre fonctionnalité de cet hôte).

En plus de la configuration courante, il existe des forçages par hôte parfaitement structurés dans la configuration de chaque application hôte, avec addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, etc. :

    {
      ...
      "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 requise. Toutefois, l'interface utilisateur d'un module complémentaire dans un produit hôte donné dépend de la présence du champ manifeste correspondant et de l'existence d'un homepageTrigger. L'exemple suivant montre les fonctions de déclencheur de module complémentaire exécutées (le cas échéant) afin de créer une UI de page d'accueil pour différentes configurations de fichier manifeste:

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

Lorsqu'elle est appelée, la fonction de déclenchement de la page d'accueil (runFunction) décrite ci-dessus reçoit un objet d'événement contenant des données du contexte d'invocation.

Les objets d'événement de page d'accueil n'incluent pas d'informations contextuelles ni de widget. Les informations transmises sont limitées aux champs suivants d'objets d'événement courants:

• commonEventObject.clientPlatform
• commonEventObject.hostApp
• commonEventObject.userLocale et commonEventObject.userTimezone (mais consultez la section Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur pour en savoir plus sur les restrictions).

Pour en savoir plus, consultez Objet d'événement.

Autres fiches non contextuelles

L'interface utilisateur de votre module complémentaire peut contenir des fiches non contextuelles supplémentaires qui ne sont pas des pages d'accueil. Par exemple, votre page d'accueil peut comporter un bouton qui ouvre une fiche "Paramètres" dans laquelle l'utilisateur peut ajuster les paramètres du module complémentaire (ces paramètres étant, dans la plupart des cas, indépendants du contexte et donc non contextuels).

Les fiches non contextuelles sont créées de la même manière que les autres fiches. La seule différence réside dans le fait que l'action ou l'événement génère et affiche la carte. Pour en savoir plus sur la création de transitions entre les cartes, consultez la section Méthodes de navigation.