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 viene fatto clic sull'oggetto.
setBorderStyle(borderStyle)GridImposta lo stile del bordo applicato a ciascun elemento della griglia.
setComposeAction(action, composedEmailType)GridImposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto.
setNumColumns(numColumns)GridIl numero di colonne da visualizzare nella griglia.
setOnClickAction(action)GridImposta un'azione che viene eseguita quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)GridImposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto.
setOpenLink(openLink)GridImposta un URL da aprire quando viene fatto 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.

Ritorni

Grid: questo oggetto per il concatenamento.


setAuthorizationAction(action)

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

Per un oggetto UI è possibile impostare solo uno 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 viene fatto clic su questo elemento.

Ritorni

Grid: questo oggetto per il concatenamento.


setBorderStyle(borderStyle)

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

Parametri

NomeTipoDescrizione
borderStyleBorderStyleLo stile del bordo da applicare.

Ritorni

Grid: questo oggetto per il concatenamento.


setComposeAction(action, composedEmailType)

Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. Per un oggetto UI è possibile impostare 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 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 viene fatto clic su questo elemento.
composedEmailTypeComposedEmailTypeUn valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Ritorni

Grid: questo oggetto per il concatenamento.


setNumColumns(numColumns)

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

Parametri

NomeTipoDescrizione
numColumnsIntegerIl numero di colonne.

Ritorni

Grid: questo oggetto per il concatenamento.


setOnClickAction(action)

Imposta un'azione che viene eseguita quando si fa clic sull'oggetto. 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 restituisce 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 viene fatto clic su questo elemento.

Ritorni

Grid: questo oggetto per il concatenamento.


setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando è necessario creare l'URL o quando devi eseguire altre azioni in aggiunta alla creazione dell'oggetto OpenLink. Per un oggetto UI è possibile impostare un solo elemento 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).

// ...

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 viene fatto clic su questo elemento.

Ritorni

Grid: questo oggetto per il concatenamento.


Imposta un URL da aprire quando viene fatto clic sull'oggetto. Usa questa funzione quando l'URL è già noto e deve essere solo 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.

Ritorni

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.

Ritorni

Grid: questo oggetto per il concatenamento.