Class Image

Bild

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

MethodeRückgabetypKurzbeschreibung
setAltText(altText)ImageLegt den alternativen Text des Bildes für Barrierefreiheit fest.
setAuthorizationAction(action)ImageLegt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet.
setComposeAction(action, composedEmailType)ImageLegt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird.
setImageUrl(url)ImageLegt das zu verwendende Bild durch Angabe der URL oder des Datenstrings fest.
setOnClickAction(action)ImageLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageLegt eine Aktion fest, bei der eine URL in einem Tab geöffnet wird, wenn auf das Objekt geklickt wird.
setOpenLink(openLink)ImageLegt eine URL fest, die geöffnet wird, wenn auf das Objekt geklickt wird.

Detaillierte Dokumentation

setAltText(altText)

Legt den alternativen Text des Bildes für Barrierefreiheit fest. Erforderlich.

Parameters

NameTypBeschreibung
altTextStringDer alternative Text, der diesem Bild zugewiesen werden soll.

Return

Image: Dieses Objekt zur Verkettung.


setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, die beim Anklicken des Objekts eine URL zum Autorisierungsablauf öffnet. Dadurch wird die URL in einem neuen Fenster geöffnet. Wenn der Nutzer den Autorisierungsvorgang abgeschlossen und zur Anwendung zurückkehrt, wird das Add-on neu geladen.

Für ein UI-Objekt kann entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

// ...

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

Parameters

NameTypBeschreibung
actionAuthorizationActionDas Objekt, das die Autorisierungsaktion angibt, die beim Klicken auf dieses Element ausgeführt werden soll.

Return

Image: Dieses Objekt zur Verkettung.


setComposeAction(action, composedEmailType)

Legt eine Aktion fest, mit der ein E-Mail-Entwurf erstellt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Der Parameter Action muss eine Callback-Funktion angeben, die ein mit ComposeActionResponseBuilder.setGmailDraft(draft) konfiguriertes ComposeActionResponse-Objekt zurückgibt.

// ...

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

Parameters

NameTypBeschreibung
actionActionObjekt, das die Schreibaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin ENUM-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger oder Antwortentwurf ist.

Return

Image: Dieses Objekt zur Verkettung.


setImageUrl(url)

Legt das zu verwendende Bild durch Angabe der URL oder des Datenstrings fest. 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 einen codierten Bildstring aus einem Bild in Google Drive erstellen und diesen String zur späteren Verwendung mit setImageUrl(url) speichern. Bei dieser Methode muss das 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.
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).

Parameters

NameTypBeschreibung
urlStringDie URL-Adresse eines gehosteten Bildes, das verwendet werden soll, oder ein codierter Bildstring.

Return

Image: Dieses Objekt zur Verkettung.


setOnClickAction(action)

Legt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird. Für ein UI-Objekt kann nur entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

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

Parameters

NameTypBeschreibung
actionActionDie auszuführende Aktion, wenn auf dieses Element geklickt wird.

Return

Image: Dieses Objekt zur Verkettung.


setOnClickOpenLinkAction(action)

Legt eine Aktion fest, bei der 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 wenn Sie neben dem OpenLink-Objekt weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Der Parameter Action muss eine Callback-Funktion angeben, die ein mit ActionResponseBuilder.setOpenLink(openLink) konfiguriertes ActionResponse-Objekt zurückgibt.

// ...

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

Parameters

NameTypBeschreibung
actionActionDas Objekt, das die Aktion zum Öffnen eines Links angibt, die beim Klicken auf dieses Element ausgeführt werden soll.

Return

Image: Dieses Objekt zur Verkettung.


Legt eine URL fest, die geöffnet wird, 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 entweder setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType) festgelegt sein.

Parameters

NameTypBeschreibung
openLinkOpenLinkEin OpenLink-Objekt, das die zu öffnende URL beschreibt.

Return

Image: Dieses Objekt zur Verkettung.