Class CardHeader

CardHeader

Die Kopfzeile einer Card.

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

const 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 den Zuschnitt des Symbols in der Kartenkopfzeile fest.
setImageUrl(imageUrl)CardHeaderLegt das Bild fest, das in der Kopfzeile verwendet werden soll, indem Sie die URL oder den Datenstring angeben.
setSubtitle(subtitle)CardHeaderLegt den Untertitel der Kartenkopfzeile fest.
setTitle(title)CardHeaderLegt den Titel der Kartenkopfzeile fest.

Detaillierte Dokumentation

setImageAltText(imageAltText)

Legt den alternativen Text für das Kopfzeilenbild fest.

Parameter

NameTypBeschreibung
imageAltTextStringDer alternative Text für das Kopfzeilenbild.

Rückflug

CardHeader — Dieses Objekt zum Verketten.


setImageStyle(imageStyle)

Legt den Zuschnitt des Symbols in der Kartenkopfzeile fest. Die Standardeinstellung ist „Kein Zuschnitt“. Optional.

Parameter

NameTypBeschreibung
imageStyleImageStyleDie Stileinstellung.

Rückflug

CardHeader — Dieses Objekt zum Verketten.


setImageUrl(imageUrl)

Legt das Bild fest, das in der Kopfzeile verwendet werden soll, indem Sie die URL oder den Datenstring angeben.

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 zur späteren Verwendung mit setImageUrl(imageUrl) 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
// CardHeader.setImageUrl(imageUrl).

Parameter

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

Rückflug

CardHeader — Dieses Objekt zum Verketten.


setSubtitle(subtitle)

Legt den Untertitel der Kartenkopfzeile fest. Optional.

Parameter

NameTypBeschreibung
subtitleStringDer Untertiteltext der Kopfzeile.

Rückflug

CardHeader — Dieses Objekt zum Verketten.


setTitle(title)

Legt den Titel der Kartenkopfzeile fest. Erforderlich.

Parameter

NameTypBeschreibung
titleStringDer Kopfzeilentext.

Rückflug

CardHeader — Dieses Objekt zum Verketten.