Card

Eine Kartenoberfläche, die in einer Google Chat-Nachricht oder einem Google Workspace-Add-on angezeigt wird.

Karten unterstützen ein definiertes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Mit Karten können Sie detaillierte Informationen präsentieren, Informationen von Nutzern einholen und Nutzer zu einem nächsten Schritt anleiten.

Karten mit dem Card Builder entwerfen und in der Vorschau ansehen.

Karten-Builder öffnen

Informationen zum Erstellen von Karten finden Sie in der folgenden Dokumentation:

Hinweis: Sie können pro Karte bis zu 100 Widgets hinzufügen. Wenn die Widgets eines Abschnitts die Gesamtzahl über 100 steigen lassen, werden dieser gesamte Abschnitt und alle folgenden Abschnitte ignoriert. Dieses Limit gilt sowohl für Kartennachrichten und Dialogfelder in Google Chat-Apps als auch für Karten in Google Workspace-Add-ons.

Beispiel: Kartennachricht für eine Google Chat-App

Beispiel für eine Kontaktkarte

Verwenden Sie den folgenden JSON-Code, um die Beispielkartennachricht in Google Chat zu erstellen:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
JSON-Darstellung 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  },
  "expressionData": [
    {
      object (ExpressionData)
    }
  ]
}
Felder
header

object (CardHeader)

Die Kopfzeile der Karte. Ein Header enthält in der Regel ein Titelbild und einen Titel. Überschriften werden immer oben auf einer Karte angezeigt.
sections[]

object (Section)

Enthält eine Sammlung von Widgets. Jeder Abschnitt hat eine eigene, optionale Überschrift. Die Abschnitte sind durch eine Trennlinie voneinander getrennt. Ein Beispiel für Google Chat-Apps finden Sie unter Abschnitt einer Karte definieren.
sectionDividerStyle

enum (DividerStyle)

Der Stil der Trennlinie zwischen Kopfzeile, Abschnitten und Fußzeile.
cardActions[]

object (CardAction)

Die Aktionen der Karte. Die Aktionen werden dem Symbolleistenmenü der Karte hinzugefügt. Unterstützt bis zu 10 CardAction-Elemente.

 Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.

Mit dem folgenden JSON-Code wird beispielsweise ein Aktionsmenü für Karten mit den Optionen Settings und Send Feedback erstellt:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Name der Karte. Wird als Karten-ID in der Kartennavigation verwendet.

 Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.
displayStyle

enum (DisplayStyle)

In Google Workspace-Add-ons werden die Anzeigeeigenschaften des peekCardHeader festgelegt.

 Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.
peekCardHeader

object (CardHeader)

Wenn kontextbezogene Inhalte angezeigt werden, fungiert die Kopfzeile der Peek-Karte als Platzhalter, damit der Nutzer zwischen den Startseitenkarten und den kontextbezogenen Karten vorwärts navigieren kann.

 Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.
expressionData[]

object (ExpressionData)

Die Expressionsdaten für die Karte.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

CardHeader

Stellt eine Kartenkopfzeile dar. Ein Beispiel für Google Chat-Apps finden Sie unter Header hinzufügen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}
Felder
title

string

Erforderlich. Der Titel der Kartenkopfzeile. 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 Kartenkopfzeile. Wenn angegeben, wird sie in einer eigenen Zeile unter der title angezeigt.
imageType

enum (ImageType)

Die Form, die zum Zuschneiden des Bildes verwendet wird.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
imageUrl

string

Die HTTPS-URL des Bildes in der Kopfzeile der Karte.
imageAltText

string

Der Alt-Text dieses Bildes, der für Bedienungshilfen verwendet wird.

Bereich

Ein Abschnitt enthält eine Sammlung von Widgets, die vertikal in der angegebenen Reihenfolge gerendert werden.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "id": string,
  "collapseControl": {
    object (CollapseControl)
  }
}
Felder
header

string

Text, der oben in einem Abschnitt angezeigt wird. Unterstützt einfachen HTML-formatierten Text. 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 (Widget)

Alle Widgets im Abschnitt. Muss mindestens ein Widget enthalten. Eine Karte unterstützt bis zu 100 Widgets in allen Abschnitten.
collapsible

boolean

Gibt an, ob dieser Abschnitt minimiert werden kann.

In minimierbaren Abschnitten werden einige oder alle Widgets ausgeblendet. Nutzer können den Abschnitt jedoch maximieren, um die ausgeblendeten Widgets einzublenden, indem sie auf Mehr anzeigen klicken. Nutzer können die Widgets wieder ausblenden, indem sie auf Weniger anzeigen klicken.

Geben Sie uncollapsibleWidgetsCount an, um festzulegen, welche Widgets ausgeblendet werden sollen.
uncollapsibleWidgetsCount

integer

Die Anzahl der nicht minimierbaren Widgets, die auch dann sichtbar bleiben, wenn ein Bereich minimiert wird.

Wenn ein Abschnitt beispielsweise fünf Widgets enthält und uncollapsibleWidgetsCount auf 2 festgelegt ist, werden die ersten beiden Widgets immer angezeigt und die letzten drei sind standardmäßig minimiert. uncollapsibleWidgetsCount wird nur berücksichtigt, wenn collapsible true ist.
id

string

Eine eindeutige ID, die dem Abschnitt zugewiesen ist und zur Identifizierung des zu ändernden Abschnitts verwendet wird. Die ID darf maximal 64 Zeichen lang sein und muss das Format [a-zA-Z0-9-]+ haben.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
collapseControl

object (CollapseControl)

Optional. Definieren Sie die Schaltfläche zum Maximieren und Minimieren des Bereichs. Diese Schaltfläche wird nur angezeigt, wenn der Bereich minimiert werden kann. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.

Widget

Jede Karte besteht aus Widgets.

Ein Widget ist ein zusammengesetztes Objekt, das Text, Bilder, Schaltflächen und andere Objekttypen darstellen kann.

JSON-Darstellung 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "id": string,
  "visibility": enum (Visibility),
  "eventActions": [
    {
      object (EventAction)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
}
Felder
horizontalAlignment

enum (HorizontalAlignment)

Gibt an, ob Widgets links, rechts oder mittig in einer Spalte ausgerichtet werden.
id

string

Eine eindeutige ID, die dem Widget zugewiesen ist und zur Identifizierung des zu ändernden Widgets verwendet wird. Die ID darf maximal 64 Zeichen lang sein und muss das Format [a-zA-Z0-9-]+ haben.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
visibility

enum (Visibility)

Gibt an, ob das Widget sichtbar oder ausgeblendet ist. Der Standardwert ist VISIBLE.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
eventActions[]

object (EventAction)

Gibt die Ereignisaktionen an, die für das Widget ausgeführt werden können.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
Ein Widget kann nur eines der folgenden Elemente enthalten. Sie können mehrere Widget-Felder verwenden, um mehr Elemente anzuzeigen. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
textParagraph

object (TextParagraph)

Zeigt einen Textabsatz an. Unterstützt einfachen HTML-formatierten Text. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

Mit dem folgenden JSON-Code wird beispielsweise ein Text in Fettdruck erstellt:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

object (Image)

Zeigt ein Bild an.

Mit dem folgenden JSON-Code wird beispielsweise ein Bild mit Alternativtext erstellt:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

object (DecoratedText)

Zeigt ein dekoriertes Textelement an.

Mit dem folgenden JSON-Code wird beispielsweise ein Widget mit formatiertem Text erstellt, in dem eine E-Mail-Adresse angezeigt wird:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

object (ButtonList)

Eine Liste mit Schaltflächen.

Im folgenden JSON-Beispiel werden zwei Schaltflächen erstellt. Die erste ist eine blaue Textschaltfläche und die zweite eine Bildschaltfläche, über die ein Link geöffnet wird:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

object (TextInput)

Zeigt ein Textfeld an, in das Nutzer Text eingeben können.

Mit dem folgenden JSON-Code wird beispielsweise eine Texteingabe für eine E-Mail-Adresse erstellt:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Ein weiteres Beispiel: Mit dem folgenden JSON-Code wird eine Texteingabe für eine Programmiersprache mit statischen Vorschlägen erstellt:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

object (SelectionInput)

Zeigt ein Auswahlelement an, mit dem Nutzer Elemente auswählen können. Auswahlsteuerelemente können Kästchen, Optionsfelder, Schalter oder Drop-down-Menüs sein.

Mit dem folgenden JSON-Code wird beispielsweise ein Drop-down-Menü erstellt, über das Nutzer eine Größe auswählen können:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

object (DateTimePicker)

Zeigt ein Widget an, über das Nutzer ein Datum, eine Uhrzeit oder ein Datum und eine Uhrzeit eingeben können.

Mit dem folgenden JSON-Code wird beispielsweise eine Datum-/Uhrzeitauswahl zum Planen eines Termins erstellt:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": 796435200000
}
divider

