Un widget que muestra una sola imagen. Para obtener información sobre cómo recortar imágenes, consulta ImageCropStyle
.
var 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 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 redacta un borrador de correo electrónico cuando se hace clic en el objeto. |
setImageUrl(url) | Image | Configura la imagen que se usará al proporcionar su URL o string 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 para abrir una URL en una pestaña cuando se hace clic en el objeto. |
setOpenLink(openLink) | Image | Configura 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 accesibilidad. Obligatorio.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
altText | String | Texto alternativo para asignar a esta imagen. |
Volver
Image
: Es 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 regresa a la aplicación, el complemento se vuelve a cargar.
Un objeto de IU solo puede tener 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
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
Image
: Es este objeto 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 uno de los siguientes valores: 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
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 | Es un valor de enumeración que especifica si el borrador compuesto es un borrador independiente o de respuesta. |
Volver
Image
: Es este objeto para encadenar.
setImageUrl(url)
Configura la imagen que se usará al proporcionar su URL o string de datos. Obligatorio.
La URL proporcionada puede ser una URL de acceso público o una string de imagen codificada en Base64.
Para obtener este último, puedes usar el siguiente código a fin de crear una string de imagen codificada en una imagen de tu unidad de Google Drive. Luego, almacena esa string para usarla más tarde con setImageUrl(url)
. Este método evita la necesidad de que tu complemento acceda a una URL de imagen 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
Nombre | Tipo | Descripción |
---|---|---|
url | String | La dirección URL de una imagen alojada para usar o una string de imagen codificada. |
Volver
Image
: Es 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 los siguientes valores: 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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | La acción que se debe realizar cuando se hace clic en este elemento. |
Volver
Image
: Es este objeto para encadenar.
setOnClickOpenLinkAction(action)
Establece una acción para abrir 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 IU solo puede tener uno de los siguientes valores: 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)
.
// ... 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
Nombre | Tipo | Descripción |
---|---|---|
action | Action | El objeto que especifica la acción de vínculo abierto que se realizará cuando se haga clic en este elemento. |
Volver
Image
: Es este objeto para encadenar.
setOpenLink(openLink)
Configura una URL que se abrirá cuando se haga clic en el objeto. Usa esta función cuando la URL ya sea conocida y solo deba abrirse. Un objeto de IU solo puede tener uno de los siguientes valores: 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
Image
: Es este objeto para encadenar.