Azioni universali

Le azioni universali sono elementi di voci di menu che consentono a un utente di aprire una nuova pagina web, visualizzare nuove schede UI o eseguire una funzione Apps Script specifica, se selezionata. Nel funzionamento sono molto simili alle azioni delle schede, tranne per il fatto che vengono sempre inserite su ogni scheda del componente aggiuntivo, indipendentemente dal loro contesto attuale.

Utilizzando le azioni universali, puoi assicurarti che l'utente abbia sempre accesso a determinate funzionalità, indipendentemente dalla parte del componente aggiuntivo con cui interagiscono. Ecco alcuni esempi di casi d'uso di azioni universali:

• Apri una pagina web delle impostazioni (o visualizza una scheda delle impostazioni).
• Mostra all'utente informazioni della guida.
• Avvia un nuovo flusso di lavoro, ad esempio "Aggiungi nuovo cliente".
• Mostra una scheda che consente all'utente di inviare un feedback sul componente aggiuntivo.

Ogni volta che vuoi compiere un'azione che non dipende dal contesto, valuta di renderla un'azione universale.

Utilizzo delle azioni universali

Le azioni universali sono configurate nel manifest del progetto del componente aggiuntivo. Una volta configurata, un'azione universale è sempre disponibile per gli utenti del componente aggiuntivo. Se l'utente visualizza una scheda, l'insieme di azioni universali che hai definito appare sempre nel menu della scheda, dopo qualsiasi azione della scheda che hai definito per la scheda. Le azioni universali vengono visualizzate nei menu delle schede nello stesso ordine in cui sono definite nel file manifest del componente aggiuntivo.

Configurazione delle azioni universali

Puoi configurare le azioni universali nel file manifest del tuo componente aggiuntivo. Per ulteriori informazioni, consulta la sezione Manifest.

Per ogni azione devi specificare il testo da visualizzare nel menu relativo all'azione in questione. Puoi quindi specificare un campo openLink che indica che l'azione deve aprire direttamente una pagina web in una nuova scheda. In alternativa, puoi specificare un campo runFunction che specifica una funzione di callback di Apps Script da eseguire quando viene selezionata l'azione universale.

Quando viene utilizzato runFunction, la funzione di callback specificata di solito esegue una delle seguenti operazioni:

• Crea schede UI da visualizzare immediatamente restituendo un oggetto UniversalActionResponse creato.
• Apre un URL, magari dopo aver eseguito altre attività, restituendo un oggetto UniversalActionResponse creato.
• Esegue attività in background che non consentono di passare a una nuova scheda o aprire un URL. In questo caso, la funzione di callback non restituisce nulla.

Quando viene chiamata, alla funzione di callback viene passato un oggetto evento contenente informazioni sulla scheda aperta e sul contesto del componente aggiuntivo.

Avviso: per garantire la reattività dei componenti aggiuntivi, il servizio per le schede limita le funzioni di callback delle azioni universali a un massimo di 30 secondi di tempo di esecuzione. Se l'esecuzione richiede più tempo, la UI del componente aggiuntivo potrebbe non essere aggiornata correttamente.

Esempio

Il seguente snippet di codice mostra un esempio di estratto del file manifest per un componente aggiuntivo di Google Workspace che utilizza azioni universali durante l'estensione di Gmail. Il codice imposta esplicitamente un ambito dei metadati in modo che il componente aggiuntivo possa determinare chi ha inviato il messaggio aperto.

  "oauthScopes": [
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata"
  ],
  "addOns": {
    "common": {
      "name": "Universal Actions Only Addon",
      "logoUrl": "https://www.example.com/hosted/images/2x/my-icon.png",
      "openLinkUrlPrefixes": [
        "https://www.google.com",
        "https://www.example.com/urlbase"
      ],
      "universalActions": [{
          "label": "Open google.com",
          "openLink": "https://www.google.com"
        }, {
          "label": "Open contact URL",
          "runFunction": "openContactURL"
        }, {
          "label": "Open settings",
          "runFunction": "createSettingsResponse"
        }, {
          "label": "Run background sync",
          "runFunction": "runBackgroundSync"
      }],
      ...
    },
    "gmail": {
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "getContextualAddOn"
        }
      ]
    },
    ...
  },
  ...

