Ein Widget, das ein einzelnes Bild zeigt. Informationen zum Zuschneiden von Bildern finden Sie unter Image
.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
const image = CardService.newImage() .setAltText('A nice image') .setImageUrl('https://image.png');
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
set | Image | Hier legen Sie den alternativen Text des Bilds für mehr Barrierefreiheit fest. |
set | Image | Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. |
set | Image | Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
set | Image | Hier wird das Bild festgelegt, das verwendet werden soll. Geben Sie dazu die URL oder den Datenstring an. |
set | Image | Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Image | Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. |
set | Image | Hier wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
Detaillierte Dokumentation
set Alt Text(altText)
Hier legen Sie den alternativen Text des Bilds für mehr Barrierefreiheit fest. Erforderlich.
Parameter
Name | Typ | Beschreibung |
---|---|---|
alt | String | Der alternative Text, der diesem Bild zugewiesen werden soll. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set Authorization Action(action)
Hiermit wird eine Autorisierungsaktion festgelegt, durch die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang geöffnet wird. Dadurch wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und zur Anwendung zurückkehrt, wird das Add-on neu geladen.
Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Authorization | Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set Compose Action(action, composedEmailType)
Hier legen Sie eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Compose
konfiguriertes Compose
-Objekt zurückgibt.
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composed | Composed | Ein enum-Wert, der angibt, ob der verfasste Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set Image Url(url)
Hier wird das Bild festgelegt, das verwendet werden soll. Geben Sie dazu die URL oder den Datenstring an. Erforderlich.
Die angegebene URL kann entweder eine öffentlich zugängliche URL oder ein Base64-codierter Bildstring sein.
Mit dem folgenden Code können Sie einen codierten Bildstring aus einem Bild in Google Drive erstellen und dann für die spätere Verwendung mit set
speichern. Mit dieser Methode muss Ihr Add-on nicht auf eine öffentlich verfügbare Bild-URL zugreifen:
// 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).
Parameter
Name | Typ | Beschreibung |
---|---|---|
url | String | Die URL-Adresse eines zu verwendenden gehosteten Bildes oder ein codierter Bildstring. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set On Click Action(action)
Hier legen Sie eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein Action
-Objekt zurückgibt.
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Die Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set On Click Open Link Action(action)
Hiermit wird eine Aktion festgelegt, durch die eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder Sie zusätzlich zum Erstellen des Open
-Objekts noch andere Aktionen ausführen müssen. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein mit Action
konfiguriertes Action
-Objekt zurückgibt.
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion zum Öffnen eines Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Image
– dieses Objekt, zur Verkettung
set Open Link(openLink)
Hier wird eine URL festgelegt, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits bekannt ist und nur geöffnet werden muss. Für ein UI-Objekt kann nur einer der folgenden Werte festgelegt werden: set
, set
, set
, set
oder set
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
open | Open | Ein Open -Objekt, das die zu öffnende URL beschreibt. |
Rückflug
Image
– dieses Objekt, zur Verkettung