object (Divider)

Zeigt eine horizontale Trennlinie zwischen Widgets an.

Mit dem folgenden JSON-Code wird beispielsweise ein Trennzeichen erstellt:

"divider": {
}
grid

object (Grid)

Zeigt ein Raster mit einer Sammlung von Elementen an.

Ein Raster unterstützt eine beliebige Anzahl von Spalten und Elementen. Die Anzahl der Zeilen wird durch die Obergrenze der Anzahl der Elemente geteilt durch die Anzahl der Spalten bestimmt. Ein Raster mit 10 Elementen und 2 Spalten hat 5 Zeilen. Ein Raster mit 11 Elementen und 2 Spalten hat 6 Zeilen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Mit dem folgenden JSON-Code wird beispielsweise ein Raster mit zwei Spalten und einem einzelnen Element erstellt:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
columns

object (Columns)

Es werden bis zu zwei Spalten angezeigt.

Wenn Sie mehr als zwei Spalten oder Zeilen verwenden möchten, verwenden Sie das Widget Grid.

Mit dem folgenden JSON-Code werden beispielsweise zwei Spalten erstellt, die jeweils Textabsätze enthalten:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

object (Carousel)

Enthält eine Sammlung von CarouselCard-Elementen, die jeweils verschachtelte Widgets enthalten. Hier ist ein Beispiel für eine JSON-Darstellung eines Karussells mit zwei Karussellkarten, die jeweils einen Textabsatz enthalten:

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in the carousel."
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in the carousel."
          }
        }
      ]
    }
  ]
}
chipList

object (ChipList)

Eine Liste von Chips.

Mit dem folgenden JSON-Code werden beispielsweise zwei Chips erstellt. Der erste ist ein Text-Chip und der zweite ein Symbol-Chip, über den ein Link geöffnet wird:

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
Ende der sich gegenseitig ausschließenden Felder.

TextParagraph

Ein Textabsatz, der formatiert werden kann. Ein Beispiel für Google Chat-Apps finden Sie unter Absatz mit formatiertem Text hinzufügen. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "text": string,
  "maxLines": integer,
  "textSyntax": enum (TextSyntax)
}
Felder
text

string

Der Text, der im Widget angezeigt wird.
maxLines

integer

Die maximale Anzahl von Textzeilen, die im Widget angezeigt werden. Wenn der Text die angegebene maximale Anzahl von Zeilen überschreitet, wird der überschüssige Inhalt hinter der Schaltfläche Mehr anzeigen verborgen. Wenn der Text kürzer oder gleich der angegebenen maximalen Anzahl von Zeilen ist, wird die Schaltfläche Mehr anzeigen nicht angezeigt.

Der Standardwert ist 0. In diesem Fall wird der gesamte Kontext angezeigt. Negative Werte werden ignoriert.
textSyntax

enum (TextSyntax)

Die Syntax des Texts. Wenn nicht festgelegt, wird der Text als HTML gerendert.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

TextSyntax

Syntax zum Formatieren von Text.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

Enums
TEXT_SYNTAX_UNSPECIFIED Wenn nicht angegeben, wird der Text als HTML gerendert.
HTML Der Text wird als HTML gerendert. „Immer“ ist der Standardwert.
MARKDOWN Der Text wird als Markdown gerendert.

Bild

Ein Bild, das durch eine URL angegeben wird und eine onClick-Aktion haben kann. Ein Beispiel finden Sie unter Bild hinzufügen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

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

string

Die HTTPS-URL, unter der das Bild gehostet wird.

Beispiel:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick

object (OnClick)

Wenn ein Nutzer auf das Bild klickt, wird diese Aktion ausgelöst.
altText

string

Der Alt-Text dieses Bildes, der für Bedienungshilfen verwendet wird.

DecoratedText

Ein Widget, das Text mit optionalen Dekorationen wie einem Label über oder unter dem Text, einem Symbol vor dem Text, einem Auswahl-Widget oder einer Schaltfläche nach dem Text anzeigt. Ein Beispiel für Google Chat-Apps finden Sie unter Text mit dekorativem Text anzeigen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
}
Felder
icon
(deprecated)

object (Icon)

Verworfen zugunsten von startIcon.
startIcon

object (Icon)

Das Symbol, das vor dem Text angezeigt wird.
startIconVerticalAlignment

enum (VerticalAlignment)

Optional. Vertikale Ausrichtung des Startsymbols. Wenn nicht festgelegt, wird das Symbol vertikal zentriert.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.
topLabel

string

Der Text, der über text angezeigt wird. Wird immer gekürzt.
topLabelText

object (TextParagraph)

TextParagraph-Äquivalent von topLabel. Wird immer gekürzt. Ermöglicht eine komplexere Formatierung als topLabel.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.
text

string

Erforderlich. Der primäre Text.

Unterstützt einfache Formatierung. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.
contentText

object (TextParagraph)

TextParagraph-Äquivalent von text. Ermöglicht komplexere Formatierungen als text.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.
wrapText

boolean

Die Einstellung für den Zeilenumbruch. Wenn true, wird der Text umgebrochen und in mehreren Zeilen angezeigt. Andernfalls wird der Text abgeschnitten.

Gilt nur für text, nicht für topLabel und bottomLabel.
bottomLabel

string

Der Text, der unter text angezeigt wird. Wird immer umgebrochen.
bottomLabelText

object (TextParagraph)

TextParagraph-Äquivalent von bottomLabel. Wird immer umgebrochen. Ermöglicht eine komplexere Formatierung als bottomLabel.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.
onClick

object (OnClick)

Diese Aktion wird ausgelöst, wenn Nutzer auf eine beliebige Stelle im DecoratedText-Widget klicken (einschließlich text, topLabel, bottomLabel und Symbole), außer wenn sie auf ein separates interaktives Steuerelement (button oder switchControl) klicken.
Eine Schaltfläche, ein Schalter, ein Kästchen oder ein Bild, das rechts neben dem Text im Widget decoratedText angezeigt wird. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
button

object (Button)

Eine Schaltfläche, auf die ein Nutzer klicken kann, um eine Aktion auszulösen.
switchControl

object (SwitchControl)

Ein Schalter-Widget, auf das ein Nutzer klicken kann, um den Status zu ändern und eine Aktion auszulösen.
endIcon

object (Icon)

Ein Symbol, das nach dem Text angezeigt wird.

Unterstützt integrierte und benutzerdefinierte Symbole.
Ende der sich gegenseitig ausschließenden Felder.

VerticalAlignment

Stellt das Attribut für die vertikale Ausrichtung dar.

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED Nicht definierter Typ. Nicht verwenden.
TOP Ausrichtung an der obersten Position.
MIDDLE Ausrichtung auf die mittlere Position.
BOTTOM Ausrichtung an der unteren Position.

SwitchControl

Entweder ein Schalter oder ein Kästchen in einem decoratedText-Widget.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Wird nur im decoratedText-Widget unterstützt.

JSON-Darstellung 
{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}
Felder
name

string

Der Name, mit dem das Schalter-Widget in einem Formulareingabeereignis identifiziert wird (als Schlüssel in CommonEventObject.form_inputs).

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
value

string

