Class ImageButton

ImageButton

Un ImageButton con una imagen que se muestra en él.

Disponible para complementos de Google Workspace y apps de Google Chat.

const imageButton =
    CardService.newImageButton()
        .setAltText('An image button with an airplane icon.')
        .setIcon(CardService.Icon.AIRPLANE)
        .setOpenLink(CardService.newOpenLink().setUrl('https://airplane.com'));

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
setAltText(altText)	ImageButton	Establece el texto alternativo del botón para la accesibilidad.
setAuthorizationAction(action)	ImageButton	Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto.
setComposeAction(action, composedEmailType)	ImageButton	Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto.
setIcon(icon)	ImageButton	Establece un Icon predefinido para mostrarlo en el botón.
setIconUrl(url)	ImageButton	Establece la URL de una imagen para usarla como ícono de este botón.
setImageButtonStyle(imageButtonStyle)	ImageButton	Establece el estilo del botón.
setMaterialIcon(icon)	ImageButton	Establece el ícono de Material Design.
setOnClickAction(action)	ImageButton	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	ImageButton	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	ImageButton	Establece una URL que se abrirá cuando se haga clic en el objeto.
setOverflowMenu(menu)	ImageButton	Establece un menú emergente que se abrirá cuando se haga clic en el objeto.

Documentación detallada

setAltText(altText)

Establece el texto alternativo del botón para la accesibilidad. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
altText	String	El texto alternativo que se asignará a este botón.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setAuthorizationAction(action)

Establece una acción de autorización que abre una URL al flujo de autorización cuando se hace clic en el objeto. Esto abre la URL en una ventana nueva. Cuando el usuario termina el flujo de autorización y regresa a la aplicación, se vuelve a cargar el complemento.

Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

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

Parámetros

Nombre	Tipo	Descripción
action	AuthorizationAction	El objeto que especifica la acción de autorización que se debe realizar cuando se hace clic en este elemento.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setComposeAction(action, composedEmailType)

Establece una acción que redacta un borrador de correo electrónico cuando se hace clic en el objeto. Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: 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 ComposeActionResponse configurado con ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: Este método no establece una acción de redacción que se use para extender la IU de redacción. En cambio, este método conecta este elemento de la IU a un Action que redacta mensajes de borrador en Apps Script que se abren en Gmail cuando se completa la acción.

// ...

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

Nombre	Tipo	Descripción
action	Action	El objeto que especifica la acción de redacción que se debe realizar cuando se hace clic en este elemento.
composedEmailType	ComposedEmailType	Un valor de enum que especifica si el borrador redactado es un borrador independiente o de respuesta.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setIcon(icon)

Establece un Icon predefinido para mostrarlo en el botón. Se debe usar este o setIconUrl(url) para definir la imagen del botón.

Parámetros

Nombre	Tipo	Descripción
icon	Icon	Uno de los valores Icon predefinidos.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setIconUrl(url)

Establece la URL de una imagen para usarla como ícono de este botón. Se debe usar este o setIcon(icon) para definir la imagen del botón.

Parámetros

Nombre	Tipo	Descripción
url	String	La dirección URL de una imagen alojada para usarla como ícono de este botón.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setImageButtonStyle(imageButtonStyle)

Establece el estilo del botón. Si no se establece, el valor predeterminado es el botón ImageButtonStyle.BORDERLESS.

Disponible para apps de Google Chat. En versión preliminar para desarrolladores para complementos de Google Workspace.

Versión preliminar para desarrolladores: Disponible como parte del Programa de versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.

const imageButton = CardService.newImageButton().setImageButtonStyle(
    CardService.ImageButtonStyle.BORDERLESS,
);

Parámetros

Nombre	Tipo	Descripción
imageButtonStyle	ImageButtonStyle	El estilo del botón.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setMaterialIcon(icon)

Establece el ícono de Material Design.

const imageButton = CardService.newImageButton().setMaterialIcon(
    CardService.newMaterialIcon().setName('search'),
);

Parámetros

Nombre	Tipo	Descripción
icon	MaterialIcon	El ícono de Material Design.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setOnClickAction(action)

Establece una acción que se ejecuta cuando se hace clic en el objeto. Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: 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.

// ...

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

Nombre	Tipo	Descripción
action	Action	La acción que se debe realizar cuando se hace clic en este elemento.

Volver

ImageButton: 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 se deba compilar la URL o cuando necesites realizar otras acciones además de crear el objeto OpenLink. Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: 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 configurado con 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

Nombre	Tipo	Descripción
action	Action	El objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setOpenLink(openLink)

Establece una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya se conozca y solo deba abrirse. Un objeto de la IU solo puede tener uno de los siguientes parámetros establecidos: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parámetros

Nombre	Tipo	Descripción
openLink	OpenLink	Un objeto OpenLink que describe la URL que se abrirá.

Volver

ImageButton: Este objeto, para el encadenamiento.

---

setOverflowMenu(menu)

Establece un menú emergente que se abrirá cuando se haga clic en el objeto. Cada elemento del menú puede especificar una acción que se activará cuando se haga clic en él. No se admiten menús anidados, las acciones de los elementos de menú no deben especificar un menú ampliado.

Disponible para apps de Google Chat. En versión preliminar para desarrolladores para complementos de Google Workspace.

Versión preliminar para desarrolladores: Disponible como parte del Programa de versión preliminar para desarrolladores de Google Workspace, que otorga acceso anticipado a ciertas funciones.

const overflowMenuItem =
    CardService.newOverflowMenuItem()
        .setStartIcon(
            CardService.newIconImage().setIconUrl(
                'https://www.google.com/images/branding/googleg/1x/googleg_standard_color_64dp.png',
                ),
            )
        .setText('Open Link')
        .setOpenLink(
            CardService.newOpenLink().setUrl('https://www.google.com'));

const overflowMenu =
    CardService.newOverflowMenu().addMenuItem(overflowMenuItem).build();

Parámetros

Nombre	Tipo	Descripción
menu	OverflowMenu	El objeto que especifica el menú ampliado que se mostrará cuando se haga clic en este elemento.

Volver

ImageButton: Este objeto, para el encadenamiento.