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 normalerweise einen Titel und ein Bild.

sections[]

object (Section)

Die einzelnen 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. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch eine Unterüberschrift angegeben sind, belegt jede eine Zeile. Wenn nur der Titel angegeben ist, werden beide Zeilen ausgefüllt.

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 Kartenüberschrift.

ImageStyle

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Quadratische Rahmenlinie.
AVATAR Kreisförmiger Rahmen.

Abschnitt

Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der angegebenen Reihenfolge 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 Abschnitt muss mindestens ein Widget enthalten.

WidgetMarkup

Ein Widget ist ein UI-Element, das Text und Bilder enthält.

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Felder
buttons[]

object (Button)

Eine Liste mit Schaltflächen. Buttons ist auch oneof data und nur eines dieser Felder sollte festgelegt sein.

Union-Feld data. Ein WidgetMarkup kann nur eines der folgenden Elemente enthalten. Sie können mehrere WidgetMarkup-Felder verwenden, um mehr Elemente anzuzeigen. Für data ist nur einer der folgenden Werte zulässig:
textParagraph

object (TextParagraph)

Textabschnitt in diesem Widget anzeigen.

image

object (Image)

Bild in diesem Widget anzeigen.

keyValue

object (KeyValue)

Zeigt ein Schlüsselwertelement in diesem Widget an.

TextParagraph

Einen Textabschnitt. 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 ist nicht dazu gedacht, das integrierte Seitenverhältnis des Bildes zu überschreiben. Wenn das Attribut nicht festgelegt ist, wird es vom Server durch Vorabladen des Bildes ausgefüllt.

OnClick

Eine onclick-Aktion (z. B. Öffnen eines Links)

JSON-Darstellung 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Felder

Union-Feld data.

Für data ist nur einer der folgenden Werte zulässig:

action

object (FormAction)

Durch diese onclick-Aktion wird, sofern angegeben, eine Formularaktion ausgelöst.

FormAction

Mit einer Formularaktion wird das Verhalten beim Senden des Formulars beschrieben. 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 die Formulareinreichung ausgelöst hat. Diese Informationen werden im Rahmen des Kartenklickereignisses 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. Angenommen, Sie haben drei Schlummertasten: „Jetzt“, „Einen Tag“ und „Nächste Woche“. 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 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 enthalten, z. B. die Schaltfläche onclick.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
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

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.

Union-Feld icons. Mindestens eines der Symbole, top_label und bottom_label, muss definiert werden. Für icons ist nur einer der folgenden Werte zulässig:
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.

Union-Feld control. Ein Kontroll-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. control darf nur einen der folgenden Werte haben:
button

object (Button)

Eine Schaltfläche, über die eine Aktion ausgelöst werden kann.

Symbol

Die Gruppe der 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

Schaltfläche

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

JSON-Darstellung 
{

  // Union field type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Felder

Union-Feld type.

Für type ist nur einer der folgenden Werte zulässig:

textButton

object (TextButton)

Eine Schaltfläche mit Text und einer onclick-Aktion.

imageButton

object (ImageButton)

Eine Schaltfläche mit Bild und onclick-Aktion.

TextButton

Eine Schaltfläche mit Text und der Aktion onclick.

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

string

Text der Schaltfläche

onClick

object (OnClick)

Die Aktion onclick der Schaltfläche.

ImageButton

Eine Bildschaltfläche mit einer onclick-Aktion.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
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.

Union-Feld icons. Das Symbol kann durch einen Icon, einen enum oder eine URL angegeben werden. Für icons ist nur einer der folgenden Werte zulässig:
icon

enum (Icon)

Das durch eine enum angegebene Symbol, das einem von der Chat API bereitgestellten Symbol entspricht.

iconUrl

string

Das durch eine URL angegebene Symbol.

CardAction

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Eine typische Aktion für eine Rechnungskarte wäre: eine Rechnung löschen, eine E-Mail-Rechnung senden oder die 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 Menüpunkt „Aktion“ angezeigt.

onClick

object (OnClick)

Die onclick-Aktion für dieses Aktionselement.