Le tre azioni universali definite nell'esempio precedente fanno quanto segue:

• Apri google.com apre https://www.google.com in una nuova scheda.
• Apri URL contatto esegue una funzione che determina quale URL aprire e poi lo apre in una nuova scheda utilizzando un oggetto OpenLink. Il codice crea l'URL utilizzando l'indirizzo email del mittente.
• Apri impostazioni esegue la funzione createSettingsCards() definita nel progetto di script del componente aggiuntivo. Questa funzione restituisce un oggetto UniversalActionResponse valido contenente un insieme di schede con impostazioni aggiuntive e altre informazioni. Al termine della creazione dell'oggetto, nella UI viene visualizzato l'elenco di schede (consulta la sezione Restituzione di più schede).
• L'opzione Esegui sincronizzazione in background esegue la funzione runBackgroundSync() definita nel progetto di script del componente aggiuntivo. Questa funzione non crea schede, ma esegue alcune altre attività in background che non modificano l'interfaccia utente. Poiché la funzione non restituisce un UniversalActionResponse, l'interfaccia utente non mostra una nuova scheda al termine della funzione. L'interfaccia utente mostra invece una rotellina dell'indicatore di caricamento mentre la funzione è in esecuzione.

Ecco un esempio di come potresti costruire le funzioni openContactURL(), createSettingsResponse() e runBackgroundSync():

/**
 * Open a contact URL.
 * @param {Object} e an event object
 * @return {UniversalActionResponse}
 */
function openContactURL(e) {
  // Activate temporary Gmail scopes, in this case so that the
  // open message metadata can be read.
  var accessToken = e.gmail.accessToken;
  GmailApp.setCurrentMessageAccessToken(accessToken);

  // Build URL to open based on a base URL and the sender's email.
  // This URL must be included in the openLinkUrlPrefixes whitelist.
  var messageId = e.gmail.messageId;
  var message = GmailApp.getMessageById(messageId);
  var sender = message.getFrom();
  var url = "https://www.example.com/urlbase/" + sender;
  return CardService.newUniversalActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl(url))
      .build();
}

/**
 * Create a collection of cards to control the add-on settings and
 * present other information. These cards are displayed in a list when
 * the user selects the associated "Open settings" universal action.
 *
 * @param {Object} e an event object
 * @return {UniversalActionResponse}
 */
function createSettingsResponse(e) {
  return CardService.newUniversalActionResponseBuilder()
      .displayAddOnCards(
          [createSettingCard(), createAboutCard()])
      .build();
}

/**
 * Create and return a built settings card.
 * @return {Card}
 */
function createSettingCard() {
  return CardService.newCardBuilder()
      .setHeader(CardService.newCardHeader().setTitle('Settings'))
      .addSection(CardService.newCardSection()
          .addWidget(CardService.newSelectionInput()
              .setType(CardService.SelectionInputType.CHECK_BOX)
              .addItem("Ask before deleting contact", "contact", false)
              .addItem("Ask before deleting cache", "cache", false)
              .addItem("Preserve contact ID after deletion", "contactId", false))
          // ... continue adding widgets or other sections here ...
      ).build();   // Don't forget to build the card!
}

/**
 * Create and return a built 'About' informational card.
 * @return {Card}
 */
function createAboutCard() {
  return CardService.newCardBuilder()
      .setHeader(CardService.newCardHeader().setTitle('About'))
      .addSection(CardService.newCardSection()
          .addWidget(CardService.newTextParagraph()
              .setText('This add-on manages contact information. For more '
                  + 'details see the <a href="https://www.example.com/help">'
                  + 'help page</a>.'))
      // ... add other information widgets or sections here ...
      ).build();  // Don't forget to build the card!
}

/**
 * Run background tasks, none of which should alter the UI.
 * Also records the time of sync in the script properties.
 *
 * @param {Object} e an event object
 */
function runBackgroundSync(e) {
  var props = PropertiesService.getUserProperties();
  props.setProperty("syncTime", new Date().toString());

  syncWithContacts();  // Not shown.
  updateCache();       // Not shown.
  validate();          // Not shown.

  // no return value tells the UI to keep showing the current card.
}