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 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 Bildtyp, 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 Rahmenlinie.
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 Infokarten eine schmale feste Breite, sodass derzeit keine Layouteigenschaften (z. B. Float) erforderlich sind.

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

string

Die Kopfzeile 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)
    }
  ],

  // 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. Schaltflächen sind auch oneof data und nur eines dieser Felder sollte festgelegt werden.

Union-Feld data A WidgetMarkup darf nur eines der folgenden Elemente enthalten. Sie können mehrere WidgetMarkup um weitere Elemente anzuzeigen. data kann nur einer der folgenden Werte sein:
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

Ein 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 wird durch eine URL angegeben und kann ein onclick Aktion ausführen.

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

string

Die URL des Bildes.

onClick

object (OnClick)

Die onclick Aktion ausführen.

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 Sie auf das Laden warten. Das integrierte Seitenverhältnis des Bildes wird dadurch nicht überschrieben. Wenn die Richtlinie nicht konfiguriert ist, wird das Bild vom Server per Vorabruf gefüllt.

OnClick

Eine onclick Aktion ausführen (z. B. einen Link öffnen).

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 kann nur einer der folgenden Werte sein:

action

object (FormAction)

Durch diese Aktion wird eine Formularaktion onclick Aktion, falls angegeben.

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

Der Methodenname wird verwendet, um zu identifizieren, welcher Teil des Formulars die Übermittlung des Formulars ausgelöst hat. Diese Informationen werden beim Klick auf eine 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 Aufrufen der Aktionsmethode angegeben werden sollen. Betrachten Sie zum Beispiel drei Schaltflächen für die Schlummerfunktion: "Jetzt pausieren", "Schlummern an einem Tag" und "Schlummern für nächste Woche". Sie können action method = snooze() und übergeben den Typ und die Zeit für die Schlummerfunktion in der Liste der Stringparameter.

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 Aktionen enthalten: onclick Schaltfläche.

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 onclick Aktion ausführen. Nur das obere Label, das untere Label und der Inhaltsbereich sind anklickbar.

Union-Feld icons Mindestens eines der Symbole, top_label und bottom_label definiert werden muss. icons kann nur einer der folgenden Werte sein:
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.

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

object (Button)

Eine Schaltfläche, auf die zum Auslösen einer Aktion geklickt 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. Es kann sich um eine Text- oder eine Bildschaltfläche handeln.

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 kann nur einer der folgenden Werte sein:

textButton

object (TextButton)

Eine Schaltfläche mit Text und onclick Aktion ausführen.

imageButton

object (ImageButton)

Eine Schaltfläche mit Bild und onclick Aktion ausführen.

TextButton

Eine Schaltfläche mit Text und onclick Aktion ausführen.

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 einem onclick Aktion ausführen.

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 onclick Aktion ausführen.

name

string

Der Name dieses imageButton das für Barrierefreiheit genutzt wird. Wenn kein Name angegeben ist, wird ein Standardwert angegeben.

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

enum (Icon)

Das durch ein enum für ein von der Chat API bereitgestelltes Symbol.

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, das früher im Aktionsmenü angezeigt wurde.

onClick

object (OnClick)

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