Der Wert, der in CommonEventObject.form_inputs[name].string_inputs zurückgegeben wird, wenn der Schalter ausgewählt ist (selected ist true). Wenn selected true ist und value nicht festgelegt ist, wird in stringInputs.value ein leerer String ("") zurückgegeben. Wenn selected den Wert false hat, wird dieser Wert in stringInputs.value weggelassen.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
selected

boolean

Wenn true, ist der Schalter ausgewählt und sein value ist in CommonEventObject.form_inputs[name].string_inputs.value enthalten.
onChangeAction

object (Action)

Die Aktion, die ausgeführt werden soll, wenn der Schalterstatus geändert wird, z. B. welche Funktion ausgeführt werden soll.
controlType

enum (ControlType)

So wird der Schalter auf der Benutzeroberfläche angezeigt.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

ControlType

So wird der Schalter auf der Benutzeroberfläche angezeigt.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
SWITCH Ein Schalter im Toggle-Stil.
CHECKBOX Verworfen zugunsten von CHECK_BOX.
CHECK_BOX Ein Kästchen.

TextInput

Ein Feld, in das Nutzer Text eingeben können. Unterstützt Vorschläge und Aktionen bei Änderungen. Unterstützt die Validierung von Formulareinreichungen. Wenn Action.all_widgets_are_required auf true gesetzt ist oder dieses Widget in Action.required_widgets angegeben ist, wird die Sendeaktion blockiert, bis ein Wert eingegeben wird. Ein Beispiel für Google Chat-Apps finden Sie unter Feld hinzufügen, in das ein Nutzer Text eingeben kann.

Chat-Apps empfangen und können den Wert des eingegebenen Texts während der Formulareingabeereignisse verarbeiten. Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.

Wenn Sie undefinierte oder abstrakte Daten von Nutzern erheben müssen, verwenden Sie eine Texteingabe. Wenn Sie definierte oder aufgezählte Daten von Nutzern erfassen möchten, verwenden Sie das Widget SelectionInput.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string,

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Felder
name

string

Der Name, unter dem die Texteingabe in einem Formulareingabeereignis identifiziert wird.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
label

string

Der Text, der in der Benutzeroberfläche über dem Texteingabefeld angezeigt wird.

Geben Sie Text an, der dem Nutzer hilft, die von Ihrer App benötigten Informationen einzugeben. Wenn Sie beispielsweise nach dem Namen einer Person fragen, aber speziell den Nachnamen benötigen, schreiben Sie surname anstelle von name.

Erforderlich, wenn hintText nicht angegeben ist. Andernfalls ist es optional.
hintText

string

Text, der unter dem Texteingabefeld angezeigt wird und Nutzer auffordert, einen bestimmten Wert einzugeben. Dieser Text ist immer sichtbar.

Erforderlich, wenn label nicht angegeben ist. Andernfalls ist es optional.
value

string

Der von einem Nutzer eingegebene Wert, der als Teil eines Formulareingabeereignisses zurückgegeben wird.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
type

enum (Type)

Wie ein Texteingabefeld in der Benutzeroberfläche angezeigt wird. Beispielsweise, ob das Feld ein- oder mehrzeilig ist.
onChangeAction

object (Action)

Was soll passieren, wenn sich der Inhalt des Texteingabefelds ändert? Beispielsweise, wenn ein Nutzer Text hinzufügt oder löscht.

Beispiele für Aktionen sind das Ausführen einer benutzerdefinierten Funktion oder das Öffnen eines Dialogfelds in Google Chat.
initialSuggestions

object (Suggestions)

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzer in das Texteingabefeld klicken. Während Nutzer Text eingeben, werden die vorgeschlagenen Werte dynamisch gefiltert, um den eingegebenen Text zu berücksichtigen.

In einem Texteingabefeld für die Programmiersprache könnten beispielsweise Java, JavaScript, Python und C++ vorgeschlagen werden. Wenn Nutzer mit der Eingabe von Jav beginnen, wird die Liste der Vorschläge gefiltert, sodass nur Java und JavaScript angezeigt werden.

Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die Ihre App verarbeiten kann. Wenn Nutzer nach JavaScript suchen, geben einige möglicherweise javascript und andere java script ein. Wenn Sie JavaScript vorschlagen, können Sie die Interaktion der Nutzer mit Ihrer App standardisieren.

Wenn angegeben, ist TextInput.type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE festgelegt ist.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
autoCompleteAction

object (Action)

Optional. Geben Sie an, welche Aktion ausgeführt werden soll, wenn das Texteingabefeld Nutzern, die damit interagieren, Vorschläge macht.

Wenn nicht angegeben, werden die Vorschläge von initialSuggestions festgelegt und vom Client verarbeitet.

Wenn angegeben, führt die App die hier angegebene Aktion aus, z. B. eine benutzerdefinierte Funktion.

 Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.
validation

object (Validation)

Geben Sie die für dieses Textfeld erforderliche Validierung des Eingabeformats an.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
placeholderText

string

Text, der im Texteingabefeld angezeigt wird, wenn das Feld leer ist. Verwenden Sie diesen Text, um Nutzer zur Eingabe eines Werts aufzufordern. Beispiel: Enter a number from 0 to 100.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
hostAppDataSource

object (HostAppDataSourceMarkup)

Eine Datenquelle, die für eine Google Workspace-Hostanwendung eindeutig ist, z. B. Gmail-E-Mails, Google Kalender-Termine oder Google Chat-Nachrichten.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
Ende der sich gegenseitig ausschließenden Felder.

Typ

Wie ein Texteingabefeld in der Benutzeroberfläche angezeigt wird. Zum Beispiel, ob es sich um ein einzeiliges oder mehrzeiliges Eingabefeld handelt. Wenn initialSuggestions angegeben ist, ist type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE festgelegt ist.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
SINGLE_LINE Das Texteingabefeld hat eine feste Höhe von einer Zeile.
MULTIPLE_LINE Das Texteingabefeld hat eine feste Höhe von mehreren Zeilen.

RenderActions

Eine Reihe von Renderinganweisungen, die eine Karte anweisen, eine Aktion auszuführen, oder die Host-App des Add-ons oder die Chat-App anweisen, eine App-spezifische Aktion auszuführen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Felder
action

Action

Aktion

Felder
navigations[]

Navigation

Fügt eine Karte hinzu, entfernt sie oder aktualisiert sie.

Add-ons in Google Chat

Fügen Sie dem Stapel eine neue Karte hinzu (vorwärts navigieren). Für Chat-Apps nur für die App-Startseite verfügbar.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

navigations: {
  pushCard: CARD
}

Ersetze die oberste Karte durch eine neue Karte. Für Chat-Apps nur auf der Startseite der App verfügbar.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

navigations: {
  updateCard: CARD
}

Vorschläge

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzer in das Texteingabefeld klicken. Während Nutzer Text eingeben, werden die vorgeschlagenen Werte dynamisch gefiltert, um den eingegebenen Text zu berücksichtigen.

In einem Texteingabefeld für die Programmiersprache könnten beispielsweise Java, JavaScript, Python und C++ vorgeschlagen werden. Wenn Nutzer mit der Eingabe von Jav beginnen, wird die Liste der Vorschläge gefiltert und es werden Java und JavaScript angezeigt.

Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die Ihre App verarbeiten kann. Wenn Nutzer nach JavaScript suchen, geben einige möglicherweise javascript und andere java script ein. Wenn Sie JavaScript vorschlagen, können Sie die Interaktion der Nutzer mit Ihrer App standardisieren.

Wenn angegeben, ist TextInput.type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE festgelegt ist.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}
Felder
items[]

object (SuggestionItem)

Eine Liste mit Vorschlägen für die automatische Vervollständigung in Texteingabefeldern.

SuggestionItem

Ein vorgeschlagener Wert, den Nutzer in ein Texteingabefeld eingeben können.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{

  "text": string
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
text

string

Der Wert einer vorgeschlagenen Eingabe in ein Texteingabefeld. Dies entspricht dem, was Nutzer selbst eingeben.
Ende der sich gegenseitig ausschließenden Felder.

Validierung

Stellt die erforderlichen Daten zum Validieren des Widgets dar, an das es angehängt ist.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "characterLimit": integer,
  "inputType": enum (InputType)
}
Felder
characterLimit

