Ein Widget, das ein einzelnes Bild anzeigt. Informationen zum Zuschneiden von Bildern finden Sie unter ImageCropStyle
.
Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.
var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
setAltText(altText) | Image | Legt den alternativen Text des Bildes für Barrierefreiheit fest. |
setAuthorizationAction(action) | Image | Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. |
setComposeAction(action, composedEmailType) | Image | Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. |
setImageUrl(url) | Image | Legt das zu verwendende Bild fest, indem seine URL oder Datenzeichenfolge angegeben wird. |
setOnClickAction(action) | Image | Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. |
setOnClickOpenLinkAction(action) | Image | Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. |
setOpenLink(openLink) | Image | Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. |
Detaillierte Dokumentation
setAltText(altText)
Legt den alternativen Text des Bildes für Barrierefreiheit fest. Erforderlich.
Parameter
Name | Typ | Beschreibung |
---|---|---|
altText | String | Der alternative Text, der diesem Bild zugewiesen werden soll. |
Rückflug
Image
: Dieses Objekt zur Verkettung.
setAuthorizationAction(action)
Legt eine Autorisierungsaktion fest, durch die eine URL zum Autorisierungsablauf geöffnet wird, wenn das Objekt angeklickt wurde. Daraufhin wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen hat und an die Anwendung zurückkehrt, wird das Add-on neu geladen.
Für ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt werden.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | AuthorizationAction | Das Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde. |
Rückflug
Image
: Dieses Objekt zur Verkettung.
setComposeAction(action, composedEmailType)
Legt eine Aktion fest, durch die ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur
haben einen der folgenden Werte: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt.
Der Action
-Parameter muss eine Callback-Funktion angeben, die ein ComposeActionResponse
-Objekt zurückgibt, das mit ComposeActionResponseBuilder.setGmailDraft(draft)
konfiguriert wurde.
<ph type="x-smartling-placeholder">
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Zusammensetzungsaktion angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde. |
composedEmailType | ComposedEmailType | Ein Enum-Wert, der angibt, ob der zusammengestellte Entwurf ein als eigenständiger Entwurf oder als Antwortentwurf. |
Rückflug
Image
: Dieses Objekt zur Verkettung.
setImageUrl(url)
Legt das zu verwendende Bild fest, indem seine URL oder Datenzeichenfolge angegeben wird. Erforderlich.
Die angegebene URL kann entweder eine öffentlich zugängliche URL oder ein base64-codierter Bildstring sein.
Um Letzteres zu erhalten, können Sie mit dem folgenden Code eine codierte Image-Zeichenfolge aus einem
Bild in Google Drive und speichern Sie diesen String zur späteren Verwendung mit setImageUrl(url)
. Mit dieser Methode ist es nicht notwendig, dass Ihr Add-on auf ein öffentliches
Verfügbare Bild-URL:
// 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).
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.
setOnClickAction(action)
Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Ein UI-Objekt kann nur eines der folgenden Elemente haben:
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt.
Der Parameter Action
muss eine Callback-Funktion angeben, die ein ActionResponse
-Objekt zurückgibt.
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird |
Rückflug
Image
: Dieses Objekt zur Verkettung.
setOnClickOpenLinkAction(action)
Legt eine Aktion fest, durch die beim Anklicken des Objekts eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn das
Die URL muss erstellt werden oder wenn Sie zusätzlich zum Erstellen des OpenLink
-Objekts weitere Aktionen ausführen müssen. Ein UI-Objekt kann nur setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder
setComposeAction(action, composedEmailType)
festgelegt.
Der Action
-Parameter muss eine Callback-Funktion angeben, die ein ActionResponse
-Objekt zurückgibt, das mit ActionResponseBuilder.setOpenLink(openLink)
konfiguriert wurde.
// ... 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(); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
action | Action | Das Objekt, das die Aktion zum Öffnen von Links angibt, die ausgeführt werden soll, wenn dieses Element angeklickt wurde. |
Rückflug
Image
: Dieses Objekt zur Verkettung.
setOpenLink(openLink)
Legt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird. Verwenden Sie diese Funktion, wenn die URL bereits
und muss nur geöffnet werden. Ein UI-Objekt kann nur einen der folgenden Werte haben: setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
oder setComposeAction(action, composedEmailType)
festgelegt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
openLink | OpenLink | Ein OpenLink -Objekt, das die zu öffnende URL beschreibt. |
Rückflug
Image
: Dieses Objekt zur Verkettung.