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étodo | Tipo de retorno | Breve descrição |
---|---|---|
add | Grid | Adiciona um novo item à grade. |
set | Grid | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
set | Grid | Define o estilo de borda aplicado a cada item da grade. |
set | Grid | Define uma ação que compõe um e-mail de rascunho quando o objeto é clicado. |
set | Grid | O número de colunas a serem exibidas na grade. |
set | Grid | Define uma ação que é executada quando o objeto é clicado. |
set | Grid | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
set | Grid | Define um URL para ser aberto quando o objeto é clicado. |
set | Grid | Define o texto do título da grade. |
Documentação detalhada
add Item(gridItem)
set Authorization Action(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: set
, set
, set
, set
ou set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
action | Authorization | O objeto que especifica a ação de autorização a ser realizada quando este elemento for clicado. |
Retornar
Grid
: este objeto, para encadeamento.
set Border Style(borderStyle)
Define o estilo de borda aplicado a cada item da grade. O padrão é NO_BORDER.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
border | Border | O estilo da borda a ser aplicado. |
Retornar
Grid
: este objeto, para encadeamento.
set Compose Action(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 set
, set
, set
,
set
ou set
definidos.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto Compose
configurado usando Compose
.
// ... 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
Nome | Tipo | Descrição |
---|---|---|
action | Action | O objeto que especifica a ação de composição a ser realizada quando este elemento é clicado. |
composed | Composed | Um valor de tipo enumerado que especifica se o rascunho composto é independente ou de resposta. |
Retornar
Grid
: este objeto, para encadeamento.
set Num Columns(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
Nome | Tipo | Descrição |
---|---|---|
num | Integer | O número de colunas. |
Retornar
Grid
: este objeto, para encadeamento.
set On Click Action(action)
Define uma ação que é executada quando o objeto é clicado. Um objeto de interface só pode ter um dos
set
, set
, set
, set
ou set
definidos.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto Action
.
// ... 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
Nome | Tipo | Descrição |
---|---|---|
action | Action | A ação a ser realizada quando esse elemento for clicado. |
Retornar
Grid
: este objeto, para encadeamento.
set On Click Open Link Action(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 Open
. Um objeto de interface só pode ter um dos seguintes valores definidos: set
, set
, set
, set
ou
set
.
O parâmetro Action
precisa especificar uma função de callback que retorne um objeto Action
configurado usando Action
.
// ... 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
Nome | Tipo | Descrição |
---|---|---|
action | Action | O objeto que especifica a ação de abrir link a ser realizada quando este elemento for clicado. |
Retornar
Grid
: este objeto, para encadeamento.
set Open Link(openLink)
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 set
,
set
, set
, set
ou set
definidos.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
open | Open | Um objeto Open que descreve o URL a ser aberto. |
Retornar
Grid
: este objeto, para encadeamento.
set Title(title)
Define o texto do título da grade. O texto precisa ser uma string simples sem formatação.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
title | String | O texto do título. |
Retornar
Grid
: este objeto, para encadeamento.