Ein Widget, das ein einzelnes Bild anzeigt. 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 |
|---|---|---|
add | Widget | Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann. |
set | Image | Legt den Alternativtext des Bildes für die Barrierefreiheit fest. |
set | Image | Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf öffnet. |
set | Image | Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail-Nachricht erstellt wird. |
set | Widget | Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. |
set | Image | Legt das zu verwendende Bild fest, indem die URL oder der Datenstring angegeben wird. |
set | Image | Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
set | Image | Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird. |
set | Image | Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
set | Widget | Legt die Sichtbarkeit des Widgets fest. |
Detaillierte Dokumentation
add Event Action(eventAction)
Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
event | Event | Die hinzuzufügende Event. |
Rückflug
Widget – Das Objekt für die Verkettung.
set Alt Text(altText)
Legt den Alternativtext des Bildes für die 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)
Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsablauf öffnet. 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 eines der Attribute set, set, set, set oder set festgelegt werden.
// ... 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)
Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail-Nachricht erstellt wird. Für ein UI-Objekt kann nur eines der Attribute set, set, set, set oder set festgelegt werden.
Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, 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 Compose-Aktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
composed | Composed | Ein Enumerationswert, der angibt, ob der erstellte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist. |
Rückflug
Image: Dieses Objekt zur Verkettung.
set Id(id)
Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. Die Mutation von Widgets wird nur in Add-ons unterstützt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
id | String | Die ID des Widgets mit einem Limit von 64 Zeichen und im Format `[a-zA-Z0-9-]+`. |
Rückflug
Widget: Dieses Objekt zur Verkettung.
set Image Url(url)
Legt das zu verwendende Bild fest, indem die URL oder der Datenstring angegeben wird. Erforderlich.
Die angegebene URL kann entweder eine öffentlich zugängliche URL oder ein Base64-codierter Bildstring sein.
Um den String zu erhalten, können Sie mit dem folgenden Code einen codierten Bildstring aus einem Bild in Google Drive erstellen und diesen String dann für die spätere Verwendung mit set speichern. Bei 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 gehosteten Bildes, das verwendet werden soll, oder ein codierter Bildstring. |
Rückflug
Image: Dieses Objekt zur Verkettung.
set On Click Action(action)
Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur eines der Attribute set, set, set, set oder set festgelegt werden.
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)
Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL auf einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder wenn Sie zusätzlich zum Erstellen des Open-Objekts weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur eines der Attribute set, set, set, set oder set festgelegt werden.
Mit dem Parameter Action muss eine Callback-Funktion angegeben werden, 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 des Links angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird. |
Rückflug
Image: Dieses Objekt zur Verkettung.
set Open Link(openLink)
Legt eine URL fest, 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 eines der folgenden Attribute 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.
set Visibility(visibility)
Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist „VISIBLE“.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
visibility | Visibility | Die Visibility des Widgets. |
Rückflug
Widget – Das Objekt für die Verkettung.