integer

Geben Sie die Zeichenbeschränkung für Widgets zur Texteingabe an. Beachten Sie, dass dies nur für die Texteingabe verwendet und für andere Widgets ignoriert wird.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
inputType

enum (InputType)

Geben Sie den Typ der Eingabe-Widgets an.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

InputType

Der Typ des Eingabe-Widgets.

Enums
INPUT_TYPE_UNSPECIFIED Nicht definierter Typ. Nicht verwenden.
TEXT Normaler Text, der alle Zeichen akzeptiert.
INTEGER Ein ganzzahliger Wert.
FLOAT Ein Gleitkommawert.
EMAIL Eine E-Mail-Adresse.
EMOJI_PICKER Ein Emoji, das über die vom System bereitgestellte Emoji-Auswahl ausgewählt wurde.

HostAppDataSourceMarkup

Eine Datenquelle aus einer Google Workspace-Anwendung. Die Datenquelle füllt die verfügbaren Elemente für ein Widget.

JSON-Darstellung 
{

  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  },
  "workflowDataSource": {
    object (WorkflowDataSourceMarkup)
  }
}
Felder
Die Google Workspace-Anwendung, die verfügbare Elemente für ein Widget bereitstellt. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
chatDataSource

object (ChatClientDataSourceMarkup)

Eine Datenquelle aus Google Chat.
workflowDataSource

object (WorkflowDataSourceMarkup)

Eine Datenquelle aus Google Workflow.
Ende der sich gegenseitig ausschließenden Felder.

ChatClientDataSourceMarkup

Für ein SelectionInput-Widget, das ein Menü mit Mehrfachauswahl verwendet, eine Datenquelle aus Google Chat. Die Datenquelle füllt die Auswahlelemente für das Mehrfachauswahlmenü. Nutzer können beispielsweise Google Chat-Bereiche auswählen, in denen sie Mitglied sind.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

JSON-Darstellung 
{

  "spaceDataSource": {
    object (SpaceDataSource)
  }
}
Felder
Die Google Chat-Datenquelle Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
spaceDataSource

object (SpaceDataSource)

Google Chat-Bereiche, in denen der Nutzer Mitglied ist.
Ende der sich gegenseitig ausschließenden Felder.

SpaceDataSource

Eine Datenquelle, die Google Chat-Bereiche als Auswahlelemente für ein Mehrfachauswahlmenü füllt. Es werden nur Spaces angezeigt, in denen der Nutzer Mitglied ist.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

JSON-Darstellung 
{
  "defaultToCurrentSpace": boolean
}
Felder
defaultToCurrentSpace

boolean

Wenn der Wert auf true festgelegt ist, wird im Mehrfachauswahlmenü standardmäßig der aktuelle Google Chat-Bereich als Element ausgewählt.

WorkflowDataSourceMarkup

* Wird nur von Google Workspace Workflow unterstützt, nicht von Google Chat-Apps oder Google Workspace-Add-ons.

Geben Sie in einem TextInput- oder SelectionInput-Widget vom Typ MULTI_SELECT oder in einem DateTimePicker eine Datenquelle von Google an.

JSON-Darstellung 
{
  "includeVariables": boolean,
  "type": enum (Type)
}
Felder
includeVariables

boolean

Gibt an, ob Variablen aus dem vorherigen Schritt in die Datenquelle aufgenommen werden sollen.
type

enum (Type)

Der Typ der Datenquelle.

Typ

Ein Enum, das den Typ der Workflow-Datenquelle darstellt.

Enums
UNKNOWN Standardwert. Nicht verwenden.
USER Google Workspace-Nutzer Der Nutzer kann nur Nutzer aus seiner Google Workspace-Organisation sehen und auswählen.
SPACE Google Chat-Bereiche, in denen der Nutzer Mitglied ist.
USER_WITH_FREE_FORM Nutzer können vorhandene Mitglieder aus ihrer Google Workspace-Organisation aufrufen und auswählen oder manuell eine E-Mail-Adresse oder eine gültige Domain eingeben.

SelectionInput

Ein Widget, das ein oder mehrere UI-Elemente erstellt, die Nutzer auswählen können. Unterstützt die Validierung von Formulareinreichungen nur für die Menüs dropdown und multiselect. Wenn Action.all_widgets_are_required auf true festgelegt ist oder dieses Widget in Action.required_widgets angegeben ist, wird die Sendeaktion blockiert, bis ein Wert ausgewählt wird. Beispiele sind Drop-down-Menüs oder Kästchen. Mit diesem Widget können Sie Daten erfassen, die vorhergesagt oder aufgezählt werden können. Ein Beispiel für Google Chat-Apps finden Sie unter Auswählbare UI-Elemente hinzufügen.

Chat-Apps können den Wert von Elementen verarbeiten, die Nutzer auswählen oder eingeben. Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.

Wenn Sie undefinierte oder abstrakte Daten von Nutzern erfassen möchten, verwenden Sie das Widget TextInput.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMinQueryLength": integer,
  "dataSourceConfigs": [
    {
      object (DataSourceConfig)
    }
  ],
  "multiSelectMaxSelectedItems": integer,
  "hintText": string,

  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
}
Felder
name

string

Erforderlich. Der Name, der die Auswahleingabe in einem Formulareingabeereignis identifiziert.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
label

string

Der Text, der in der Benutzeroberfläche über dem Eingabefeld für die Auswahl angezeigt wird.

Geben Sie Text an, der dem Nutzer hilft, die von Ihrer App benötigten Informationen einzugeben. Wenn Nutzer beispielsweise die Dringlichkeit eines Arbeitstickets aus einem Drop-down-Menü auswählen, könnte das Label „Dringlichkeit“ oder „Dringlichkeit auswählen“ lauten.
type

enum (SelectionType)

Der Typ der Elemente, die Nutzern in einem SelectionInput-Widget angezeigt werden. Auswahltypen unterstützen verschiedene Arten von Interaktionen. Nutzer können beispielsweise ein oder mehrere Kästchen anklicken, aber nur einen Wert aus einem Drop-down-Menü auswählen.
items[]

object (SelectionItem)

Ein Array mit auswählbaren Elementen. Beispiel: ein Array von Optionsfeldern oder Kästchen. Unterstützt bis zu 100 Elemente.
onChangeAction

object (Action)

Wenn angegeben, wird das Formular gesendet, wenn sich die Auswahl ändert. Wenn Sie nichts angeben, müssen Sie einen separaten Button angeben, über den das Formular gesendet wird.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
multiSelectMinQueryLength

integer

Bei Menüs mit Mehrfachauswahl die Anzahl der Textzeichen, die ein Nutzer eingibt, bevor das Menü vorgeschlagene Auswahlelemente zurückgibt.

Wenn die Werte nicht festgelegt sind, werden im Menü für die Mehrfachauswahl die folgenden Standardwerte verwendet:

  • Wenn das Menü ein statisches Array von SelectionInput-Elementen verwendet, wird standardmäßig 0 Zeichen verwendet und die Elemente aus dem Array werden sofort eingefügt.
  • Wenn das Menü eine dynamische Datenquelle (multi_select_data_source) verwendet, werden standardmäßig 3 Zeichen verwendet, bevor die Datenquelle abgefragt wird, um vorgeschlagene Elemente zurückzugeben.
dataSourceConfigs[]

object (DataSourceConfig)

Optional. Die Datenquellenkonfigurationen für das Auswahlsteuerelement. Dieses Feld bietet eine detailliertere Kontrolle über die Datenquelle.

Wenn angegeben, werden die Felder multiSelectMaxSelectedItems, multiSelectMinQueryLength, externalDataSource und platformDataSource ignoriert.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern.

Verfügbar für die Dropdown widget in Google Chat-Apps. Für das Widget Dropdown in Google Chat-Apps wird nur ein DataSourceConfig unterstützt. Wenn mehrere DataSourceConfigs festgelegt sind, wird nur der erste verwendet.
multiSelectMaxSelectedItems

integer

