Esta página foi traduzida pela API Cloud Translation.

Class Grid

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

Disponível nos complementos do Google Workspace e nos apps do Google Chat.

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

Métodos

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

Documentação detalhada

`addItem(gridItem)`

Adiciona um novo item à grade.

Parâmetros

Nome	Tipo	Descrição
`gridItem`	`GridItem`	O 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 será aberto em uma nova janela. Quando o usuário termina o fluxo de autorização e retornar ao aplicativo, o complemento será recarregado.

Um objeto da interface só pode ter um conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

// ...

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

Parâmetros

Nome	Tipo	Descrição
`action`	`AuthorizationAction`	O objeto que especifica a ação de autorização a ser tomada quando esse elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.

`setBorderStyle(borderStyle)`

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

Parâmetros

Nome	Tipo	Descrição
`borderStyle`	`BorderStyle`	O estilo de borda a ser aplicado.

Retornar

Grid: este objeto, para encadeamento.

`setComposeAction(action, composedEmailType)`

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

O parâmetro Action precisa especificar uma função de callback que retorna um objeto ComposeActionResponse configurado usando ComposeActionResponseBuilder.setGmailDraft(draft).

Observação: esse método não define uma ação de composição que seja usada para estender a interface do Compose. Em vez disso, esse método conecta esse elemento de interface a uma Action, que compõe mensagens de rascunho no Apps Script que são: aberto no Gmail quando a ação for concluída.

// ...

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();
}

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de composição a ser executada quando esse elemento for clicado.
`composedEmailType`	`ComposedEmailType`	Um valor de enumeração que especifica se o rascunho composto é uma independente ou como rascunho de resposta.

Retornar

Grid: este objeto, para encadeamento.

`setNumColumns(numColumns)`

O número de colunas a serem exibidas na grade. No painel à direita, é possível exibir de 1 a 2 colunas, e o valor padrão é 1. Se aparecer em uma caixa de diálogo, você pode exibir de 2 a 3 colunas e o valor padrão é 2.

Parâmetros

Nome	Tipo	Descrição
`numColumns`	`Integer`	O 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 Conjunto setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType).

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

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	A ação a ser realizada quando esse elemento é 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 O URL precisa ser criado ou quando você precisa realizar outras ações além da criação do objeto OpenLink. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) ou setComposeAction(action, composedEmailType) definido.

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

Parâmetros

Nome	Tipo	Descrição
`action`	`Action`	O objeto que especifica a ação de abrir link a ser executada quando esse elemento for clicado.

Retornar

Grid: este objeto, para encadeamento.

`setOpenLink(openLink)`

Define um URL que será aberto quando o objeto for clicado. Use essa função quando o URL já estiver conhecidas e só precisam ser abertas. Um objeto da interface só pode ter setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) e setAuthorizationAction(action). ou setComposeAction(action, composedEmailType) definido.

Parâmetros

Nome	Tipo	Descrição
`openLink`	`OpenLink`	Um 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

Nome	Tipo	Descrição
`title`	`String`	O texto do título.

Retornar

Grid: este objeto, para encadeamento.