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 Überschrift der Karte. Eine Kopfzeile enthält normalerweise einen Titel und ein Bild.

sections[]

object (Section)

Die einzelnen 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. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben ist, wird jeweils eine Zeile eingenommen. 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 Quadratische Rahmen.
AVATAR Kreisförmiger Rahmen.

Abschnitt

Ein Abschnitt enthält eine Sammlung von Widgets, die (vertikal) in der angegebenen Reihenfolge gerendert werden. Auf allen Plattformen haben Karten eine schmale feste Breite, sodass derzeit keine Layouteigenschaften (z. B. Gleitkommazahl) 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 Bereich muss mindestens ein Widget enthalten.

WidgetMarkup

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

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. Für die Schaltfläche ist auch oneof data und nur eines dieser Felder sollte festgelegt werden.

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

object (TextParagraph)

In diesem Widget einen Textabsatz anzeigen.

image

object (Image)

Zeigt ein Bild in diesem Widget an.

keyValue

object (KeyValue)

Zeigt ein Schlüssel/Wert-Element in diesem Widget an.

TextParagraph

Ein Absatz mit Text. 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 die Aktion onclick 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 des Bildes (Breite und Höhe) Mit diesem Feld können Sie die richtige Höhe für das Bild reservieren, während Sie auf das Laden warten. Das integrierte Seitenverhältnis des Bildes wird nicht überschrieben. Wenn kein Wert festgelegt ist, füllt der Server das Bild durch Vorabruf des Bildes aus.

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)

Wenn angegeben, wird durch diese onclick-Aktion eine Formularaktion ausgelöst.

FormAction

Eine Formularaktion beschreibt das Verhalten beim Senden des Formulars. Zum Beispiel können Sie 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 Formulareinreichung ausgelöst hat. Diese Informationen werden im Rahmen des Ereignisses zum Klicken auf die Karte an die Chat-App zurückgegeben. Sie können denselben Methodennamen für mehrere Elemente verwenden, die ein häufiges Verhalten auslösen.

parameters[]

object (ActionParameter)

Liste der Aktionsparameter.

ActionParameter

Liste der Zeichenfolgenparameter, die beim Aufrufen der Aktionsmethode angegeben werden sollen. Denken Sie zum Beispiel an drei Schaltflächen für die Schlummerfunktion: „Jetzt pausieren“, „An einem Tag zurückstellen“ und „Nächste Woche zurückstellen“. 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)
  },

  // 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 obersten 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 und untere Label sowie der Inhaltsbereich sind anklickbar.

Union-Feld icons. Es muss mindestens eines der Symbole top_label und bottom_label 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 von einer URL angegebene Symbol.

Union-Feld control. Ein Steuerungs-Widget. Sie können entweder button oder switch_widget festlegen, aber nicht beides. Für control ist nur einer der folgenden Werte zulässig:
button

object (Button)

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

Icon

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

Schaltfläche

Eine Schaltfläche. Dies kann eine Textschaltfläche oder eine 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 der Aktion onclick.

imageButton

object (ImageButton)

Eine Schaltfläche mit einem Bild und der Aktion onclick.

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 onclick-Aktion der Schaltfläche.

ImageButton

Eine Bildschaltfläche mit der Aktion onclick.

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 Bedienungshilfen verwendet wird. Wird kein Name angegeben, wird der Standardwert verwendet.

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

enum (Icon)

Das Symbol, das von einem enum angegeben wird, das für ein von der Chat API bereitgestelltes Symbol verweist.

iconUrl

string

Das von einer URL angegebene Symbol.

CardAction

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

onClick

object (OnClick)

Die Aktion „on“ für diese Aufgabe.