Home page

Le home page sono una nuova funzionalità dei componenti aggiuntivi di Google Workspace che consente di definire una o più schede non contestuali. Le schede non contestuali vengono utilizzate per mostrare un'interfaccia utente quando l'utente al di fuori di un contesto specifico, ad esempio quando l'utente sta visualizzando la Posta in arrivo di Gmail ma non ha aperto un messaggio o una bozza.

Le home page ti consentono di mostrare contenuti non contestuali, proprio come App Google nel riquadro laterale ad accesso rapido (Keep, Calendar e Tasks). Le home page possono anche fornire un punto di partenza quando un utente apre per la prima volta il tuo componente aggiuntivo e sono utili per insegnare a nuovi utenti come interagire con il tuo componente aggiuntivo.

Puoi definire una home page per il tuo componente aggiuntivo specificandola nel tuo progetto manifest e implementare una o più funzioni di homepageTrigger (vedi Configurazione della home page).

Puoi avere più home page, una per ogni applicazione host a cui viene aggiunto il componente aggiuntivo si estende. Puoi anche decidere di definire una singola home page predefinita comune utilizzata negli host per cui non è stata specificata una home page personalizzata.

La home page del componente aggiuntivo viene visualizzata quando si verifica una delle seguenti condizioni:

• Quando il componente aggiuntivo viene aperto per la prima volta nell'host (dopo l'autorizzazione).
• Quando l'utente passa da un contesto contestuale a uno non contestuale mentre il componente aggiuntivo è aperto. Ad esempio, dalla modifica di un evento nel calendario Calendar principale.
• Quando l'utente fa clic sul pulsante Indietro abbastanza volte per estrai ogni altra scheda dagli stack interni.
• Quando un'interazione con l'interfaccia utente in una scheda non contestuale genera una Navigation.popToRoot() chiamata.

La progettazione di una home page non è obbligatoria, ma vivamente consigliata. se non ne definisci alcuna, una carta generica contenente il nome del componente aggiuntivo viene utilizzato ogni volta che un utente naviga in altro modo alla home page.

Configurazione della home page

I componenti aggiuntivi di Google Workspace utilizzano addOns.common.homepageTrigger per configurare il contenuto predefinito del componente aggiuntivo della home page (non contestuale) per tutte le applicazioni host manifest:

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

• runFunction: il nome della funzione Apps Script che Il framework dei componenti aggiuntivi di Google Workspace richiama per il rendering delle schede dei componenti aggiuntivi della home page. Questa funzione è la funzione di trigger home page. Questa funzione deve creare e restituisce un array di Card che compongono l'interfaccia utente della home page. Se viene restituita più di una carta, i applicazione host mostra le intestazioni delle schede in un elenco che l'utente può selezionare da (vedi Restituzione di più carte).

• enabled: indica se le schede della home page devono essere abilitate per questo ambito. Questo è facoltativo e il valore predefinito è true. L'impostazione di false causa le cause le schede della home page devono essere disattivate per tutti gli host (a meno che non vengano sostituite per questo host; vedi sotto).

Oltre alla configurazione comune, ci sono anche sostituzioni per host con struttura identica disponibili nell'applicazione host config, alle ore addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, e così via:

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

Tieni presente che ciò equivale al seguente estratto del file manifest:

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

Nessuna delle sezioni di homepageTrigger è obbligatoria. Tuttavia, l'interfaccia utente mostrata un componente aggiuntivo di un determinato prodotto host dipende dalla presenza campo manifest corrispondente e se è associato homepageTrigger. L'esempio seguente mostra quali funzioni di trigger dei componenti aggiuntivi (se presenti) per creare un'interfaccia utente sulla home page per diversi manifest configurazioni:

Oggetti evento home page

Quando viene richiamata, la funzione di trigger della home page (runFunction) descritta sopra è ha passato un oggetto evento contenente i dati del contesto di chiamata.

Gli oggetti degli eventi della home page non includono widget o informazioni contestuali, il le informazioni trasmesse sono limitate a quanto segue: oggetto evento comune campi:

• commonEventObject.clientPlatform
• commonEventObject.hostApp
• commonEventObject.userLocale e commonEventObject.userTimezone (ma consulta Accesso alle impostazioni internazionali e al fuso orario dell'utente. per informazioni sulle restrizioni).

Per ulteriori dettagli, consulta Oggetto evento.

Altre schede non contestuali

L'interfaccia utente del componente aggiuntivo può contenere schede non contestuali aggiuntive che non home page. Ad esempio, la tua home page potrebbe contenere un pulsante che apre una "Impostazioni" scheda in cui l'utente può modificare le impostazioni del componente aggiuntivo (come le impostazioni sarebbero, nella maggior parte dei casi, indipendenti dal contesto e, di conseguenza, non contestuali).

Le schede non contestuali vengono create come tutte le altre schede. l'unica differenza è l'azione o l'evento generato e mostra la scheda. Consulta Metodi di navigazione per maggiori dettagli su come creare transizioni tra le schede.