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. Eine Kopfzeile enthält in der Regel einen Titel und ein Bild.

sections[]

object (Section)

Abschnitte sind durch eine Trennlinie 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 sind, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.

subtitle

string

Der Untertitel der Kartenüberschrift.

imageStyle

enum (ImageStyle)

Der Typ des Bildes, z. B. quadratischer oder kreisförmiger 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 in der angegebenen Reihenfolge (vertikal) gerendert werden. Karten haben auf allen Plattformen eine schmale, feste Breite. Daher sind derzeit keine Layout-Properties (z. B. „float“) erforderlich.

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 Bereich muss mindestens ein Widget enthalten.

WidgetMarkup

Ein Widget ist ein UI-Element, in dem Text und Bilder angezeigt werden.

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 auch oneof data. 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 sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
textParagraph

object (TextParagraph)

Einen Textabsatz in diesem Widget anzeigen

image

object (Image)

Ein Bild in diesem Widget anzeigen

keyValue

object (KeyValue)

Ein Schlüssel/Wert-Paar in diesem Widget 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). Mit diesem Feld können Sie die richtige Höhe für das Bild reservieren, während es geladen wird. Es soll nicht das integrierte Seitenverhältnis des Bildes überschreiben. Wenn der Wert nicht festgelegt ist, wird er 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 sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
action

object (FormAction)

Eine Formularaktion wird durch diese onclick-Aktion ausgelöst, sofern 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

Mit dem Methodennamen wird angegeben, welcher Teil des Formulars die Formularübermittlung ausgelöst hat. Diese Informationen werden im Rahmen des Click-Events 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 Aufrufen der Aktionsmethode angegeben werden müssen. Stellen Sie sich beispielsweise drei Schlummer-Schaltflächen vor: „Jetzt schlummern“, „Einen Tag lang schlummern“ und „Nächste Woche schlummern“. Sie können action method = snooze() verwenden und den Schlummer-Typ 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 Aktionsscript.

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 wie die Schaltfläche onclick enthalten.

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.

Es muss mindestens eines der Elemente „icons“, top_label und bottom_label definiert werden. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. 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 Symbol, das durch eine URL angegeben wird.

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

object (Button)

Ein Button, auf den 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

Eine Schaltfläche. Kann eine Text- oder Bildschaltfläche sein.

JSON-Darstellung 
{

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

object (TextButton)

Ein Button mit Text und onclick Aktion.

imageButton

object (ImageButton)

Ein Button mit Bild und onclick Aktion.

Ende der sich gegenseitig ausschließenden Felder.

TextButton

Ein Button mit Text und onclick Aktion.

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

string

Text des Buttons

onClick

object (OnClick)

Die onclick Aktion 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 verwendet wird. Wenn dieser Name nicht angegeben ist, wird ein Standardwert verwendet.

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

enum (Icon)

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

iconUrl

string

Das Symbol, das durch eine URL angegeben wird.

Ende der sich gegenseitig ausschließenden Felder.

CardAction

Eine Kartenaktion ist die Aktion, die mit der Karte verknüpft ist. 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 wurde früher im Aktionsmenüpunkt angezeigt.

onClick

object (OnClick)

Die Onclick-Aktion für diese Aufgabe.