Cards v1

Infokarte

Eine Karte ist ein UI-Element, das UI-Widgets wie Text und Bilder enthalten kann.

JSON-Darstellung 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Felder
header

object (CardHeader)

Die Kopfzeile der Karte. Ein Header enthält in der Regel einen Titel und ein Bild.

sections[]

object (Section)

Die Abschnitte sind durch eine Trennlinie voneinander getrennt.

cardActions[]

object (CardAction)

Die Aktionen dieser Karte.

name

string

Name der Karte.

CardHeader

JSON-Darstellung 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Felder
title

string

Der Titel muss angegeben werden. Der Header hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben ist, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.

subtitle

string

Der Untertitel der Kartenkopfzeile.

imageStyle

enum (ImageStyle)

Der Typ des Bildes (z. B. quadratischer oder runder Rahmen).

imageUrl

string

Die URL des Bildes in der Kopfzeile der Karte.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Quadratischer Rahmen.
AVATAR Kreisförmiger Rahmen.

Bereich

Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der Reihenfolge gerendert werden, in der sie angegeben sind. Auf allen Plattformen haben Karten eine schmale feste Breite, sodass derzeit keine Layout-Properties (z. B. „float“) erforderlich sind.

JSON-Darstellung 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Felder
header

string

Die Überschrift des Abschnitts. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

widgets[]

object (WidgetMarkup)

Ein Abschnitt muss mindestens ein Widget enthalten.

WidgetMarkup

Ein Widget ist ein UI-Element, das Text und Bilder darstellt.

JSON-Darstellung 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Felder
buttons[]

object (Button)

Eine Liste mit Schaltflächen. „Buttons“ ist ebenfalls oneof data und nur eines dieser Felder sollte festgelegt werden.

Ein WidgetMarkup kann nur eines der folgenden Elemente enthalten. Sie können mehrere WidgetMarkup-Felder verwenden, um mehr Elemente anzuzeigen. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
textParagraph

object (TextParagraph)

In diesem Widget wird ein Textabsatz angezeigt.

image

object (Image)

In diesem Widget ein Bild anzeigen.

keyValue

object (KeyValue)

In diesem Widget ein Schlüssel/Wert-Paar anzeigen.

Ende der sich gegenseitig ausschließenden Felder.

TextParagraph

Ein Textabsatz. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

JSON-Darstellung 
{
  "text": string
}
Felder
text

string

Bild

Ein Bild, das durch eine URL angegeben wird und eine onclick-Aktion haben kann.

JSON-Darstellung 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Felder
imageUrl

string

Die URL des Bildes.

onClick

object (OnClick)

Die Aktion onclick.

aspectRatio

number

Das Seitenverhältnis dieses Bildes (Breite und Höhe). In diesem Feld können Sie die richtige Höhe für das Bild reservieren, während es geladen wird. Es ist nicht dazu gedacht, das integrierte Seitenverhältnis des Bildes zu überschreiben. Wenn das Feld nicht festgelegt ist, wird es vom Server durch Vorabrufen des Bildes ausgefüllt.

OnClick

Eine onclick-Aktion (z. B. einen Link öffnen).

JSON-Darstellung 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
action

object (FormAction)

Eine Formularaktion wird durch diese onclick-Aktion ausgelöst, falls angegeben.

Ende der sich gegenseitig ausschließenden Felder.

FormAction

Eine Formularaktion beschreibt das Verhalten, wenn das Formular gesendet wird. Sie können beispielsweise Apps Script aufrufen, um das Formular zu verarbeiten.

JSON-Darstellung 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Felder
actionMethodName

string

Anhand des Methodennamens wird ermittelt, welcher Teil des Formulars das Senden des Formulars ausgelöst hat. Diese Informationen werden im Rahmen des Klickereignisses für die Karte an die Chat-App zurückgegeben. Sie können denselben Methodennamen für mehrere Elemente verwenden, die ein gemeinsames Verhalten auslösen.

parameters[]

object (ActionParameter)

Liste der Aktionsparameter.

ActionParameter

Liste der Stringparameter, die beim Aufruf der Aktionsmethode angegeben werden müssen. Stellen Sie sich zum Beispiel drei Schlummertasten vor: „Jetzt schlummern“, „Einen Tag schlummern“, „Nächste Woche schlummern“. Sie können action method = snooze() verwenden und den Schlummertyp und die Schlummerzeit in der Liste der Stringparameter übergeben.

JSON-Darstellung 
{
  "key": string,
  "value": string
}
Felder
key

string

Der Name des Parameters für das Aktionsskript.

value

string

Wert des Parameters.

KeyValue

Ein UI-Element enthält einen Schlüssel (Label) und einen Wert (Inhalt). Dieses Element kann auch einige Aktionen enthalten, z. B. die Schaltfläche onclick.

JSON-Darstellung 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Felder
topLabel

string

Der Text des oberen Labels. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

content

string

Der Text des Inhalts. Formatierter Text wird unterstützt und ist immer erforderlich. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

contentMultiline

boolean

Gibt an, ob der Inhalt mehrzeilig sein soll.

bottomLabel

string

Der Text des unteren Labels. Formatierter Text wird unterstützt. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

onClick

object (OnClick)

Die Aktion onclick. Nur das obere Label, das untere Label und der Inhaltsbereich sind anklickbar.

Mindestens eines der Elemente „icons“, top_label und bottom_label muss definiert sein. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
icon

enum (Icon)

Ein Enum-Wert, der von der Chat API durch das entsprechende Symbolbild ersetzt wird.

iconUrl

string

Das durch eine URL angegebene Symbol.

Ende der sich gegenseitig ausschließenden Felder.
Ein Steuerelement-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
button

object (Button)

Eine Schaltfläche, auf die geklickt werden kann, um eine Aktion auszulösen.

Ende der sich gegenseitig ausschließenden Felder.

Symbol

Die unterstützten Symbole.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Button

A-Taste. Kann eine Text- oder Bildschaltfläche sein.

JSON-Darstellung 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
textButton

object (TextButton)

Eine Schaltfläche mit Text und der Aktion onclick.

imageButton

object (ImageButton)

Eine Schaltfläche mit Bild und der Aktion onclick.

Ende der sich gegenseitig ausschließenden Felder.

TextButton

Eine Schaltfläche mit Text und der Aktion onclick.

JSON-Darstellung 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Felder
text

string

Text des Buttons

onClick

object (OnClick)

Die Aktion onclick des Buttons.

ImageButton

Eine Bildschaltfläche mit einer onclick-Aktion.

JSON-Darstellung 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Felder
onClick

object (OnClick)

Die Aktion onclick.

name

string

Der Name dieses imageButton, der für die Barrierefreiheit im Internet verwendet wird. Wenn dieser Name nicht angegeben ist, wird der Standardwert verwendet.

Das Symbol kann durch ein Icon, ein enum oder eine URL angegeben werden. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
icon

enum (Icon)

Das Symbol, das durch ein enum angegeben wird, das auf ein von der Chat API bereitgestelltes Symbol verweist.

iconUrl

string

Das durch eine URL angegebene Symbol.

Ende der sich gegenseitig ausschließenden Felder.

CardAction

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Bei einer Rechnungskarte wäre eine typische Aktion: Rechnung löschen, Rechnung per E-Mail senden oder Rechnung im Browser öffnen.

Wird von Google Chat-Apps nicht unterstützt.

JSON-Darstellung 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Felder
actionLabel

string

Das Label, das im Aktionsmenüelement angezeigt wurde.

onClick

object (OnClick)

Die Onclick-Aktion für dieses Aktionselement.