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 cartes non contextuelles permettent d'afficher une interface utilisateur lorsque l'utilisateur ne se trouve pas dans un contexte spécifique, par exemple lorsqu'il 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, 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 initial lorsque l'utilisateur ouvre votre module complémentaire pour la première fois. Elles sont également utiles 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 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 développée par votre module complémentaire. Vous pouvez également décider de 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:

• 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écoller toutes les autres cartes des piles internes.
• Lorsqu'une interaction avec l'interface utilisateur d'une carte non contextuelle entraîne un appelNavigation.popToRoot().

La conception d'une page d'accueil n'est pas obligatoire, mais vivement recommandée. Si vous n'en définissez aucune, une fiche générique contenant votre nom de module complémentaire sera utilisée chaque fois qu'un utilisateur accède à 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 la page d'accueil par défaut (non contextuel) de toutes les applications hôtes du fichier manifeste:

    {
      // ...
      "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 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 carte dans une liste que l'utilisateur peut sélectionner (voir 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 défini par défaut sur 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 ont été remplacés pour cet hébergeur, voir ci-dessous).

En plus de la configuration courante, des remplacements par hôte identiques sont disponibles dans la configuration de chaque application hôte : 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 section homepageTrigger n'est requise. Toutefois, l'UI 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 l'existence ou non d'unhomepageTrigger associé. L'exemple suivant montre quelles fonctions de déclencheur de module complémentaire sont exécutées (le cas échéant) pour créer une interface utilisateur de page d'accueil pour différentes configurations de manifeste:

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'appel.

Les objets d'événement de page d'accueil n'incluent pas d'informations contextuelles ou de widget. Les informations transmises se limitent aux champs d'événements courants suivants:

• 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 é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" permettant à l'utilisateur d'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 conçues de la même manière que les autres fiches. La seule différence réside dans la nature de l'action ou de l'événement généré et affiché. Pour en savoir plus sur la création de transitions entre les cartes, consultez la section Méthodes de navigation.