Un widget che mostra una singola immagine. Per informazioni su come ritagliare le immagini, vedi ImageCropStyle
.
Disponibile per i componenti aggiuntivi di Google Workspace e le app Google Chat.
var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
setAltText(altText) | Image | Consente di impostare 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 viene fatto clic sull'oggetto. |
setComposeAction(action, composedEmailType) | Image | Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. |
setImageUrl(url) | Image | Imposta l'immagine da utilizzare specificando l'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 viene fatto clic sull'oggetto. |
setOpenLink(openLink) | Image | Imposta un URL da aprire quando viene fatto clic sull'oggetto. |
Documentazione dettagliata
setAltText(altText)
Consente di impostare il testo alternativo dell'immagine per l'accessibilità. obbligatorio.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
altText | String | Il testo alternativo da assegnare a questa immagine. |
Ritorni
Image
: questo oggetto per il concatenamento.
setAuthorizationAction(action)
Imposta un'azione di autorizzazione che apre un URL al flusso di autorizzazione quando viene fatto clic sull'oggetto. L'URL si apre in una nuova finestra. Quando l'utente termina il flusso di autorizzazione e torna all'applicazione, il componente aggiuntivo viene ricaricato.
Per un oggetto UI è possibile impostare solo uno tra setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
.
// ... var 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 eseguire quando viene fatto clic su questo elemento. |
Ritorni
Image
: questo oggetto per il concatenamento.
setComposeAction(action, composedEmailType)
Imposta un'azione che scrive una bozza di email quando viene fatto clic sull'oggetto. Per un oggetto UI
è possibile impostare 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)
.
// ... 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di scrittura da eseguire quando viene fatto clic su questo elemento. |
composedEmailType | ComposedEmailType | Un valore enum che specifica se la bozza composta è una bozza autonoma o di risposta. |
Ritorni
Image
: questo oggetto per il concatenamento.
setImageUrl(url)
Imposta l'immagine da utilizzare specificando l'URL o la stringa di dati. obbligatorio.
L'URL fornito può essere un URL pubblicamente accessibile o una stringa immagine codificata in Base64.
Per ottenere quest'ultimo, puoi utilizzare il seguente codice per creare una stringa immagine codificata da un'immagine nel tuo Google Drive, quindi archiviare la stringa per utilizzarla in un secondo momento con setImageUrl(url)
. Questo metodo impedisce al componente aggiuntivo di accedere a un URL immagine disponibile pubblicamente:
// 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).
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | L'indirizzo URL di un'immagine ospitata da utilizzare o una stringa immagine codificata. |
Ritorni
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 solo uno tra
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
impostato.
Il parametro Action
deve specificare una funzione di callback che restituisce un oggetto 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'azione da eseguire quando viene fatto clic su questo elemento. |
Ritorni
Image
: questo oggetto per il concatenamento.
setOnClickOpenLinkAction(action)
Imposta un'azione che apre un URL in una scheda quando viene fatto clic sull'oggetto. Utilizza questa funzione quando
è necessario creare l'URL o quando devi eseguire altre azioni in aggiunta alla creazione dell'oggetto OpenLink
. Per un oggetto UI è possibile impostare un solo elemento 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)
.
// ... 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(); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
action | Action | L'oggetto che specifica l'azione di apertura link da eseguire quando viene fatto clic su questo elemento. |
Ritorni
Image
: questo oggetto per il concatenamento.
setOpenLink(openLink)
Imposta un URL da aprire quando viene fatto clic sull'oggetto. Usa questa funzione quando l'URL è già noto e deve essere solo aperto. Un oggetto UI può avere solo uno tra setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
o setComposeAction(action, composedEmailType)
impostato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
openLink | OpenLink | Un oggetto OpenLink che descrive l'URL da aprire. |
Ritorni
Image
: questo oggetto per il concatenamento.