Class Grid

Griglia

Una griglia organizzata per visualizzare una raccolta di elementi della griglia.

Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.

var grid = CardService.newGrid()
    .setTitle("My Grid")
    .setNumColumns(2)
    .addItem(CardService.newGridItem()
        .setTitle("My item"));

Metodi

MetodoTipo restituitoBreve descrizione
addItem(gridItem)GridAggiunge un nuovo elemento alla griglia.
setAuthorizationAction(action)GridImposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato.
setBorderStyle(borderStyle)GridImposta lo stile del bordo applicato a ogni elemento della griglia.
setComposeAction(action, composedEmailType)GridImposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto.
setNumColumns(numColumns)GridIl numero di colonne da visualizzare nella griglia.
setOnClickAction(action)GridImposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto.
setOnClickOpenLinkAction(action)GridConsente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto.
setOpenLink(openLink)GridImposta un URL da aprire quando l'utente fa clic sull'oggetto.
setTitle(title)GridImposta il testo del titolo della griglia.

Documentazione dettagliata

addItem(gridItem)

Aggiunge un nuovo elemento alla griglia.

Parametri

NomeTipoDescrizione
gridItemGridItemL'elemento della griglia da aggiungere.

Invio

Grid: oggetto per il collegamento.


setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando l'oggetto viene selezionato. L'URL viene aperto in una nuova finestra. Quando l'utente termina il flusso di autorizzazione all'applicazione, il componente aggiuntivo si ricarica.

Per un oggetto UI può essere impostato un solo elemento tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

Parametri

NomeTipoDescrizione
actionAuthorizationActionL'oggetto che specifica l'azione di autorizzazione da eseguire quando questo elemento viene selezionato.

Invio

Grid: oggetto per il collegamento.


setBorderStyle(borderStyle)

Imposta lo stile del bordo applicato a ogni elemento della griglia. Il valore predefinito è NO_BORDER.

Parametri

NomeTipoDescrizione
borderStyleBorderStyleLo stile del bordo da applicare.

Invio

Grid: oggetto per il collegamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando l'utente fa clic sull'oggetto. Un oggetto UI può solo avere uno dei seguenti: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostati.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

var action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  var thread = GmailApp.getThreadById(e.threadId);
  var draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di scrittura da eseguire quando questo elemento viene selezionato.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è un indipendente o una bozza di risposta.

Invio

Grid: oggetto per il collegamento.


setNumColumns(numColumns)

Il numero di colonne da visualizzare nella griglia. Se mostrata nel riquadro laterale a destra, puoi visualizzare 1-2 colonne e il valore predefinito è 1. Se visualizzata in una finestra di dialogo, puoi visualizzare 2-3 colonne e il valore predefinito è 2.

Parametri

NomeTipoDescrizione
numColumnsIntegerIl numero di colonne.

Invio

Grid: oggetto per il collegamento.


setOnClickAction(action)

Imposta un'azione che viene eseguita quando l'utente fa clic sull'oggetto. Un oggetto UI può avere solo uno dei seguenti Impostazione setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostata.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ActionResponse.

// ...

var action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton().setText('Create notification').setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(CardService.newNotification()
          .setText("Some info to display to user"))
      .build();
}

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire quando l'utente fa clic su questo elemento.

Invio

Grid: oggetto per il collegamento.


setOnClickOpenLinkAction(action)

Consente di impostare un'azione che consente di aprire un URL in una scheda quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando È necessario creare l'URL o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

Il parametro Action deve specificare una funzione di callback che restituisca un oggetto ActionResponse configurato utilizzando ActionResponseBuilder.setOpenLink(openLink).

// ...

var action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink()
          .setUrl('https://www.google.com'))
      .build();
}

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di apertura link da eseguire quando questo elemento è selezionato.

Invio

Grid: oggetto per il collegamento.


Imposta un URL da aprire quando l'utente fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve solo essere aperto. Un oggetto UI può avere solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) impostato.

Parametri

NomeTipoDescrizione
openLinkOpenLinkUn oggetto OpenLink che descrive l'URL da aprire.

Invio

Grid: oggetto per il collegamento.


setTitle(title)

Imposta il testo del titolo della griglia. Il testo deve essere una stringa normale senza formattazione.

Parametri

NomeTipoDescrizione
titleStringIl testo del titolo.

Invio

Grid: oggetto per il collegamento.