Class Image

Imagen

Es un widget que muestra una sola imagen. Para obtener información sobre cómo recortar imágenes, consulta ImageCropStyle.

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

const image = CardService.newImage()
                  .setAltText('A nice image')
                  .setImageUrl('https://image.png');

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setAltText(altText)	Image	Establece el texto alternativo de la imagen para la accesibilidad.
setAuthorizationAction(action)	Image	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)	Image	Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto.
setImageUrl(url)	Image	Establece la imagen que se usará proporcionando su URL o cadena de datos.
setOnClickAction(action)	Image	Establece una acción que se ejecuta cuando se hace clic en el objeto.
setOnClickOpenLinkAction(action)	Image	Establece una acción que abre una URL en una pestaña cuando se hace clic en el objeto.
setOpenLink(openLink)	Image	Establece una URL que se abrirá cuando se haga clic en el objeto.

Documentación detallada

setAltText(altText)

Establece el texto alternativo de la imagen para la accesibilidad. Obligatorio.

Parámetros

Nombre	Tipo	Descripción
altText	String	Es el texto alternativo que se asignará a esta imagen.

Volver

Image: Este objeto, para encadenar.

---

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. Se abrirá la URL en una ventana nueva. Cuando el usuario finaliza el flujo de autorización y vuelve a la aplicación, se vuelve a cargar el complemento.

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

// ...

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

Parámetros

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

Volver

Image: Este objeto, para encadenar.

---

setComposeAction(action, composedEmailType)

Establece una acción que componga un borrador de correo electrónico cuando se haga clic en el objeto. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

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 Compose que se use para extender la IU de Compose. En cambio, este método conecta este elemento de la IU a un Action que compone borradores de mensajes 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() {
  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	Es el objeto que especifica la acción de composición que se debe realizar cuando se hace clic en este elemento.
composedEmailType	ComposedEmailType	Un valor de enumeración que especifica si el borrador compuesto es independiente o de respuesta.

Volver

Image: Este objeto, para encadenar.

---

setImageUrl(url)

Establece la imagen que se usará proporcionando su URL o cadena de datos. Obligatorio.

La URL proporcionada puede ser una URL de acceso público o una cadena de imagen codificada en base64. Para obtener lo último, puedes usar el siguiente código para crear una cadena de imagen codificada a partir de una imagen en tu Google Drive y, luego, almacenar esa cadena para usarla más adelante con setImageUrl(url). Este método evita que el complemento deba acceder a una URL de imagen disponible públicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

Parámetros

Nombre	Tipo	Descripción
url	String	Es la dirección URL de una imagen alojada que se usará o una cadena de imagen codificada.

Volver

Image: Este objeto, para encadenar.

---

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 setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

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	Es la acción que se debe realizar cuando se hace clic en este elemento.

Volver

Image: Este objeto, para encadenar.

---

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 debas realizar otras acciones además de crear el objeto OpenLink. Un objeto de IU solo puede tener uno de setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType) configurado.

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	Es el objeto que especifica la acción de abrir vínculo que se debe realizar cuando se hace clic en este elemento.

Volver

Image: Este objeto, para encadenar.

---

setOpenLink(openLink)

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

Parámetros

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

Volver

Image: Este objeto, para encadenar.