Class Image

Bild

Ein Widget, das ein einzelnes Bild zeigt. Informationen zum Zuschneiden von Bildern finden Sie unter ImageCropStyle.

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

MethodeRückgabetypKurzbeschreibung
addEventAction(eventAction)WidgetFügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.
setAltText(altText)ImageLegt den alternativen Text des Bildes für die Barrierefreiheit fest.
setAuthorizationAction(action)ImageLegt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang öffnet.
setComposeAction(action, composedEmailType)ImageLegt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail als Entwurf erstellt wird.
setId(id)WidgetLegt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird.
setImageUrl(url)ImageLegt das zu verwendende Bild fest, indem Sie die URL oder den Datenstring angeben.
setOnClickAction(action)ImageLegt eine Aktion fest, die ausgeführt wird, wenn auf das Objekt geklickt wird.
setOnClickOpenLinkAction(action)ImageLegt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL in einem Tab geöffnet wird.
setOpenLink(openLink)ImageLegt eine URL fest, die geöffnet werden soll, wenn auf das Objekt geklickt wird.
setVisibility(visibility)WidgetLegt die Sichtbarkeit des Widgets fest.

Detaillierte Dokumentation

addEventAction(eventAction)

Fügt die Ereignisaktion hinzu, die für das Widget ausgeführt werden kann.

Parameter

NameTypBeschreibung
eventActionEventActionDas EventAction hinzuzufügen.

Rückflug

Widget : Das Objekt für die Verkettung.

setAltText(altText)

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

Parameter

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

Rückflug

Image : Dieses Objekt für die Verkettung.

setAuthorizationAction(action)

Legt eine Autorisierungsaktion fest, die beim Klicken auf das Objekt eine URL zum Autorisierungsvorgang öffnet. Die URL wird 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 eine der folgenden Optionen festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType). 

// ...

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

Parameter

NameTypBeschreibung
actionAuthorizationActionDas Objekt, das die Autorisierungsaktion angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Image : Dieses Objekt für die Verkettung.

setComposeAction(action, composedEmailType)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine E-Mail als Entwurf erstellt wird. Für ein UI-Objekt kann nur eine der folgenden Optionen festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

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

// ...

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

NameTypBeschreibung
actionActionDas Objekt, das die Aktion zum Erstellen angibt, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.
composedEmailTypeComposedEmailTypeEin Enum-Wert, der angibt, ob der erstellte Entwurf ein eigenständiger Entwurf oder ein Antwortentwurf ist.

Rückflug

Image : Dieses Objekt für die Verkettung.

setId(id)

Legt die eindeutige ID fest, die zum Identifizieren des zu ändernden Widgets verwendet wird. Widget-Mutationen werden nur in Add-ons unterstützt.

Parameter

NameTypBeschreibung
idStringDie ID des Widgets mit maximal 64 Zeichen im Format `[a-zA-Z0-9-]+`.

Rückflug

Widget : Dieses Objekt für die Verkettung.

setImageUrl(url)

Legt das zu verwendende Bild fest, indem Sie die URL oder den Datenstring angeben. 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 dann für die spätere Verwendung mit setImageUrl(url) speichern. Mit dieser Methode muss Ihr Add-on nicht auf eine öffentlich zugängliche 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

NameTypBeschreibung
urlStringDie URL-Adresse eines gehosteten Bildes oder ein codierter Bildstring.

Rückflug

Image : Dieses Objekt für die Verkettung.

setOnClickAction(action)

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

Der Parameter Action muss eine Callback-Funktion angeben, die ein ActionResponse 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

NameTypBeschreibung
actionActionDie Aktion, die ausgeführt werden soll, wenn auf dieses Element geklickt wird.

Rückflug

Image : Dieses Objekt für die Verkettung.

setOnClickOpenLinkAction(action)

Legt eine Aktion fest, mit der beim Klicken auf das Objekt eine URL in einem Tab geöffnet wird. Verwenden Sie diese Funktion, wenn die URL erstellt werden muss oder wenn Sie neben dem Erstellen des OpenLink-Objekts weitere Aktionen ausführen müssen. Für ein UI-Objekt kann nur eine der folgenden Optionen festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

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

// ...

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

NameTypBeschreibung
actionActionDas 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 für die Verkettung.

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 eine der folgenden Optionen festgelegt werden: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) oder setComposeAction(action, composedEmailType).

Parameter

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

Rückflug

Image : Dieses Objekt für die Verkettung.

setVisibility(visibility)

Legt die Sichtbarkeit des Widgets fest. Der Standardwert ist `VISIBLE`.

Parameter

NameTypBeschreibung
visibilityVisibilityDie Visibility des Widgets.

Rückflug

Widget : Das Objekt für die Verkettung.