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. 

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

Metodi

MetodoTipo restituitoBreve descrizione
addEventAction(eventAction)WidgetAggiunge l'azione evento che può essere eseguita sul widget.
addItem(gridItem)GridAggiunge un nuovo elemento alla griglia.
setAuthorizationAction(action)GridImposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto.
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 si fa clic sull'oggetto.
setId(id)WidgetImposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
setNumColumns(numColumns)GridIl numero di colonne da visualizzare nella griglia.
setOnClickAction(action)GridImposta un'azione da eseguire quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)GridImposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto.
setOpenLink(openLink)GridImposta un URL da aprire quando si fa clic sull'oggetto.
setTitle(title)GridImposta il testo del titolo della griglia.
setVisibility(visibility)WidgetImposta la visibilità del widget.

Documentazione dettagliata

addEventAction(eventAction)

Aggiunge l'azione evento che può essere eseguita sul widget.

Parametri

NomeTipoDescrizione
eventActionEventActionEventAction da aggiungere.

Indietro

Widget: l'oggetto, per il concatenamento.

addItem(gridItem)

Aggiunge un nuovo elemento alla griglia.

Parametri

NomeTipoDescrizione
gridItemGridItemL'elemento della griglia da aggiungere.

Indietro

Grid: questo oggetto, per il concatenamento.

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto. Si apre l'URL in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto UI può avere impostato solo uno dei valori setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType). 

// ...

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

Parametri

NomeTipoDescrizione
actionAuthorizationActionL'oggetto che specifica l'azione di autorizzazione da intraprendere quando viene fatto clic su questo elemento.

Indietro

Grid: questo oggetto, per il concatenamento.

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.

Indietro

Grid: questo oggetto, per il concatenamento.

setComposeAction(action, composedEmailType)

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

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

// ...

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

// ...

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

Parametri

NomeTipoDescrizione
actionActionL'oggetto che specifica l'azione di composizione da intraprendere quando si fa clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Indietro

Grid: questo oggetto, per il concatenamento.

setId(id)

Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. La mutazione dei widget è supportata solo nei componenti aggiuntivi.

Parametri

NomeTipoDescrizione
idStringL'ID del widget, con un limite di 64 caratteri e nel formato `[a-zA-Z0-9-]+`.

Indietro

Widget: questo oggetto, per il concatenamento.

setNumColumns(numColumns)

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

Parametri

NomeTipoDescrizione
numColumnsIntegerIl numero di colonne.

Indietro

Grid: questo oggetto, per il concatenamento.

setOnClickAction(action)

Imposta un'azione da eseguire quando si fa clic sull'oggetto. Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

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

// ...

const 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 intraprendere quando si fa clic su questo elemento.

Indietro

Grid: questo oggetto, per il concatenamento.

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL deve essere creato o quando devi eseguire altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere impostato solo uno dei seguenti valori: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

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

// ...

const 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 del link da eseguire quando si fa clic su questo elemento.

Indietro

Grid: questo oggetto, per il concatenamento.

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

Parametri

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

Indietro

Grid: questo oggetto, per il concatenamento.

setTitle(title)

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

Parametri

NomeTipoDescrizione
titleStringIl testo del titolo.

Indietro

Grid: questo oggetto, per il concatenamento.

setVisibility(visibility)

Imposta la visibilità del widget. Il valore predefinito è "VISIBLE".

Parametri

NomeTipoDescrizione
visibilityVisibilityIl Visibility del widget.

Indietro

Widget: l'oggetto, per il concatenamento.