Class Grid

Grade

Uma grade organizada para mostrar uma coleção de itens.

Disponível para os apps do Google Workspace Add-ons e do Google Chat.

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

Métodos

MétodoTipo de retornoBreve descrição
addItem(gridItem)GridAdiciona um novo item à grade.
setAuthorizationAction(action)GridDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBorderStyle(borderStyle)GridDefine o estilo de borda aplicado a cada item da grade.
setComposeAction(action, composedEmailType)GridDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setNumColumns(numColumns)GridO número de colunas a serem exibidas na grade.
setOnClickAction(action)GridDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)GridDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)GridDefine um URL para ser aberto quando o objeto é clicado.
setTitle(title)GridDefine o texto do título da grade.

Documentação detalhada

addItem(gridItem)

Adiciona um novo item à grade.

Parâmetros

NomeTipoDescrição
gridItemGridItemO item da grade a ser adicionado.

Retornar

Grid: este objeto, para encadeamento.


setAuthorizationAction(action)

Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. O URL vai ser aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retorna ao aplicativo, o complemento é recarregado.

Um objeto de interface só pode ter um dos seguintes valores definidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

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

Parâmetros

NomeTipoDescrição
actionAuthorizationActionO objeto que especifica a ação de autorização a ser realizada quando este elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.


setBorderStyle(borderStyle)

Define o estilo de borda aplicado a cada item da grade. O padrão é NO_BORDER.

Parâmetros

NomeTipoDescrição
borderStyleBorderStyleO estilo da borda a ser aplicado.

Retornar

Grid: este objeto, para encadeamento.


setComposeAction(action, composedEmailType)

Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ComposeActionResponse configurado usando 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();
}

Parâmetros

NomeTipoDescrição
actionActionO objeto que especifica a ação de composição a ser realizada quando este elemento é clicado.
composedEmailTypeComposedEmailTypeUm valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta.

Retornar

Grid: este objeto, para encadeamento.


setNumColumns(numColumns)

O número de colunas a serem exibidas na grade. Se mostrado no painel lateral direito, você pode mostrar de 1 a 2 colunas, e o valor padrão é 1. Se mostrado em uma caixa de diálogo, você pode exibir de duas a três colunas, e o valor padrão é 2.

Parâmetros

NomeTipoDescrição
numColumnsIntegerO número de colunas.

Retornar

Grid: este objeto, para encadeamento.


setOnClickAction(action)

Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

O parâmetro Action precisa especificar uma função de callback que retorne um objeto 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();
}

Parâmetros

NomeTipoDescrição
actionActionA ação a ser realizada quando esse elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.


setOnClickOpenLinkAction(action)

Define uma ação que abre um URL em uma guia quando o objeto é clicado. Use essa função quando o URL precisar ser criado ou quando você precisar realizar outras ações além de criar o objeto OpenLink. Um objeto de interface só pode ter um dos seguintes valores definidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

O parâmetro Action precisa especificar uma função de callback que retorne um objeto ActionResponse configurado usando 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();
}

Parâmetros

NomeTipoDescrição
actionActionO objeto que especifica a ação de abrir link a ser realizada quando este elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.


Define um URL para ser aberto quando o objeto é clicado. Use essa função quando o URL já é conhecido e só precisa ser aberto. Um objeto de interface só pode ter um dos setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definidos.

Parâmetros

NomeTipoDescrição
openLinkOpenLinkUm objeto OpenLink que descreve o URL a ser aberto.

Retornar

Grid: este objeto, para encadeamento.


setTitle(title)

Define o texto do título da grade. O texto precisa ser uma string simples sem formatação.

Parâmetros

NomeTipoDescrição
titleStringO texto do título.

Retornar

Grid: este objeto, para encadeamento.