Class Grid

Cuadrícula

Cuadrícula organizada para mostrar una colección de elementos de cuadrícula.

Está disponible para los complementos de Google Workspace y las apps de Google Chat.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
addItem(gridItem)GridAgrega un nuevo elemento a la cuadrícula.
setAuthorizationAction(action)GridEstablece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic.
setBorderStyle(borderStyle)GridEstablece el estilo de borde aplicado a cada elemento de la cuadrícula.
setComposeAction(action, composedEmailType)GridEstablece una acción para redactar un borrador de correo electrónico cuando se hace clic en el objeto.
setNumColumns(numColumns)GridLa cantidad de columnas que se mostrarán en la cuadrícula.
setOnClickAction(action)GridEstablece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)GridEstablece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)GridConfigura una URL que se abrirá cuando se haga clic en el objeto.
setTitle(title)GridEstablece el texto del título de la cuadrícula.

Documentación detallada

addItem(gridItem)

Agrega un nuevo elemento a la cuadrícula.

Parámetros

NombreTipoDescripción
gridItemGridItemEl elemento de la cuadrícula a agregar.

Volver

Grid: Este objeto para el encadenamiento.


setAuthorizationAction(action)

Establece una acción de autorización que abre una URL al flujo de autorización cuando el objeto se hizo clic. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y vuelve a la aplicación, el complemento se vuelve a cargar.

Un objeto de IU solo puede tener establecido uno de los siguientes valores: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

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

Parámetros

NombreTipoDescripción
actionAuthorizationActionEl objeto que especifica la acción de autorización que se debe realizar cuando este elemento se se hizo clic.

Volver

Grid: Este objeto para el encadenamiento.


setBorderStyle(borderStyle)

Establece el estilo de borde aplicado a cada elemento de la cuadrícula. El valor predeterminado es NO_BORDER.

Parámetros

NombreTipoDescripción
borderStyleBorderStyleEs el estilo de borde que se aplicará.

Volver

Grid: Este objeto para el encadenamiento.


setComposeAction(action, composedEmailType)

Establece una acción para redactar un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de estos valores: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) setAuthorizationAction(action) o setComposeAction(action, composedEmailType) establecido.

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ComposeActionResponse configurado con 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();
}

Parámetros

NombreTipoDescripción
actionActionEl objeto que especifica la acción de composición que se debe realizar cuando este elemento se se hizo clic.
composedEmailTypeComposedEmailTypeUn valor enum que especifica si el borrador compuesto es una independiente o como borrador de respuesta.

Volver

Grid: Este objeto para el encadenamiento.


setNumColumns(numColumns)

La cantidad de columnas que se mostrarán en la cuadrícula. Si aparece en el panel lateral derecho, puedes mostrar De 1 a 2 columnas, y el valor predeterminado es 1. Si aparece en un diálogo, puedes mostrar 2 o 3 columnas y el valor predeterminado es 2.

Parámetros

NombreTipoDescripción
numColumnsIntegerEl número de columnas.

Volver

Grid: Este objeto para el encadenamiento.


setOnClickAction(action)

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de IU solo puede tener uno de Se establecieron setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un 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

NombreTipoDescripción
actionActionLa acción que se debe realizar cuando se hace clic en este elemento.

Volver

Grid: Este objeto para el encadenamiento.


setOnClickOpenLinkAction(action)

Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto. Usa esta función cuando Es necesario crear la URL o cuando debes realizar otras acciones adicionales para crear el objeto OpenLink. Un objeto de IU solo puede tener setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o Se estableció setComposeAction(action, composedEmailType).

El parámetro Action debe especificar una función de devolución de llamada que muestre un objeto ActionResponse configurado con 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

NombreTipoDescripción
actionActionEl objeto que especifica la acción de vínculo abierto que se debe realizar cuando este elemento se se hizo clic.

Volver

Grid: Este objeto para el encadenamiento.


Configura una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya sea conocido y solo necesita abrirse. Un objeto de IU solo puede tener setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action) y setAuthorizationAction(action) o setComposeAction(action, composedEmailType) establecido.

Parámetros

NombreTipoDescripción
openLinkOpenLinkUn objeto OpenLink que describe la URL que se abrirá.

Volver

Grid: Este objeto para el encadenamiento.


setTitle(title)

Establece el texto del título de la cuadrícula. El texto debe ser una cadena sin formato y sin formato.

Parámetros

NombreTipoDescripción
titleStringEs el texto del título.

Volver

Grid: Este objeto para el encadenamiento.