Bei Menüs mit Mehrfachauswahl die maximale Anzahl von Elementen, die ein Nutzer auswählen kann. Der Mindestwert beträgt 1 Element. Wenn nicht angegeben, wird der Wert standardmäßig auf 3 Elemente gesetzt.
hintText

string

Optional. Text, der unter dem Eingabefeld für die Auswahl angezeigt wird und Nutzer auffordert, einen bestimmten Wert einzugeben. Dieser Text ist immer sichtbar.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

Für ein Menü mit Mehrfachauswahl eine Datenquelle, die die Auswahlelemente dynamisch füllt.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
externalDataSource

object (Action)

Eine externe Datenquelle, z. B. eine relationale Datenbank.
platformDataSource

object (PlatformDataSource)

Eine Datenquelle aus Google Workspace.
Ende der sich gegenseitig ausschließenden Felder.

SelectionType

Das Format für die Elemente, die Nutzer auswählen können. Die verschiedenen Optionen unterstützen unterschiedliche Arten von Interaktionen. Nutzer können beispielsweise mehrere Kästchen anklicken, aber nur ein Element aus einem Drop-down-Menü auswählen.

Jede Eingabe unterstützt einen Auswahltyp. Das Mischen von Kästchen und Schaltern wird beispielsweise nicht unterstützt.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
CHECK_BOX Eine Reihe von Kästchen. Nutzer können ein oder mehrere Kästchen auswählen.
RADIO_BUTTON Eine Reihe von Optionsfeldern. Nutzer können ein Optionsfeld auswählen.
SWITCH Eine Reihe von Schaltern. Nutzer können einen oder mehrere Schalter aktivieren.
DROPDOWN

Ein Drop-down-Menü. Nutzer können ein Element aus dem Menü auswählen.

In Google Chat-Apps können Sie Elemente mithilfe einer dynamischen Datenquelle füllen und Elemente automatisch vorschlagen, während Nutzer im Menü etwas eingeben. Wenn Nutzer beispielsweise den Namen eines Google Chat-Bereichs eingeben, wird der Bereich automatisch vom Widget vorgeschlagen. Wenn Sie Elemente für ein Drop-down-Menü dynamisch füllen möchten, verwenden Sie einen der folgenden Datenquellentypen:

  • Google Workspace-Daten: Elemente werden mit Daten aus Google Workspace gefüllt, z. B. Google Workspace-Nutzer oder Google Chat-Bereiche.
  • Externe Daten: Elemente werden aus einer externen Datenquelle außerhalb von Google Workspace eingefügt.

Beispiele für die Implementierung von Drop-down-Menüs für Chat-Apps finden Sie unter Drop-down-Menü hinzufügen und Drop-down-Menüs dynamisch füllen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
MULTI_SELECT

Ein Menü mit einem Textfeld. Nutzer können ein oder mehrere Elemente eingeben und auswählen. Bei Google Workspace-Add-ons müssen Sie Elemente mit einem statischen Array von SelectionItem-Objekten füllen.

In Google Chat-Apps können Sie Elemente auch über eine dynamische Datenquelle füllen und Elemente automatisch vorschlagen, während Nutzer im Menü tippen. Wenn Nutzer beispielsweise den Namen eines Google Chat-Bereichs eingeben, wird der Bereich automatisch vom Widget vorgeschlagen. Wenn Sie Elemente für ein Menü mit Mehrfachauswahl dynamisch füllen möchten, verwenden Sie einen der folgenden Datenquellentypen:

  • Google Workspace-Daten: Elemente werden mit Daten aus Google Workspace gefüllt, z. B. Google Workspace-Nutzer oder Google Chat-Bereiche.
  • Externe Daten: Elemente werden aus einer externen Datenquelle außerhalb von Google Workspace eingefügt.

Beispiele für die Implementierung von Mehrfachauswahlmenüs für Chat-Apps finden Sie unter Mehrfachauswahlmenü hinzufügen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

PlatformDataSource

Für ein SelectionInput-Widget, das ein Menü mit Mehrfachauswahl verwendet, eine Datenquelle aus Google Workspace. Wird verwendet, um Elemente in einem Mehrfachauswahlmenü zu füllen.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

JSON-Darstellung 
{

  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Felder
Die Datenquelle Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
commonDataSource

enum (CommonDataSource)

Eine Datenquelle, die von allen Google Workspace-Anwendungen gemeinsam genutzt wird, z. B. Nutzer in einer Google Workspace-Organisation.
hostAppDataSource

object (HostAppDataSourceMarkup)

Eine Datenquelle, die nur in einer Google Workspace-Hostanwendung vorhanden ist, z. B. Gruppenbereiche in Google Chat.

Dieses Feld unterstützt die Google API-Clientbibliotheken, ist aber in den Cloud-Clientbibliotheken nicht verfügbar. Weitere Informationen finden Sie unter Clientbibliotheken installieren.
Ende der sich gegenseitig ausschließenden Felder.

CommonDataSource

Eine Datenquelle, die von allen Google Workspace-Anwendungen gemeinsam genutzt wird.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

Enums
UNKNOWN Standardwert. Nicht verwenden.
USER Google Workspace-Nutzer Der Nutzer kann nur Nutzer aus seiner Google Workspace-Organisation sehen und auswählen.

DataSourceConfig

Ein Konfigurationsobjekt, mit dem die Datenquellen für ein Widget konfiguriert werden können.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons, die Google Workspace Studio erweitern.

JSON-Darstellung 
{

  "remoteDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  "minCharactersTrigger": integer
}
Felder
Die Datenquelle Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
remoteDataSource

object (Action)

Die Daten stammen von einem Remote-Datenanbieter.
platformDataSource

object (PlatformDataSource)

Die Daten stammen aus einer Google Workspace-Anwendung.
Ende der sich gegenseitig ausschließenden Felder.
minCharactersTrigger

integer

Die Mindestanzahl von Zeichen, die der Nutzer eingeben muss, bevor dieser Datenanbieter ausgelöst wird (d.h. bevor er Ergebnisse zurückgibt).

DateTimePicker

Ermöglicht Nutzern, ein Datum, eine Uhrzeit oder beides einzugeben. Unterstützt die Validierung von Formulareinreichungen. Wenn Action.all_widgets_are_required auf true festgelegt ist oder dieses Widget in Action.required_widgets angegeben ist, wird die Sendeaktion blockiert, bis ein Wert ausgewählt wird. Ein Beispiel für Google Chat-Apps finden Sie unter Nutzer ein Datum und eine Uhrzeit auswählen lassen.

Nutzer können Text eingeben oder die Auswahl verwenden, um Datum und Uhrzeit auszuwählen. Wenn Nutzer ein ungültiges Datum oder eine ungültige Uhrzeit eingeben, wird eine Fehlermeldung angezeigt, in der sie aufgefordert werden, die Informationen korrekt einzugeben.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },

  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
}
Felder
name

string

Der Name, mit dem das DateTimePicker in einem Formulareingabeereignis identifiziert wird.

Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
label

string

Der Text, der Nutzer auffordert, ein Datum, eine Uhrzeit oder ein Datum und eine Uhrzeit einzugeben. Wenn Nutzer beispielsweise einen Termin vereinbaren, verwenden Sie ein Label wie Appointment date oder Appointment date and time.
type

enum (DateTimePickerType)

Gibt an, ob das Widget die Eingabe eines Datums, einer Uhrzeit oder von Datum und Uhrzeit unterstützt.
valueMsEpoch

string (int64 format)

Der im Widget angezeigte Standardwert in Millisekunden seit der Unix-Epochenzeit.

Geben Sie den Wert basierend auf dem Typ der Auswahl (DateTimePickerType) an:

  • DATE_AND_TIME: ein Kalenderdatum und eine Uhrzeit in UTC. Wenn Sie beispielsweise den 1. Januar 2023 um 12:00 Uhr UTC darstellen möchten, verwenden Sie 1672574400000.
  • DATE_ONLY: ein Kalenderdatum um 00:00:00 Uhr UTC. Verwenden Sie beispielsweise 1672531200000, um den 1. Januar 2023 darzustellen.
  • TIME_ONLY: eine Uhrzeit in UTC. Beispiel: 12:00 Uhr wird als 43200000 (oder 12 * 60 * 60 * 1000) dargestellt.
