Class Image

Image

Un widget che mostra una singola immagine. Per informazioni sul ritaglio delle immagini, vedi ImageCropStyle.

Disponibile per i componenti aggiuntivi di Google Workspace e le app di Google Chat.

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

Metodi

Metodo	Tipo restituito	Breve descrizione
addEventAction(eventAction)	Widget	Aggiunge l'azione evento che può essere eseguita sul widget.
setAltText(altText)	Image	Imposta il testo alternativo dell'immagine per l'accessibilità.
setAuthorizationAction(action)	Image	Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto.
setComposeAction(action, composedEmailType)	Image	Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto.
setId(id)	Widget	Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare.
setImageUrl(url)	Image	Imposta l'immagine da utilizzare fornendo il relativo URL o la stringa di dati.
setOnClickAction(action)	Image	Imposta un'azione che viene eseguita quando si fa clic sull'oggetto.
setOnClickOpenLinkAction(action)	Image	Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto.
setOpenLink(openLink)	Image	Imposta un URL da aprire quando si fa clic sull'oggetto.
setVisibility(visibility)	Widget	Imposta la visibilità del widget.

Documentazione dettagliata

addEventAction(eventAction)

Aggiunge l'azione evento che può essere eseguita sul widget.

Parametri

Nome	Tipo	Descrizione
eventAction	EventAction	Il EventAction da aggiungere.

Indietro

Widget : l'oggetto, per il concatenamento.

---

setAltText(altText)

Imposta il testo alternativo dell'immagine per l'accessibilità. Obbligatorio.

Parametri

Nome	Tipo	Descrizione
altText	String	Il testo alternativo da assegnare a questa immagine.

Indietro

Image : questo oggetto, per il concatenamento.

---

setAuthorizationAction(action)

Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando si fa clic sull'oggetto. L'URL viene aperto in una nuova finestra. Quando l'utente completa il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.

Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

// ...

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

Parametri

Nome	Tipo	Descrizione
action	AuthorizationAction	L'oggetto che specifica l'azione di autorizzazione da intraprendere quando si fa clic su questo elemento.

Indietro

Image : questo oggetto, per il concatenamento.

---

setComposeAction(action, composedEmailType)

Imposta un'azione che compone una bozza di email quando si fa clic sull'oggetto. Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto ComposeActionResponse configurato utilizzando ComposeActionResponseBuilder.setGmailDraft(draft).

Nota: questo metodo non imposta un'azione di composizione utilizzata per estendere l'interfaccia utente di composizione. Questo metodo, invece, collega questo elemento dell'interfaccia utente a un'Action che compone bozze di messaggi in Apps Script che vengono aperte in Gmail al completamento dell'azione.

// ...

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();
}

Parametri

Nome	Tipo	Descrizione
action	Action	L'oggetto che specifica l'azione di composizione da intraprendere quando si fa clic su questo elemento.
composedEmailType	ComposedEmailType	Un valore enum che specifica se la bozza composta è una bozza autonoma o di risposta.

Indietro

Image : questo oggetto, per il concatenamento.

---

setId(id)

Imposta l'ID univoco assegnato utilizzato per identificare il widget da modificare. La mutazione dei widget è supportata solo nei componenti aggiuntivi.

Parametri

Nome	Tipo	Descrizione
id	String	L'ID del widget, con un limite di 64 caratteri e nel formato `[a-zA-Z0-9-]+`.

Indietro

Widget : questo oggetto, per il concatenamento.

---

setImageUrl(url)

Imposta l'immagine da utilizzare fornendo il relativo URL o la stringa di dati. Obbligatorio.

L'URL fornito può essere un URL accessibile pubblicamente o una stringa di immagine codificata in base64. Per ottenere quest'ultima, puoi utilizzare il seguente codice per creare una stringa di immagine codificata da un'immagine in Google Drive, quindi memorizzare la stringa per un utilizzo successivo con setImageUrl(url). Questo metodo evita che il componente aggiuntivo debba accedere a un URL di immagine disponibile pubblicamente:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').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).

Parametri

Nome	Tipo	Descrizione
url	String	L'indirizzo URL di un'immagine ospitata da utilizzare o una stringa di immagine codificata.

Indietro

Image : questo oggetto, per il concatenamento.

---

setOnClickAction(action)

Imposta un'azione che viene eseguita quando si fa clic sull'oggetto. Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto 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();
}

Parametri

Nome	Tipo	Descrizione
action	Action	L'azione da intraprendere quando si fa clic su questo elemento.

Indietro

Image : questo oggetto, per il concatenamento.

---

setOnClickOpenLinkAction(action)

Imposta un'azione che apre un URL in una scheda quando si fa clic sull'oggetto. Utilizza questa funzione quando è necessario creare l'URL o quando devi intraprendere altre azioni oltre alla creazione dell'oggetto OpenLink. Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Il parametro Action deve specificare una funzione di callback che restituisce un oggetto ActionResponse configurato utilizzando 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();
}

Parametri

Nome	Tipo	Descrizione
action	Action	L'oggetto che specifica l'azione di apertura del link da intraprendere quando si fa clic su questo elemento.

Indietro

Image : questo oggetto, per il concatenamento.

---

setOpenLink(openLink)

Imposta un URL da aprire quando si fa clic sull'oggetto. Utilizza questa funzione quando l'URL è già noto e deve essere aperto. Un oggetto UI può avere impostato solo uno tra setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) o setComposeAction(action, composedEmailType).

Parametri

Nome	Tipo	Descrizione
openLink	OpenLink	Un OpenLink oggetto che descrive l'URL da aprire.

Indietro

Image : questo oggetto, per il concatenamento.

---

setVisibility(visibility)

Imposta la visibilità del widget. Il valore predefinito è `VISIBLE`.

Parametri

Nome	Tipo	Descrizione
visibility	Visibility	La Visibility del widget.

Indietro

Widget : l'oggetto, per il concatenamento.