Class Image

Imagen

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

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

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

Métodos

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

Parámetros

NombreTipoDescripción
altTextStringEl texto alternativo para asignar a esta imagen.

Devolvedor

Image: Este objeto se usa 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 regresa a la aplicación, el complemento se vuelve a cargar.

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

// ...

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

Parámetros

NombreTipoDescripción
actionAuthorizationActionEs el objeto que especifica la acción de autorización que se realizará cuando se haga clic en este elemento.

Devolvedor

Image: Este objeto se usa para encadenar.


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 IU solo puede tener configurado 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).

// ...

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
actionActionEs el objeto que especifica la acción de composición que se realizará cuando se haga clic en este elemento.
composedEmailTypeComposedEmailTypeUn valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta.

Devolvedor

Image: Este objeto se usa 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 este último, puedes usar el siguiente código a fin de crear una string de imagen codificada a partir de una imagen en tu unidad de Google Drive y, luego, almacenar esa string para usarla más adelante con setImageUrl(url). Este método evita la necesidad de que tu complemento acceda a una URL de imagen disponible de forma pública:

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

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

Parámetros

NombreTipoDescripción
urlStringEs la dirección URL de una imagen alojada que se usará, o bien una cadena de imagen codificada.

Devolvedor

Image: Este objeto se usa 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 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.

// ...

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.

Devolvedor

Image: Este objeto se usa 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 necesites 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 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).

// ...

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
actionActionEs el objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento.

Devolvedor

Image: Este objeto se usa para encadenar.


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

Parámetros

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

Devolvedor

Image: Este objeto se usa para encadenar.