timezoneOffsetDate

integer

Die Zahl, die die Zeitzonenabweichung von UTC in Minuten darstellt. Wenn festgelegt, wird der valueMsEpoch in der angegebenen Zeitzone angezeigt. Wenn nicht festgelegt, wird standardmäßig die Zeitzoneneinstellung des Nutzers verwendet.

Hinweis: Dieses Feld wird in Minuten angegeben, während die Nutzlasten von Nutzerinteraktionsereignissen in der Regel Zeitzonenabweichungen in Millisekunden enthalten (durch 60000 teilen, um sie umzurechnen).
onChangeAction

object (Action)

Wird ausgelöst, wenn der Nutzer in der DateTimePicker-Oberfläche auf Speichern oder Löschen klickt.
Die Datenquelle, die ein Datum und eine Uhrzeit darstellen soll. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
hostAppDataSource

object (HostAppDataSourceMarkup)

Eine Datenquelle, die für eine Google Workspace-Hostanwendung eindeutig ist, z. B. Gmail-E-Mails, Google Kalender-Termine oder Google Chat-Nachrichten.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.
Ende der sich gegenseitig ausschließenden Felder.

DateTimePickerType

Das Format für Datum und Uhrzeit im Widget DateTimePicker. Legt fest, ob Nutzer ein Datum, eine Uhrzeit oder beides eingeben können.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
DATE_AND_TIME Nutzer geben ein Datum und eine Uhrzeit ein.
DATE_ONLY Nutzer geben ein Datum ein.
TIME_ONLY Nutzer geben eine Zeit ein.

Trennlinie

Dieser Typ hat keine Felder.

Zeigt eine Trennlinie zwischen Widgets als horizontale Linie an. Ein Beispiel für Google Chat-Apps finden Sie unter Horizontale Trennlinie zwischen Widgets hinzufügen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Mit dem folgenden JSON-Code wird beispielsweise ein Trennzeichen erstellt:

"divider": {}

Raster

Zeigt ein Raster mit einer Sammlung von Elementen an. Elemente können nur Text oder Bilder enthalten. Verwenden Sie Columns für responsive Spalten oder um mehr als nur Text oder Bilder einzufügen. Ein Beispiel für Google Chat-Apps finden Sie unter Raster mit einer Sammlung von Elementen anzeigen.

Ein Raster unterstützt eine beliebige Anzahl von Spalten und Elementen. Die Anzahl der Zeilen wird durch die Anzahl der Elemente geteilt durch die Anzahl der Spalten bestimmt. Ein Raster mit 10 Elementen und 2 Spalten hat 5 Zeilen. Ein Raster mit 11 Elementen und 2 Spalten hat 6 Zeilen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Mit dem folgenden JSON-Code wird beispielsweise ein Raster mit zwei Spalten und einem einzelnen Element erstellt:

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}
JSON-Darstellung 
{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}
Felder
title

string

Der Text, der in der Kopfzeile des Rasters angezeigt wird.
items[]

object (GridItem)

Die Elemente, die im Raster angezeigt werden sollen.
borderStyle

object (BorderStyle)

Der Rahmenstil, der auf jedes Rasterelement angewendet werden soll.
columnCount

integer

Die Anzahl der Spalten, die im Raster angezeigt werden sollen. Wenn dieses Feld nicht angegeben ist, wird ein Standardwert verwendet. Dieser Standardwert variiert je nachdem, wo das Raster angezeigt wird (Dialogfeld oder Companion).
onClick

object (OnClick)

Dieser Callback wird von jedem einzelnen Rasterelement wiederverwendet, wobei die ID des Elements den Parametern des Callbacks (unter dem Schlüssel "grid_item_identifier") hinzugefügt wird.

GridItem

Stellt ein Element in einem Rasterlayout dar. Elemente können Text, ein Bild oder beides enthalten.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}
Felder
id

string

Eine vom Nutzer angegebene Kennung für dieses Rasterelement. Diese Kennung wird in den Callback-Parametern onClick des übergeordneten Rasters zurückgegeben.
image

object (ImageComponent)

Das Bild, das im Rasterelement angezeigt wird.
title

string

Der Titel des Rasterelements.
subtitle

string

Der Untertitel des Rasterelements.
layout

enum (GridItemLayout)

Das Layout, das für das Rasterelement verwendet werden soll.

ImageComponent

Stellt ein Bild dar.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}
Felder
imageUri

string

Die Bild-URL.
altText

string

Das Bedienungshilfen-Label für das Bild.
cropStyle

object (ImageCropStyle)

Der Zuschneidestil, der auf das Bild angewendet werden soll.
borderStyle

object (BorderStyle)

Der Rahmenstil, der auf das Bild angewendet werden soll.

ImageCropStyle

Stellt den Zuschneidestil dar, der auf ein Bild angewendet wird.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

So wenden Sie beispielsweise ein Seitenverhältnis von 16:9 an:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
JSON-Darstellung 
{
  "type": enum (ImageCropType),
  "aspectRatio": number
}
Felder
type

enum (ImageCropType)

Der Kulturtyp.
aspectRatio

number

Das Seitenverhältnis, das verwendet werden soll, wenn der Zuschneidetyp RECTANGLE_CUSTOM ist.

So wenden Sie beispielsweise ein Seitenverhältnis von 16:9 an:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

Stellt den Zuschneidestil dar, der auf ein Bild angewendet wird.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
IMAGE_CROP_TYPE_UNSPECIFIED Nicht verwenden. Nicht angegeben
SQUARE Standardwert. Wendet einen quadratischen Zuschnitt an.
CIRCLE Wendet einen kreisförmigen Zuschnitt an.
RECTANGLE_CUSTOM Wendet einen rechteckigen Zuschnitt mit einem benutzerdefinierten Seitenverhältnis an. Legen Sie das benutzerdefinierte Seitenverhältnis mit aspectRatio fest.
RECTANGLE_4_3 Wendet einen rechteckigen Zuschnitt mit einem Seitenverhältnis von 4:3 an.

BorderStyle

Die Stiloptionen für den Rahmen einer Karte oder eines Widgets, einschließlich Rahmentyp und -farbe.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}
Felder
type

enum (BorderType)

Der Typ der Rahmenlinie.
strokeColor

object (Color)

Die Farben, die verwendet werden sollen, wenn der Typ BORDER_TYPE_STROKE ist.

Wenn Sie die Strichfarbe festlegen möchten, geben Sie einen Wert für die Felder red, green und blue an. Der Wert muss eine Gleitkommazahl zwischen 0 und 1 sein, die auf dem RGB-Farbwert basiert. Dabei steht 0 (0/255) für das Fehlen von Farbe und 1 (255/255) für die maximale Intensität der Farbe.

Im folgenden Beispiel wird die Farbe Rot mit maximaler Intensität festgelegt:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Das Feld alpha ist für die Strichfarbe nicht verfügbar. Wenn angegeben, wird dieses Feld ignoriert.
cornerRadius

integer

Der Eckenradius für den Rahmen.

BorderType

Stellt die Rahmentypen dar, die auf Widgets angewendet werden.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
BORDER_TYPE_UNSPECIFIED Nicht verwenden. Nicht angegeben
NO_BORDER Kein Rand.
STROKE Standardwert. Outline.

GridItemLayout

Stellt die verschiedenen Layoutoptionen dar, die für ein Rasterelement verfügbar sind.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
GRID_ITEM_LAYOUT_UNSPECIFIED Nicht verwenden. Nicht angegeben
TEXT_BELOW Der Titel und der Untertitel werden unter dem Bild des Rasterelements angezeigt.
TEXT_ABOVE Titel und Untertitel werden über dem Bild des Rasterelements angezeigt.

Spalten

Das Widget Columns zeigt bis zu zwei Spalten in einer Karte oder einem Dialogfeld an. Sie können jeder Spalte Widgets hinzufügen. Die Widgets werden in der Reihenfolge angezeigt, in der sie angegeben sind. Ein Beispiel für Google Chat-Apps finden Sie unter Karten und Dialogfelder in Spalten anzeigen.

