Pages d'accueil

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Les pages d'accueil sont une nouvelle fonctionnalité des modules complémentaires Google Workspace qui permettent 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, mais qu'il n'a pas ouvert un message ou un brouillon.

Les pages d'accueil vous permettent d'afficher du contenu non contextuel, tout comme les applications Google, dans le panneau latéral d'accès rapide (Keep, Agenda et Tasks). Les pages d'accueil peuvent également servir de point de départ lorsqu'un utilisateur ouvre votre module complémentaire pour la première fois. Elles sont également utiles pour apprendre aux nouveaux utilisateurs comment interagir avec un 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 (consultez la section Configuration de la page d'accueil).

Vous pouvez avoir plusieurs pages d'accueil, une pour chaque application hôte développée par votre module complémentaire. Vous pouvez également définir une seule page d'accueil par défaut, qui est utilisée par les 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:

  • Lorsque le module complémentaire est ouvert pour la première fois dans 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 à l'agenda principal.
  • Lorsque l'utilisateur clique suffisamment sur le bouton "Retour" pour désélectionner 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 aucune, une carte 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 des modules complémentaires de page d'accueil (non contextuels) par défaut pour toutes les applications hôtes dans le 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 du déclencheur de page d'accueil. Cette fonction doit créer 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 la fiche dans une liste que l'utilisateur peut sélectionner (consultez la section Retourner plusieurs cartes).

  • enabled: indique si les fiches de la page d'accueil doivent être activées pour ce niveau d'accès. 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 pour cet hébergeur ; voir ci-dessous).

En plus de la configuration courante, des remplacements par hôte structurés de manière identique sont disponibles dans chaque configuration d'application hôte, à l'adresse 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 obligatoire. Toutefois, l'interface utilisateur affichée pour un module complémentaire dans un produit hôte donné dépend de la présence du champ manifeste correspondant et de la présence ou non d'un homepageTrigger. L'exemple suivant montre quelles fonctions du déclencheur complémentaire sont exécutées (le cas échéant) afin de créer une UI de page d'accueil pour différentes configurations de fichier manifeste:

Flux de la page d'accueil

Objets d'événement de 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 les données du contexte d'invocation.

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

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

Autres fiches non contextuelles

Votre interface 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 permettant d'ouvrir 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 fiche. Consultez la section Méthodes de navigation pour savoir comment créer des transitions entre des fiches.