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)

Der Header der Karte. Eine Überschrift enthält in der Regel einen Titel und ein Bild.

sections[]

object (Section)

Die Abschnitte sind durch eine Linie getrennt.

cardActions[]

object (CardAction)

Die Aktionen dieser Karte.

name

string

Name der Karte.

Karten-Header

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

subtitle

string

Der Untertitel der Kopfzeile der Karte.

imageStyle

enum (ImageStyle)

Typ des Bilds, z. B. quadratischer oder kreisförmiger Rahmen.

imageUrl

string

Die URL des Bilds im Kartenheader.

Bildstil

Enums
IMAGE_STYLE_UNSPECIFIED
IMAGE Quadratischer Rand.
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 enge feste Breite. Daher sind derzeit keine Layouteigenschaften erforderlich (z. B. Gleitkommazahl).

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.

Widget-Markup

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. Die Schaltfläche ist auch oneof data. Es sollte nur eines dieser Felder festgelegt werden.

Union-Feld data. Ein WidgetMarkup kann nur eines der folgenden Elemente haben. Sie können mehrere WidgetMarkup-Felder verwenden, um weitere Elemente anzuzeigen. data darf nur einer der folgenden Werte sein:
textParagraph

object (TextParagraph)

In diesem Widget wird ein Absatz angezeigt.

image

object (Image)

Bild in diesem Widget anzeigen.

keyValue

object (KeyValue)

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

Textabsatz

Ein Absatz des Textes 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 auf die Ladezeit wartet. Es soll nicht das integrierte Seitenverhältnis des Bilds überschreiben. Wenn die Richtlinie nicht konfiguriert ist, füllt der Server sie aus, indem das Bild vorab abgerufen wird.

Beim Klicken

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.

data darf nur einer der folgenden Werte sein:

action

object (FormAction)

Sofern angegeben, wird eine Formularaktion von dieser onclick-Aktion ausgelöst.

FormAction

In 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 kann angegeben werden, welcher Teil des Formulars die Formulareinreichung ausgelöst hat. Diese Informationen werden im Rahmen des Kartenklickereignisses in der Chat App zurückgegeben. Sie können für mehrere Elemente, die ein gemeinsames Verhalten auslösen, denselben Methodennamen verwenden.

parameters[]

object (ActionParameter)

Liste der Aktionsparameter.

Aktionsparameter

Liste der Stringparameter, die beim Aufrufen der Aktionsmethode angegeben werden sollen. Sie können beispielsweise drei Schaltflächen zum Schlummern verwenden: jetzt für die Schlummerfunktion, für einen Tag die Schlummerfunktion und für die nächste Woche die Schlummerfunktion. Sie können action method = snooze() verwenden und die Schlummerfunktion sowie die Schlummerzeit in der Liste mit Stringparametern ü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 wie die Schaltfläche onclick enthalten.

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 ist

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 Contentbereich sind anklickbar.

Union-Feld icons. Es muss mindestens eines der Symbole, top_label und bottom_label, definiert sein. icons darf nur einer der folgenden Werte sein:
icon

enum (Icon)

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

iconUrl

string

Das Symbol, das durch eine URL angegeben wird.

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

object (Button)

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

Icon

Eine Reihe unterstützter 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.

type darf nur einer der folgenden Werte sein:

textButton

object (TextButton)

Eine Schaltfläche mit Text und Aktion onclick.

imageButton

object (ImageButton)

Eine Schaltfläche mit Bild und onclick-Aktion.

Textschaltfläche

Eine Schaltfläche mit Text und 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.

Bildschaltfläche

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 dieser imageButton, der für Bedienungshilfen verwendet wird. Wenn dieser Name nicht angegeben ist, wird ein Standardwert angegeben.

Union-Feld icons. Das Symbol kann durch eine Icon enum oder eine URL angegeben werden. icons darf nur einer der folgenden Werte sein:
icon

enum (Icon)

Das Symbol, das durch ein enum angegeben wird, das einem von der Chat API bereitgestellten Symbol entspricht.

iconUrl

string

Das Symbol, das durch eine URL angegeben wird.

Kartenaktion

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Bei einer Rechnung wird üblicherweise eine Rechnung gelöscht, eine E-Mail-Rechnung gelöscht oder die Rechnung im Browser geöffnet.

In Google Chat-Apps nicht unterstützt

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

string

Das Label, das zuvor im Aktionsmenü angezeigt wurde.

onClick

object (OnClick)

Die „onclick“-Aktion für diese Aufgabe.