Die Höhe jeder Spalte wird durch die höhere Spalte bestimmt. Wenn beispielsweise die erste Spalte höher als die zweite ist, haben beide Spalten die Höhe der ersten Spalte. Da jede Spalte eine andere Anzahl von Widgets enthalten kann, ist es nicht möglich, Zeilen zu definieren oder Widgets zwischen den Spalten auszurichten.

Spalten werden nebeneinander angezeigt. Mit dem Feld HorizontalSizeStyle können Sie die Breite jeder Spalte anpassen. Wenn die Bildschirmbreite des Nutzers zu gering ist, wird die zweite Spalte unter der ersten umgebrochen:

  • Im Web wird die zweite Spalte umgebrochen, wenn die Bildschirmbreite maximal 480 Pixel beträgt.
  • Auf iOS-Geräten wird die zweite Spalte umgebrochen, wenn die Bildschirmbreite kleiner oder gleich 300 pt ist.
  • Auf Android-Geräten wird die zweite Spalte umgebrochen, wenn die Bildschirmbreite kleiner oder gleich 320 dp ist.

Wenn Sie mehr als zwei Spalten einfügen oder Zeilen verwenden möchten, verwenden Sie das Widget Grid.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons. Zu den Add-on-UIs, die Spalten unterstützen, gehören:

  • Das Dialogfeld, das angezeigt wird, wenn Nutzer das Add-on aus einem E-Mail-Entwurf öffnen.
  • Das Dialogfeld, das angezeigt wird, wenn Nutzer das Add-on über das Menü Anhang hinzufügen in einem Google Kalender-Termin öffnen.
JSON-Darstellung 
{
  "columnItems": [
    {
      object (Column)
    }
  ]
}
Felder
columnItems[]

object (Column)

Ein Array von Spalten. Sie können bis zu zwei Spalten in eine Karte oder ein Dialogfeld einfügen.

Spalte

Eine Spalte.

Google Workspace-Add-ons und Chat-Apps

JSON-Darstellung 
{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}
Felder
horizontalSizeStyle

enum (HorizontalSizeStyle)

Gibt an, wie eine Spalte die Breite der Karte ausfüllt.
horizontalAlignment

enum (HorizontalAlignment)

Gibt an, ob Widgets links, rechts oder mittig in einer Spalte ausgerichtet werden.
verticalAlignment

enum (VerticalAlignment)

Gibt an, ob Widgets oben, unten oder in der Mitte einer Spalte ausgerichtet werden.
widgets[]

object (Widgets)

Ein Array von Widgets, die in einer Spalte enthalten sind. Widgets werden in der Reihenfolge angezeigt, in der sie angegeben sind.

HorizontalSizeStyle

Gibt an, wie eine Spalte die Breite der Karte ausfüllt. Die Breite jeder Spalte hängt sowohl von der HorizontalSizeStyle als auch von der Breite der Widgets in der Spalte ab.

Google Workspace-Add-ons und Chat-Apps

Enums
HORIZONTAL_SIZE_STYLE_UNSPECIFIED Nicht verwenden. Nicht angegeben
FILL_AVAILABLE_SPACE Standardwert. Die Spalte füllt den verfügbaren Platz bis zu 70 % der Kartenbreite aus. Wenn beide Spalten auf FILL_AVAILABLE_SPACE festgelegt sind, füllt jede Spalte 50 % des Platzes aus.
FILL_MINIMUM_SPACE Die Spalte nimmt so wenig Platz wie möglich ein und nicht mehr als 30 % der Breite der Karte.

HorizontalAlignment

Gibt an, ob Widgets links, rechts oder mittig in einer Spalte ausgerichtet werden.

Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED Nicht verwenden. Nicht angegeben
START Standardwert. Richtet Widgets an der Startposition der Spalte aus. Bei Layouts von links nach rechts wird linksbündig ausgerichtet. Bei linksläufigen Layouts wird rechtsbündig ausgerichtet.
CENTER Richtet Widgets an der Mitte der Spalte aus.
END Richtet Widgets an der Endposition der Spalte aus. Bei Layouts von links nach rechts werden Widgets rechtsbündig ausgerichtet. Bei linksläufigen Layouts werden Widgets linksbündig ausgerichtet.

VerticalAlignment

Gibt an, ob Widgets oben, unten oder in der Mitte einer Spalte ausgerichtet werden.

Google Workspace-Add-ons und Chat-Apps

Enums
VERTICAL_ALIGNMENT_UNSPECIFIED Nicht verwenden. Nicht angegeben
CENTER Standardwert. Richtet Widgets an der Mitte einer Spalte aus.
TOP Richtet Widgets am oberen Rand einer Spalte aus.
BOTTOM Richtet Widgets am unteren Rand einer Spalte aus.

Widgets

Die unterstützten Widgets, die Sie in eine Spalte einfügen können.

Google Workspace-Add-ons und Chat-Apps

JSON-Darstellung 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
textParagraph

object (TextParagraph)

Widget TextParagraph
image

object (Image)

Widget Image
decoratedText

object (DecoratedText)

Widget DecoratedText
buttonList

object (ButtonList)

Widget ButtonList
textInput

object (TextInput)

Widget TextInput
selectionInput

object (SelectionInput)

Widget SelectionInput
dateTimePicker

object (DateTimePicker)

Widget DateTimePicker
chipList

object (ChipList)

Widget ChipList
Ende der sich gegenseitig ausschließenden Felder.

ChipList

Eine Liste von horizontal angeordneten Chips, die entweder horizontal gescrollt oder in die nächste Zeile umgebrochen werden können.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}
Felder
layout

enum (Layout)

Listenlayout der angegebenen Chips.
chips[]

object (Chip)

Ein Array von Chips.

Layout

Das Chip-Listenlayout.

Enums
LAYOUT_UNSPECIFIED Nicht verwenden. Nicht angegeben
WRAPPED Standardwert. Wenn nicht genügend horizontaler Platz vorhanden ist, wird die Chipliste in die nächste Zeile umgebrochen.
HORIZONTAL_SCROLLABLE Die Chips werden horizontal gescrollt, wenn sie nicht in den verfügbaren Platz passen.

Chip

Ein Chip mit Text, Symbol oder Text und Symbol, auf den Nutzer klicken können.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}
Felder
icon

object (Icon)

Das Symbolbild. Wenn sowohl icon als auch label festgelegt sind, wird das Symbol vor dem Label angezeigt.
label

string

Der Text, der im Chip angezeigt wird.
onClick

object (OnClick)

Optional. Die Aktion, die ausgeführt werden soll, wenn ein Nutzer auf den Chip klickt, z. B. das Öffnen eines Hyperlinks oder das Ausführen einer benutzerdefinierten Funktion.
enabled
(deprecated)

boolean

Nicht mehr unterstützt: Verwenden Sie stattdessen disabled.

Gibt an, ob der Chip aktiv ist und auf Nutzeraktionen reagiert.
disabled

boolean

Gibt an, ob der Chip inaktiv ist und Nutzeraktionen ignoriert. Die Standardeinstellung ist false.
altText

string

Der alternative Text, der für die Barrierefreiheit verwendet wird.

Legen Sie einen beschreibenden Text fest, der Nutzern mitteilt, was der Chip bewirkt. Wenn ein Chip beispielsweise einen Hyperlink öffnet, schreiben Sie: „Öffnet einen neuen Browsertab und ruft die Entwicklerdokumentation für Google Chat unter https://developers.google.com/workspace/chat" auf.“

CarouselCard

Eine Karte, die als Karussellelement angezeigt werden kann. Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

JSON-Darstellung 
{
  "widgets": [
    {
      object (NestedWidget)
    }
  ],
  "footerWidgets": [
    {
      object (NestedWidget)
    }
  ]
}
Felder
widgets[]

object (NestedWidget)

Eine Liste der Widgets, die auf der Karussellkarte angezeigt werden. Die Widgets werden in der Reihenfolge angezeigt, in der sie angegeben sind.
footerWidgets[]

object (NestedWidget)

