Class CardHeader

CardHeader

Der Header von Card.

Verfügbar für Google Workspace-Add-ons und Google Chat-Apps.

var cardHeader = CardService.newCardHeader()
    .setTitle("Card header title")
    .setSubtitle("Card header subtitle")
    .setImageStyle(CardService.ImageStyle.CIRCLE)
    .setImageUrl("https://image.png");

Methoden

MethodeRückgabetypKurzbeschreibung
setImageAltText(imageAltText)CardHeaderLegt den alternativen Text für das Kopfzeilenbild fest.
setImageStyle(imageStyle)CardHeaderLegt fest, wie das Symbol in der Kopfzeile der Karte zugeschnitten werden soll.
setImageUrl(imageUrl)CardHeaderLegt das im Header zu verwendende Bild durch Angabe der URL oder des Datenstrings fest.
setSubtitle(subtitle)CardHeaderLegt den Untertitel des Kartenheaders fest.
setTitle(title)CardHeaderLegt den Titel der Kartenüberschrift fest.

Detaillierte Dokumentation

setImageAltText(imageAltText)

Legt den alternativen Text für das Kopfzeilenbild fest.

Parameters

NameTypBeschreibung
imageAltTextStringDer alternative Text für das Kopfzeilenbild.

Return

CardHeader: Dieses Objekt zur Verkettung.


setImageStyle(imageStyle)

Legt fest, wie das Symbol in der Kopfzeile der Karte zugeschnitten werden soll. Die Standardeinstellung ist „Kein Zuschneiden“. Optional.

Parameters

NameTypBeschreibung
imageStyleImageStyleDie Stileinstellung.

Return

CardHeader: Dieses Objekt zur Verkettung.


setImageUrl(imageUrl)

Legt das im Header zu verwendende Bild durch Angabe der URL oder des Datenstrings fest.

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(imageUrl) 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 CardHeader.setImageUrl(imageUrl).

Parameters

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

Return

CardHeader: Dieses Objekt zur Verkettung.


setSubtitle(subtitle)

Legt den Untertitel des Kartenheaders fest. Optional.

Parameters

NameTypBeschreibung
subtitleStringDer Untertiteltext der Kopfzeile.

Return

CardHeader: Dieses Objekt zur Verkettung.


setTitle(title)

Legt den Titel der Kartenüberschrift fest. Erforderlich.

Parameters

NameTypBeschreibung
titleStringDer Text für die Kopfzeile.

Return

CardHeader: Dieses Objekt zur Verkettung.