Eine Liste von Widgets, die unten auf der Karussellkarte angezeigt werden. Die Widgets werden in der Reihenfolge angezeigt, in der sie angegeben sind.

NestedWidget

Eine Liste von Widgets, die in einem übergeordneten Layout wie einem CarouselCard angezeigt werden können. Verfügbar für Google Chat-Apps und nicht verfügbar für Google Workspace-Add-ons.

JSON-Darstellung 
{

  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
}
Felder
Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
textParagraph

object (TextParagraph)

Ein Widget für Textabsätze.
buttonList

object (ButtonList)

Ein Widget mit einer Liste von Schaltflächen.
image

object (Image)

Ein Bild-Widget.
Ende der sich gegenseitig ausschließenden Felder.

Sichtbarkeit

Gibt an, ob ein UI-Element sichtbar oder ausgeblendet ist.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

Enums
VISIBILITY_UNSPECIFIED Nicht angegebene Sichtbarkeit. Nicht verwenden.
VISIBLE Das UI-Element ist sichtbar.
HIDDEN Das UI-Element ist ausgeblendet.

EventAction

Stellt eine Aktion dar, die für ein UI-Element ausgeführt werden kann.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "actionRuleId": string,
  "postEventTriggers": [
    {
      object (Trigger)
    }
  ],

  "commonWidgetAction": {
    object (CommonWidgetAction)
  }
}
Felder
actionRuleId

string

Die eindeutige Kennung der ActionRule.
postEventTriggers[]

object (Trigger)

Die Liste der Trigger, die nach der Ausführung der EventAction ausgelöst werden.
Die auszuführende Aktion. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
commonWidgetAction

object (CommonWidgetAction)

Häufige Widget-Aktion.
Ende der sich gegenseitig ausschließenden Felder.

Trigger

Stellt einen Trigger dar.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "actionRuleId": string
}
Felder
actionRuleId

string

Die eindeutige Kennung der ActionRule.

CommonWidgetAction

Stellt eine Aktion dar, die nicht spezifisch für ein Widget ist.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{

  "updateVisibilityAction": {
    object (UpdateVisibilityAction)
  }
}
Felder
Die auszuführende Aktion. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
updateVisibilityAction

object (UpdateVisibilityAction)

Die Aktion zum Aktualisieren der Sichtbarkeit eines Widgets.
Ende der sich gegenseitig ausschließenden Felder.

UpdateVisibilityAction

Stellt eine Aktion dar, mit der die Sichtbarkeit eines Widgets aktualisiert wird.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "visibility": enum (Visibility)
}
Felder
visibility

enum (Visibility)

Die neue Sichtbarkeit.

CollapseControl

Stellt ein Steuerelement zum Maximieren und Minimieren dar.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}
Felder
horizontalAlignment

enum (HorizontalAlignment)

Die horizontale Ausrichtung der Schaltfläche zum Maximieren und Minimieren.
expandButton

object (Button)

Optional. Definiere eine benutzerdefinierte Taste, um den Bereich zu maximieren. Sowohl das Feld „expandButton“ als auch das Feld „collapseButton“ müssen festgelegt sein. Wenn nur ein Feld festgelegt ist, wird es nicht wirksam. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.
collapseButton

object (Button)

Optional. Definiere eine benutzerdefinierte Taste, um den Bereich zu minimieren. Sowohl das Feld „expandButton“ als auch das Feld „collapseButton“ müssen festgelegt sein. Wenn nur ein Feld festgelegt ist, wird es nicht wirksam. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.

DividerStyle

Der Trennlinienstil einer Karte. Wird derzeit nur für Trennlinien zwischen Kartenabschnitten verwendet.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

Enums
DIVIDER_STYLE_UNSPECIFIED Nicht verwenden. Nicht angegeben
SOLID_DIVIDER Standardoption. Eine durchgezogene Trennlinie rendern.
NO_DIVIDER Wenn diese Option festgelegt ist, wird kein Trennzeichen gerendert. Mit diesem Stil wird die Trennlinie vollständig aus dem Layout entfernt. Das Ergebnis ist dasselbe, als wenn Sie gar keine Trennlinie hinzufügen.

CardAction

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Eine Rechnungskarte kann beispielsweise Aktionen wie „Rechnung löschen“, „Rechnung per E-Mail senden“ oder „Rechnung in einem Browser öffnen“ enthalten.

Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.

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

string

Das Label, das als Aktionsmenüpunkt angezeigt wird.
onClick

object (OnClick)

Die Aktion onClick für diese Aufgabe.

CardFixedFooter

Eine dauerhafte (fixierte) Fußzeile, die unten auf der Karte angezeigt wird.

Wenn Sie fixedFooter festlegen, ohne primaryButton oder secondaryButton anzugeben, wird ein Fehler ausgegeben.

In Chat-Apps können Sie feste Fußzeilen in Dialogfeldern, aber nicht in Kartennachrichten verwenden. Ein Beispiel für Google Chat-Apps finden Sie unter Angepinnten Fußzeilenbereich hinzufügen.

Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

JSON-Darstellung 
{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}
Felder
primaryButton

object (Button)

Der primäre Button der fixierten Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit Text und Farbe sein.
secondaryButton

object (Button)

Der sekundäre Button der fixierten Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit Text und Farbe sein. Wenn secondaryButton festgelegt ist, müssen Sie auch primaryButton festlegen.

DisplayStyle

In Google Workspace-Add-ons wird damit festgelegt, wie eine Karte angezeigt wird.

Verfügbar für Google Workspace-Add-ons und nicht verfügbar für Google Chat-Apps.

Enums
DISPLAY_STYLE_UNSPECIFIED Nicht verwenden. Nicht angegeben
PEEK Die Kopfzeile der Karte wird unten in der Seitenleiste angezeigt und verdeckt teilweise die aktuelle oberste Karte des Stapels. Wenn Sie auf die Kopfzeile klicken, wird die Karte in den Kartenstapel verschoben. Wenn die Karte keine Überschrift hat, wird stattdessen eine generierte Überschrift verwendet.
REPLACE Standardwert. Die Karte wird angezeigt, indem die Ansicht der obersten Karte im Kartenstapel ersetzt wird.

ExpressionData

Stellt die Daten dar, die zum Auswerten eines Ausdrucks verwendet werden.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "id": string,
  "expression": string,
  "conditions": [
    {
      object (Condition)
    }
  ],
  "eventActions": [
    {
      object (EventAction)
    }
  ]
}
Felder
id

string

Die eindeutige Kennung der ExpressionData.
expression

string

Der nicht kompilierte Ausdruck.
conditions[]

object (Condition)

Die Liste der Bedingungen, die durch das Ergebnis der Ausdrucksauswertung bestimmt werden.
eventActions[]

object (EventAction)

Die Liste der Aktionen, für die die ExpressionData verwendet werden können.

Bedingung

Stellt eine Bedingung dar, die zum Auslösen einer Aktion verwendet werden kann.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "actionRuleId": string,

  "expressionDataCondition": {
    object (ExpressionDataCondition)
  }
}
Felder
actionRuleId

string

Die eindeutige Kennung der ActionRule.
Die Bedingung. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
expressionDataCondition

object (ExpressionDataCondition)

Die Bedingung, die durch die Ausdrucksdaten bestimmt wird.
Ende der sich gegenseitig ausschließenden Felder.

ExpressionDataCondition

Stellt eine Bedingung dar, die mit CEL ausgewertet wird.

Verfügbar für Google Workspace-Add-ons, die Google Workspace Studio erweitern. Für Google Chat-Apps nicht verfügbar.

JSON-Darstellung 
{
  "conditionType": enum (ConditionType)
}
Felder
conditionType

enum (ConditionType)

Der Typ der Bedingung.

ConditionType

Der Typ der Bedingung.

Enums
CONDITION_TYPE_UNSPECIFIED Nicht angegebener Bedingungstyp.
EXPRESSION_EVALUATION_SUCCESS Die Ausdrucksauswertung war erfolgreich.
EXPRESSION_EVALUATION_FAILURE Die Auswertung des Ausdrucks war nicht erfolgreich.