Cards v2

Infokarte

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 erfassen und Nutzer zum nächsten Schritt führen.

Mit dem Card Builder können Sie Karten entwerfen und in der Vorschau ansehen.

Card Builder öffnen

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

• Informationen zu Google Chat-Apps finden Sie unter Komponenten einer Karte oder eines Dialogfelds entwerfen.
• Informationen zu Google Workspace-Add-ons finden Sie unter Kartenbasierte Benutzeroberflächen.

Hinweis: Sie können einer Karte bis zu 100 Widgets hinzufügen. Alle Widgets, die über dieses Limit hinausgehen, werden ignoriert. Dieses Limit gilt sowohl für Karten-Nachrichten und Dialogfelder in Google Chat-Apps als auch für Karten in Google Workspace-Add‑ons.

Beispiel: Kartenmitteilung für eine Google Chat-App

Verwenden Sie den folgenden JSON-Code, um die Beispielkarten-Nachricht 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": "[e-mail]"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "[phone]"
                 }
               },
               {
                 "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) } }

Felder
header	object (CardHeader) Die Kopfzeile der Karte. Ein Header enthält in der Regel ein Vorschaubild 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. 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. Aktionen werden dem Symbolleistenmenü der Karte hinzugefügt. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht. Mit dem folgenden JSON wird beispielsweise ein Menü mit Kartenaktionen 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. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
fixedFooter	object (CardFixedFooter) Die fixierte Fußzeile wird unten auf dieser Karte angezeigt. Wenn Sie fixedFooter festlegen, ohne primaryButton oder secondaryButton anzugeben, tritt ein Fehler auf. Für Chat-Apps können Sie feste Fußzeilen in Dialogfeldern, aber nicht in Karten-Nachrichten verwenden. Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
displayStyle	enum (DisplayStyle) Legt in Google Workspace-Add-ons die Anzeigeeigenschaften von peekCardHeader fest. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
peekCardHeader	object (CardHeader) Wenn Kontextinhalte angezeigt werden, dient die Kopfzeile der Peek-Karte als Platzhalter, damit der Nutzer zwischen den Karten auf der Startseite und den Kontextkarten vorwärts navigieren kann. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

CardHeader

Stellt eine Kartenüberschrift dar. Ein Beispiel für Google Chat-Apps finden Sie unter Kopfzeile 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 Kartenüberschrift. Der Header hat eine feste Höhe. Wenn sowohl ein Titel als auch ein Untertitel angegeben sind, belegt jeder eine Zeile. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.
subtitle	string Der Untertitel der Kartenüberschrift. Wenn angegeben, wird sie in einer eigenen Zeile unter dem title angezeigt.
imageType	enum (ImageType) Die Form, mit der das Bild zugeschnitten 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 Bilds, der für die Barrierefreiheit verwendet wird.

ImageType

Die Form, mit der das Bild zugeschnitten wird.

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

Enums
SQUARE	Standardwert. Wendet eine quadratische Maske auf das Bild an. Beispiel: Ein Bild im Format 4:3 wird zu einem Bild im Format 3:3.
CIRCLE	Wendet eine kreisförmige Maske auf das Bild an. Ein Bild im Format 4 × 3 wird beispielsweise zu einem Kreis mit einem Durchmesser von 3.

Abschnitt

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, "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.
collapsible	boolean Gibt an, ob dieser Abschnitt minimiert werden kann. In minimierbaren Abschnitten werden einige oder alle Widgets ausgeblendet. Nutzer können den Abschnitt maximieren, um die ausgeblendeten Widgets aufzurufen. Klicken Sie dazu auf Mehr anzeigen. Nutzer können die Widgets wieder ausblenden, indem sie auf Weniger anzeigen klicken. Geben Sie uncollapsibleWidgetsCount an, um zu ermitteln, welche Widgets ausgeblendet sind.
uncollapsibleWidgetsCount	integer Die Anzahl der nicht minimierbaren Widgets, die auch dann sichtbar bleiben, wenn ein Bereich minimiert wird. Wenn ein Bereich beispielsweise fünf Widgets enthält und uncollapsibleWidgetsCount auf 2 festgelegt ist, werden immer die ersten beiden Widgets angezeigt und die letzten drei sind standardmäßig minimiert. Die uncollapsibleWidgetsCount wird nur berücksichtigt, wenn collapsible true ist.
collapseControl	object (CollapseControl) Optional. Definieren Sie die Schaltfläche zum Maximieren und Minimieren des Bereichs. Diese Schaltfläche wird nur angezeigt, wenn der Abschnitt 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), // Union field data can be only one of the following: "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) } // End of list of possible types for union field data. }

Felder
horizontalAlignment	enum (HorizontalAlignment) Gibt an, ob Widgets links, rechts oder in der Mitte einer Spalte ausgerichtet werden.
Union-Feld data. Ein Widget kann nur eines der folgenden Elemente enthalten. Sie können mehrere Widget-Felder verwenden, um mehr Elemente anzuzeigen. data kann nur einer der folgenden Werte sein:
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 fett formatierter Text 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 formatiertes Textelement an. Mit dem folgenden JSON-Code wird beispielsweise ein Widget mit formatiertem Text erstellt, in dem die E-Mail-Adresse angezeigt wird: "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "[e-mail]", "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. Mit dem folgenden JSON-Code werden beispielsweise zwei Schaltflächen erstellt. Die erste ist eine blaue Textschaltfläche und die zweite eine Bildschaltfläche, die einen Link öffnet: "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" } Im folgenden JSON-Beispiel 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 Auswahlsteuerelement 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, in dem 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, mit dem Nutzer ein Datum, eine Uhrzeit oder ein Datum und eine Uhrzeit eingeben können. Mit dem folgenden JSON-Code wird beispielsweise eine Datumsauswahl erstellt, um einen Termin zu planen: "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 eine Trennlinie 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 Obergrenzen 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, nutzen 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) Ein Karussell enthält eine Sammlung von verschachtelten Widgets. Hier sehen Sie beispielsweise die JSON-Darstellung eines Karussells mit zwei Textabsätzen. { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "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, der einen Link öffnet: "chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }

TextParagraph

Ein Textabschnitt, der die Formatierung unterstützt. 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 gleich lang oder kürzer als die angegebene maximale 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 Textes. Wenn nicht festgelegt, wird der Text als HTML gerendert. Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.

TextSyntax

Syntax zum Formatieren von Text.

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

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 Bilds, der für die Barrierefreiheit verwendet wird.

OnClick

Gibt an, wie reagiert werden soll, wenn Nutzer auf ein interaktives Element auf einer Karte klicken, z. B. auf eine Schaltfläche.

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

JSON-Darstellung
{ // Union field data can be only one of the following: "action": { object (Action) }, "openLink": { object (OpenLink) }, "openDynamicLinkAction": { object (Action) }, "card": { object (Card) }, "overflowMenu": { object (OverflowMenu) } // End of list of possible types for union field data. }

Felder
Union-Feld data. data kann nur einer der folgenden Werte sein:
action	object (Action) Wenn angegeben, wird eine Aktion durch diese onClick ausgelöst.
openLink	object (OpenLink) Falls angegeben, wird durch onClick eine Aktion zum Öffnen eines Links ausgelöst.
openDynamicLinkAction	object (Action) Ein Add‑on löst diese Aktion aus, wenn ein Link geöffnet werden muss. Dies unterscheidet sich von openLink oben, da hier eine Verbindung zum Server erforderlich ist, um den Link zu erhalten. Daher sind einige Vorbereitungen für den Webclient erforderlich, bevor die Antwort auf die Aktion „Link öffnen“ zurückgegeben wird. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
card	object (Card) Nach dem Klicken wird eine neue Karte in den Kartenstapel eingefügt, sofern dies angegeben ist. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
overflowMenu	object (OverflowMenu) Wenn angegeben, wird dadurch ein Dreipunkt-Menü geöffnet.onClick

Aktion

Eine Aktion, die das Verhalten beim Einreichen des Formulars beschreibt. Sie können beispielsweise ein Apps Script-Skript aufrufen, um das Formular zu verarbeiten. Wenn die Aktion ausgelöst wird, werden die Formularwerte an den Server gesendet.

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

JSON-Darstellung
{ "function": string, "parameters": [ { object (ActionParameter) } ], "loadIndicator": enum (LoadIndicator), "persistValues": boolean, "interaction": enum (Interaction), "requiredWidgets": [ string ], "allWidgetsAreRequired": boolean }

Felder
function	string Eine benutzerdefinierte Funktion, die aufgerufen wird, wenn auf das enthaltende Element geklickt oder es anderweitig aktiviert wird. Ein Beispiel für die Verwendung finden Sie unter Formulardaten lesen.
parameters[]	object (ActionParameter) Liste der Aktionsparameter.
loadIndicator	enum (LoadIndicator) Gibt die Fortschrittsanzeige an, die bei der Ausführung des Aufrufs für die Aktion angezeigt wird.
persistValues	boolean Gibt an, ob Formularwerte nach der Aktion beibehalten werden. Der Standardwert ist false. Wenn true, bleiben die Formularwerte nach dem Auslösen der Aktion erhalten. Wenn der Nutzer Änderungen vornehmen soll, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf NONE. Für Kartenmitteilungen in Chat-Apps müssen Sie auch die ResponseType der Aktion auf UPDATE_MESSAGE festlegen und dieselbe cardId aus der Karte verwenden, die die Aktion enthielt. Wenn false, werden die Formularwerte gelöscht, wenn die Aktion ausgelöst wird. Damit der Nutzer keine Änderungen vornehmen kann, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf SPINNER.
interaction	enum (Interaction) Optional. Erforderlich beim Öffnen eines Dialogfelds. Was soll als Reaktion auf eine Interaktion mit einem Nutzer geschehen, z. B. wenn ein Nutzer in einer Kartenmitteilung auf eine Schaltfläche klickt? Wenn nichts angegeben ist, reagiert die App, indem sie eine action wie gewohnt ausführt, z. B. einen Link öffnet oder eine Funktion ausführt. Durch Angabe eines interaction kann die App auf besondere interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG setzen, kann die App ein Dialogfeld öffnen. Wenn angegeben, wird keine Ladeanzeige eingeblendet. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und nichts im Client angezeigt. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.
requiredWidgets[]	string Optional. Füllen Sie diese Liste mit den Namen der Widgets aus, die für eine gültige Einreichung dieser Aktion erforderlich sind. Wenn die hier aufgeführten Widgets keinen Wert haben, wenn diese Aktion aufgerufen wird, wird das Senden des Formulars abgebrochen. Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.
allWidgetsAreRequired	boolean Optional. Wenn dies zutrifft, gelten alle Widgets als für diese Aktion erforderlich. Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

ActionParameter

Liste der Stringparameter, die beim Aufrufen der Aktionsmethode angegeben werden müssen. Stellen Sie sich beispielsweise drei Schlummer-Schaltflächen vor: „Jetzt schlummern“, „Einen Tag schlummern“ oder „Nächste Woche schlummern“. Sie können action method = snooze() verwenden und den Schlummer-Typ und die Schlummerzeit in der Liste der Stringparameter übergeben.

Weitere Informationen finden Sie unter CommonEventObject.

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

JSON-Darstellung
{ "key": string, "value": string }

Felder
key	string Der Name des Parameters für das Aktionsscript.
value	string Wert des Parameters.

LoadIndicator

Gibt die Fortschrittsanzeige an, die bei der Ausführung des Aufrufs für die Aktion angezeigt wird.

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

Enums
SPINNER	Zeigt einen Spinner an, um anzugeben, dass Inhalte geladen werden.
NONE	Es wird nichts angezeigt.

Interaktion

Optional. Erforderlich beim Öffnen eines Dialogfelds.

Was soll als Reaktion auf eine Interaktion mit einem Nutzer geschehen, z. B. wenn ein Nutzer in einer Kartenmitteilung auf eine Schaltfläche klickt?

Wenn nichts angegeben ist, reagiert die App, indem sie wie gewohnt eine action ausführt, z. B. einen Link öffnet oder eine Funktion ausführt.

Durch Angabe eines interaction kann die App auf besondere interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG setzen, kann die App ein Dialogfeld öffnen.

Wenn angegeben, wird keine Ladeanzeige eingeblendet. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und nichts im Client angezeigt.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

Enums
INTERACTION_UNSPECIFIED	Standardwert. Die action wird wie gewohnt ausgeführt.
OPEN_DIALOG	Öffnet ein Dialogfeld, eine fensterbasierte, kartenbasierte Benutzeroberfläche, die Chat-Apps für die Interaktion mit Nutzern verwenden. Wird nur von Chat-Apps als Reaktion auf Schaltflächenklicks in Kartennachrichten unterstützt. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und nichts im Client angezeigt. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.

OpenLink

Stellt ein onClick-Ereignis dar, das einen Hyperlink öffnet.

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

JSON-Darstellung
{ "url": string, "openAs": enum (OpenAs), "onClose": enum (OnClose) }

Felder
url	string Die zu öffnende URL.
openAs	enum (OpenAs) So öffnen Sie einen Link. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
onClose	enum (OnClose) Ob der Client einen Link nach dem Öffnen vergisst oder ihn bis zum Schließen des Fensters beobachtet. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

OpenAs

Wenn durch eine OnClick-Aktion ein Link geöffnet wird, kann der Client ihn entweder als Vollbildfenster (wenn das der vom Client verwendete Frame ist) oder als Overlay (z. B. als Pop-up) öffnen. Die Implementierung hängt von den Funktionen der Clientplattform ab. Der ausgewählte Wert wird möglicherweise ignoriert, wenn der Client ihn nicht unterstützt. FULL_SIZE wird von allen Clients unterstützt.

Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

Enums
FULL_SIZE	Der Link wird in einem Vollbildfenster geöffnet, sofern der Client diesen Frame verwendet.
OVERLAY	Der Link wird als Overlay, z. B. als Pop-up, geöffnet.

OnClose

Was der Client tut, wenn ein Link, der durch eine OnClick-Aktion geöffnet wurde, geschlossen wird.

Die Implementierung hängt von den Funktionen der Clientplattform ab. Ein Webbrowser kann beispielsweise einen Link in einem Pop-up-Fenster mit einem OnClose-Handler öffnen.

Wenn sowohl OnOpen- als auch OnClose-Handler festgelegt sind und die Clientplattform beide Werte nicht unterstützen kann, hat OnClose Vorrang.

Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

Enums
NOTHING	Standardwert. Die Karte wird nicht neu geladen. Es passiert nichts.
RELOAD	Lädt die Karte neu, nachdem das untergeordnete Fenster geschlossen wurde. In Verbindung mit OpenAs.OVERLAY fungiert das untergeordnete Fenster als modales Dialogfeld und die übergeordnete Karte wird blockiert, bis das untergeordnete Fenster geschlossen wird.

OverflowMenu

Ein Widget, das ein Pop-up-Menü mit einer oder mehreren Aktionen präsentiert, die Nutzer aufrufen können. Beispiel: Nicht primäre Aktionen werden auf einer Karte angezeigt. Sie können dieses Widget verwenden, wenn Aktionen nicht in den verfügbaren Bereich passen. Geben Sie dieses Widget in der OnClick-Aktion von Widgets an, die es unterstützen, um es zu verwenden. Zum Beispiel in einem Button.

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

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

Felder
items[]	object (OverflowMenuItem) Erforderlich. Die Liste der Menüoptionen.

OverflowMenuItem

Eine Option, die Nutzer in einem Dreipunkt-Menü aufrufen können.

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

JSON-Darstellung
{ "startIcon": { object (Icon) }, "text": string, "onClick": { object (OnClick) }, "disabled": boolean }

Felder
startIcon	object (Icon) Das Symbol, das vor dem Text angezeigt wird.
text	string Erforderlich. Der Text, mit dem der Artikel für Nutzer identifiziert oder beschrieben wird.
onClick	object (OnClick) Erforderlich. Die Aktion, die aufgerufen wird, wenn eine Menüoption ausgewählt wird. OnClick darf kein OverflowMenu enthalten. Alle angegebenen OverflowMenu werden ignoriert und das Menüelement wird deaktiviert.
disabled	boolean Gibt an, ob die Menüoption deaktiviert ist. Die Standardeinstellung ist "false".

Symbol

Ein Symbol, das in einem Widget auf einer Karte angezeigt wird. Ein Beispiel für Google Chat-Apps finden Sie unter Symbol hinzufügen.

Unterstützt integrierte und benutzerdefinierte Symbole.

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

JSON-Darstellung
{ "altText": string, "imageType": enum (ImageType), // Union field icons can be only one of the following: "knownIcon": string, "iconUrl": string, "materialIcon": { object (MaterialIcon) } // End of list of possible types for union field icons. }

Felder
altText	string Optional. Eine Beschreibung des Symbols, das für die Bedienungshilfe verwendet wird. Wenn kein Wert angegeben ist, wird der Standardwert Button verwendet. Als Best Practice sollten Sie eine hilfreiche Beschreibung dafür festlegen, was das Symbol darstellt und gegebenenfalls, was es bewirkt. Beispiel: A user's account portrait oder Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat. Wenn das Symbol in einem Button festgelegt ist, wird altText als Hilfetext angezeigt, wenn der Nutzer den Mauszeiger auf die Schaltfläche bewegt. Wenn mit der Schaltfläche jedoch auch text festgelegt wird, wird die altText des Symbols ignoriert.
imageType	enum (ImageType) Der auf das Bild angewendete Zuschneidestil. In einigen Fällen führt das Anwenden eines CIRCLE-Zuschnitts dazu, dass das Bild größer als ein integriertes Symbol dargestellt wird.
Union-Feld icons. Das Symbol, das im Widget auf der Karte angezeigt wird. icons kann nur einer der folgenden Werte sein:
knownIcon	string Eines der integrierten Symbole von Google Workspace anzeigen Wenn Sie beispielsweise ein Flugzeugsymbol anzeigen möchten, geben Sie AIRPLANE an. Geben Sie für einen Bus BUS an. Eine vollständige Liste der unterstützten Symbole finden Sie unter Integrierte Symbole.
iconUrl	string Ein benutzerdefiniertes Symbol anzeigen, das unter einer HTTPS-URL gehostet wird. Beispiel: "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" Unterstützte Dateitypen sind .png und .jpg.
materialIcon	object (MaterialIcon) Eines der Google Material-Symbole anzeigen. Wenn Sie beispielsweise ein Kästchensymbol anzeigen möchten, verwenden Sie "materialIcon": { "name": "check_box" } Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.

MaterialIcon

Ein Google Material-Symbol mit über 2.500 Optionen.

Wenn Sie beispielsweise ein Kontrollkästchensymbol mit benutzerdefinierter Gewichtung und Note anzeigen möchten, schreiben Sie Folgendes:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

JSON-Darstellung
{ "name": string, "fill": boolean, "weight": integer, "grade": integer }

Felder
name	string Der im Google Material Icon definierte Symbolname, z. B. check_box. Alle ungültigen Namen werden verworfen und durch einen leeren String ersetzt, was dazu führt, dass das Symbol nicht gerendert wird.
fill	boolean Gibt an, ob das Symbol gefüllt gerendert wird. Der Standardwert ist "false". Wenn Sie sich verschiedene Symboleinstellungen ansehen möchten, rufen Sie Google Font Icons auf und passen Sie die Einstellungen unter Anpassen an.
weight	integer Die Strichstärke des Symbols. Wählen Sie eine der folgenden Optionen aus: {100, 200, 300, 400, 500, 600, 700}. Wenn nicht vorhanden, ist der Standardwert 400. Wenn ein anderer Wert angegeben wird, wird der Standardwert verwendet. Wenn Sie sich verschiedene Symboleinstellungen ansehen möchten, rufen Sie Google Font Icons auf und passen Sie die Einstellungen unter Anpassen an.
grade	integer Gewicht und Stärke wirken sich auf die Strichstärke eines Symbols aus. Anpassungen der Note sind detaillierter als Anpassungen des Gewichts und haben nur geringe Auswirkungen auf die Größe des Symbols. Wählen Sie einen Wert aus {-25, 0, 200} aus. Wenn nicht vorhanden, ist der Standardwert 0. Wenn ein anderer Wert angegeben wird, wird der Standardwert verwendet. Wenn Sie sich verschiedene Symboleinstellungen ansehen möchten, rufen Sie Google Font Icons auf und passen Sie die Einstellungen unter Anpassen an.

DecoratedText

Ein Widget, in dem 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 angezeigt wird. 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) }, // Union field control can be only one of the following: "button": { object (Button) }, "switchControl": { object (SwitchControl) }, "endIcon": { object (Icon) } // End of list of possible types for union field control. }

Felder
icon (deprecated)	object (Icon) Dieses Element ist veraltet. 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. Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.
topLabel	string Der Text, der über text angezeigt wird. Wird immer gekürzt.
topLabelText	object (TextParagraph) TextParagraph entspricht topLabel. Wird immer gekürzt. Ermöglicht eine komplexere Formatierung als topLabel. Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet. Für Google Chat-Apps verfügbar, nicht 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 entspricht text. Ermöglicht eine komplexere Formatierung als text. Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.
wrapText	boolean Die Einstellung für den Textumbruch. Wenn true, wird der Text umgebrochen und in mehreren Zeilen angezeigt. Andernfalls wird der Text gekürzt. 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 entspricht bottomLabel. Wird immer umgebrochen. Ermöglicht eine komplexere Formatierung als bottomLabel. Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.
onClick	object (OnClick) Diese Aktion wird ausgelöst, wenn Nutzer auf topLabel oder bottomLabel klicken.
Union-Feld control. Eine Schaltfläche, ein Schalter, ein Kästchen oder ein Bild, das rechts neben dem Text im decoratedText-Widget angezeigt wird. control kann nur einer der folgenden Werte sein:
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 seinen 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.

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 an der mittleren Position.
BOTTOM	Ausrichtung an der unteren Position.

Schaltfläche

Eine Schaltfläche mit Text, Symbol oder Text und Symbol, auf die Nutzer klicken können. Ein Beispiel für Google Chat-Apps finden Sie unter Schaltfläche hinzufügen.

Wenn Sie ein Bild in eine anklickbare Schaltfläche umwandeln möchten, geben Sie ein Image an (nicht ImageComponent) und legen Sie eine onClick-Aktion fest.

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

JSON-Darstellung
{ "text": string, "icon": { object (Icon) }, "color": { object (Color) }, "onClick": { object (OnClick) }, "disabled": boolean, "altText": string, "type": enum (Type) }

Felder
text	string Der Text, der in der Schaltfläche angezeigt wird.
icon	object (Icon) Ein Symbol, das in der Schaltfläche angezeigt wird. Wenn sowohl icon als auch text festgelegt sind, wird das Symbol vor dem Text angezeigt.
color	object (Color) Optional. Die Farbe der Schaltfläche. Wenn diese Option festgelegt ist, wird die Schaltfläche type auf FILLED gesetzt und die Farbe der Felder text und icon wird auf eine Kontrastfarbe gesetzt, um die Lesbarkeit zu verbessern. Wenn die Schaltflächenfarbe beispielsweise auf Blau festgelegt ist, werden alle Texte oder Symbole auf der Schaltfläche auf Weiß festgelegt. Wenn Sie die Schaltflächenfarbe 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 basierend auf dem RGB-Farbwert sein, wobei 0 (0/255) das Fehlen von Farbe und 1 (255/255) die maximale Intensität der Farbe darstellt. Im Folgenden wird beispielsweise die Farbe auf Rot mit maximaler Intensität festgelegt: "color": { "red": 1, "green": 0, "blue": 0, } Das Feld alpha ist für die Schaltflächenfarbe nicht verfügbar. Wenn angegeben, wird dieses Feld ignoriert.
onClick	object (OnClick) Erforderlich. Die Aktion, die ausgeführt werden soll, wenn ein Nutzer auf die Schaltfläche klickt, z. B. das Öffnen eines Hyperlinks oder das Ausführen einer benutzerdefinierten Funktion.
disabled	boolean Wenn true, wird die Schaltfläche in einem inaktiven Zustand angezeigt und reagiert nicht auf Nutzeraktionen.
altText	string Der alternative Text, der für die Barrierefreiheit verwendet wird. Legen Sie einen beschreibenden Text fest, der Nutzern erklärt, was die Schaltfläche bewirkt. Wenn mit einer Schaltfläche beispielsweise ein Hyperlink geöffnet wird, könnten Sie Folgendes schreiben: „Öffnet einen neuen Browsertab und ruft die Google Chat-Entwicklerdokumentation unter https://developers.google.com/workspace/chat" auf.“
type	enum (Type) Optional. Der Typ einer Schaltfläche. Wenn nicht festgelegt, ist der Standardwert für den Schaltflächentyp OUTLINED. Wenn das Feld color festgelegt ist, wird der Schaltflächentyp auf FILLED gesetzt und jeder für dieses Feld festgelegte Wert wird ignoriert.

Farbe

Ermöglicht die Darstellung einer Farbe im RGBA-Farbraum. Diese Darstellung ist auf eine einfache Konvertierung in und aus Farbdarstellungen in verschiedenen Sprachen ausgelegt und nicht auf Kompaktheit. Die Felder dieser Darstellung können beispielsweise trivial an den Konstruktor von java.awt.Color in Java übergeben werden. Sie können auch trivial an die Methode +colorWithRed:green:blue:alpha von UIColor in iOS übergeben werden. Mit nur wenig Aufwand können sie in JavaScript in einen CSS-rgba()-String formatiert werden.

Diese Referenzseite enthält keine Informationen zum absoluten Farbraum, der zur Interpretation des RGB-Werts verwendet werden sollte, z. B. sRGB, Adobe RGB, DCI-P3 und BT.2020. Anwendungen sollten standardmäßig den Farbraum sRGB verwenden.

Wenn entschieden werden muss, ob zwei Farben gleich sind, behandeln Implementierungen zwei Farben als gleich, sofern nicht anders dokumentiert, wenn sich alle ihre Rot-, Grün-, Blau- und Alphawerte um höchstens 1e-5 unterscheiden.

Beispiel (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Beispiel (iOS/Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Beispiel (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...

JSON-Darstellung
{ "red": number, "green": number, "blue": number, "alpha": number }

Felder
red	number Der Rotanteil der Farbe als Wert im Intervall [0, 1].
green	number Der Grünanteil der Farbe als Wert im Intervall [0, 1].
blue	number Der Blauanteil der Farbe als Wert im Intervall [0, 1].
alpha	number Der Anteil dieser Farbe, der auf den Pixel angewendet werden soll. Die endgültige Pixelfarbe wird durch folgende Gleichung definiert: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) Der Wert 1,0 entspricht einer soliden Farbdarstellung, während die Farbe bei einem Wert von 0,0 vollständig transparent ist. Dabei wird anstelle eines einfachen Float-Skalarwerts eine Wrapper-Nachricht verwendet, sodass zwischen einem Standardwert und dem zurückgesetzten Wert unterschieden werden kann. Wenn nicht angegeben, wird das Farbobjekt als solide Farbe dargestellt (als ob für den Alphawert explizit 1,0 angegeben worden wäre).

Typ

Optional. Der Typ einer Schaltfläche. Wenn das Feld color festgelegt ist, wird type auf FILLED gesetzt.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

Enums
TYPE_UNSPECIFIED	Nicht verwenden. Nicht angegeben
OUTLINED	Schaltflächen mit Umriss haben eine mittlere Gewichtung. Sie enthalten in der Regel Aktionen, die wichtig sind, aber nicht die primäre Aktion in einer Chat-App oder einem Add-on darstellen.
FILLED	Eine gefüllte Schaltfläche hat einen Container mit einer durchgehenden Farbe. Sie hat die größte visuelle Wirkung und wird für die wichtige und primäre Aktion in einer Chat-App oder einem Add-on empfohlen.
FILLED_TONAL	Eine gefüllte tonale Schaltfläche ist eine Alternative zwischen gefüllten und umrissenen Schaltflächen. Sie sind nützlich in Kontexten, in denen eine Schaltfläche mit niedrigerer Priorität etwas mehr Gewichtung erfordert als eine Umriss-Schaltfläche.
BORDERLESS	Eine Schaltfläche hat im Standardstatus keinen unsichtbaren Container. Sie wird häufig für Aktionen mit der niedrigsten Priorität verwendet, insbesondere wenn mehrere Optionen präsentiert werden.

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. Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
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.
selected	boolean Wenn true, ist der Schalter ausgewählt.
onChangeAction	object (Action) Die Aktion, die ausgeführt werden soll, wenn sich der Schalterstatus ändert, z. B. welche Funktion ausgeführt werden soll.
controlType	enum (ControlType) So wird der Schalter in der Benutzeroberfläche angezeigt. Verfügbar für Google Chat-Apps und Google Workspace-Add-ons.

ControlType

So wird der Schalter in der Benutzeroberfläche angezeigt.

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

Enums
SWITCH	Ein Kippschalter.
CHECKBOX	Wurde zugunsten von CHECK_BOX verworfen.
CHECK_BOX	Ein Kästchen.

ButtonList

Eine Liste von Schaltflächen, die horizontal angeordnet sind. Ein Beispiel für Google Chat-Apps finden Sie unter Schaltfläche hinzufügen.

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

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

Felder
buttons[]	object (Button) Ein Array von Schaltflächen.

TextInput

Ein Feld, in das Nutzer Text eingeben können. Unterstützt Vorschläge und Aktionen bei Änderungen. Unterstützt die Validierung von Formulareinsendungen. Wenn Action.all_widgets_are_required auf true festgelegt ist oder dieses Widget in Action.required_widgets angegeben ist, wird die Übermittlungsaktion blockiert, sofern kein 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 verarbeiten den Wert des eingegebenen Texts während Formulareingabeereignissen. 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 erheben möchten, verwenden Sie das SelectionInput-Widget.

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 }

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 für Ihre App erforderlichen Informationen einzugeben. Wenn Sie beispielsweise nach dem Namen einer Person fragen, aber speziell den Nachnamen benötigen, schreiben Sie surname anstatt name. Erforderlich, wenn hintText nicht angegeben ist. Andernfalls optional.
hintText	string Text, der unter dem Texteingabefeld angezeigt wird, um Nutzer zu unterstützen, indem sie aufgefordert werden, einen bestimmten Wert einzugeben. Dieser Text ist immer sichtbar. Erforderlich, wenn label nicht angegeben ist. Andernfalls 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) So wird ein Texteingabefeld auf der Benutzeroberfläche angezeigt. Beispielsweise, ob das Feld einzeilig oder mehrzeilig ist.
onChangeAction	object (Action) Was passiert, wenn eine Änderung im Texteingabefeld erfolgt. Zum Beispiel, wenn ein Nutzer Text in das Feld eingibt oder Text 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 tippen, werden die Vorschläge dynamisch gefiltert, um dem eingegebenen Text zu entsprechen. Wenn ein Nutzer beispielsweise in ein Texteingabefeld für Programmiersprachen tippt, werden möglicherweise Java, JavaScript, Python und C++ vorgeschlagen. Wenn der Nutzer mit der Eingabe von Jav beginnt, wird die Liste der Vorschläge gefiltert und es werden nur noch Java und JavaScript angezeigt. Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die Ihre App verarbeiten kann. Wenn es um JavaScript geht, geben einige Nutzer möglicherweise javascript ein, andere java script. Durch Vorschläge JavaScript kann die Interaktion von Nutzern mit Ihrer App standardisiert werden. 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. Falls angegeben, führt die App die hier angegebene Aktion aus, z. B. eine benutzerdefinierte Funktion. Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.
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. Mit diesem Text werden Nutzer aufgefordert, einen Wert einzugeben. Beispiel: Enter a number from 0 to 100. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons.

Typ

So wird ein Texteingabefeld auf der Benutzeroberfläche angezeigt. Das kann beispielsweise ein einzeiliges oder ein mehrzeiliges Eingabefeld sein. Wenn initialSuggestions angegeben ist, ist type immer SINGLE_LINE, auch wenn sie 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 Rendering-Anweisungen, die einer Karte mitteilen, dass sie eine Aktion ausführen soll, oder die der Add‑on-Hostanwendung oder der Chat-App mitteilen, dass sie eine app-spezifische Aktion ausführen soll.

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

Felder
action	Action

Aktion

Felder
navigations[]	Navigation Stellt eine Karte bereit, blendet sie ein oder aktualisiert sie. Add‑ons in Google Chat

Navigation

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

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

navigations: {
  pushCard: CARD
}

Ersetzen Sie die oberste Karte durch eine neue. Für Chat-Apps nur für das App-Startseite verfügbar.

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

navigations: {
  updateCard: CARD
}

Felder
Union-Feld navigate_action. Für navigate_action ist nur einer der folgenden Werte zulässig:
pushCard	Card Legt eine Karte auf den Kartenstapel. Für Dialogfelder in Google Chat: Öffnet oder aktualisiert ein Dialogfeld.
updateCard	Card Die obere Karte wird durch eine neue Karte ersetzt und die Werte der ausgefüllten Formularfelder bleiben erhalten. Bei einem nicht äquivalenten Feld wird der Wert verworfen. Für Dialogfelder in Google Chat: Öffnet oder aktualisiert ein Dialogfeld.

Vorschläge

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzer in das Texteingabefeld klicken. Während Nutzer tippen, werden die Vorschläge dynamisch gefiltert, um dem eingegebenen Text zu entsprechen.

Wenn ein Nutzer beispielsweise in ein Texteingabefeld für Programmiersprachen tippt, werden möglicherweise Java, JavaScript, Python und C++ vorgeschlagen. 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 es um JavaScript geht, geben einige Nutzer möglicherweise javascript und andere java script ein. Durch Vorschläge JavaScript kann die Interaktion von Nutzern mit Ihrer App standardisiert werden.

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, die für Empfehlungen zur automatischen Vervollständigung in Texteingabefeldern verwendet werden.

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
{ // Union field content can be only one of the following: "text": string // End of list of possible types for union field content. }

Felder
Union-Feld content. content kann nur einer der folgenden Werte sein:
text	string Der Wert einer vorgeschlagenen Eingabe für ein Texteingabefeld. Das entspricht dem, was Nutzer selbst eingeben.

Validierung

Enthält die erforderlichen Daten zum Validieren des zugehörigen Widgets.

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. Diese Option wird nur für die Texteingabe verwendet und bei anderen Widgets ignoriert. 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 Ganzzahlwert.
FLOAT	Ein Gleitkommawert.
EMAIL	Eine E-Mail-Adresse.
EMOJI_PICKER	Ein Emoji, das aus der vom System bereitgestellten Emoji-Auswahl ausgewählt wurde.

SelectionInput

Ein Widget, mit dem ein oder mehrere UI-Elemente erstellt werden, die Nutzer auswählen können. Unterstützt die Validierung von Formulareinsendungen 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 Übermittlungsaktion blockiert, sofern kein Wert ausgewählt ist. Beispiele sind Drop-down-Menüs oder Kästchen. Mit diesem Widget können Sie Daten erfassen, die sich vorhersagen oder aufzählen lassen. 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 erheben möchten, verwenden Sie das TextInput-Widget.

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) }, "multiSelectMaxSelectedItems": integer, "multiSelectMinQueryLength": integer, // Union field multi_select_data_source can be only one of the following: "externalDataSource": { object (Action) }, "platformDataSource": { object (PlatformDataSource) } // End of list of possible types for union field multi_select_data_source. }

Felder
name	string Erforderlich. Der Name, der die Auswahl 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 Auswahlfeld angezeigt wird. Geben Sie Text an, der dem Nutzer hilft, die für Ihre App erforderlichen Informationen einzugeben. Wenn Nutzer beispielsweise die Dringlichkeit eines Arbeits-Tickets in einem Drop-down-Menü auswählen, könnte das Label „Dringlichkeit“ oder „Dringlichkeit auswählen“ lauten.
type	enum (SelectionType) Die Art 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 auswählen, aber nur einen Wert aus einem Drop-down-Menü.
items[]	object (SelectionItem) Ein Array mit auswählbaren Elementen. Beispiel: ein Array von Optionsfeldern oder Kästchen. Es werden bis zu 100 Elemente unterstützt.
onChangeAction	object (Action) Wenn angegeben, wird das Formular gesendet, wenn sich die Auswahl ändert. Wenn nicht angegeben, müssen Sie eine separate Schaltfläche angeben, über die das Formular gesendet wird. Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
multiSelectMaxSelectedItems	integer Für Menüs mit Mehrfachauswahl die maximale Anzahl von Elementen, die ein Nutzer auswählen kann. Der Mindestwert beträgt 1 Artikel. Wenn nicht angegeben, werden standardmäßig 3 Elemente verwendet.
multiSelectMinQueryLength	integer Bei Menüs mit Mehrfachauswahl die Anzahl der Textzeichen, die ein Nutzer eingibt, bevor im Menü Auswahlvorschläge angezeigt werden. Wenn das Menü nicht konfiguriert ist, werden die folgenden Standardwerte verwendet: Wenn im Menü ein statisches Array von SelectionInput-Elementen verwendet wird, wird standardmäßig 0 Zeichen festgelegt und die Elemente werden sofort aus dem Array übernommen. Wenn im Menü eine dynamische Datenquelle ( multi_select_data_source) verwendet wird, werden standardmäßig 3 Zeichen eingegeben, bevor die Datenquelle abgefragt wird, um Vorschläge zurückzugeben.
Union-Feld multi_select_data_source. Für ein Menü mit Mehrfachauswahl eine Datenquelle, die Auswahlmöglichkeiten dynamisch bereitstellt. Für Google Chat-Apps verfügbar, nicht für Google Workspace-Add‑ons. multi_select_data_source kann nur einer der folgenden Werte sein:
externalDataSource	object (Action) Eine externe Datenquelle, z. B. eine relationale Datenbank.
platformDataSource	object (PlatformDataSource) Eine Datenquelle aus Google Workspace.

SelectionType

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

Jede Auswahl unterstützt eine Art von Auswahl. Das Mischen von Checkboxen 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 anklicken.
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 einen Artikel aus dem Menü auswählen.
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. Bei Google Chat-Apps können Sie Elemente auch über eine dynamische Datenquelle einfügen und Elemente automatisch vorschlagen, während Nutzer in das Menü eingeben. Nutzer können beispielsweise mit der Eingabe des Namens eines Google Chat-Bereichs beginnen und das Widget schlägt den Bereich automatisch vor. Wenn Sie Elemente für ein Mehrfachauswahlmenü dynamisch einfügen 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 abgerufen. 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.

SelectionItem

Ein Element, das Nutzer in einer Auswahl eingeben können, z. B. ein Kontrollkästchen oder ein Schalter. Es werden bis zu 100 Elemente unterstützt.

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

JSON-Darstellung
{ "text": string, "value": string, "selected": boolean, "bottomText": string, // Union field start_icon can be only one of the following: "startIconUri": string // End of list of possible types for union field start_icon. }

Felder
text	string Der Text, mit dem der Artikel für Nutzer identifiziert oder beschrieben wird.
value	string Der Wert, der diesem Artikel zugeordnet ist. Der Client sollte diesen Wert als Formulareingabewert verwenden. Weitere Informationen zum Arbeiten mit Formulareingaben finden Sie unter Formulardaten empfangen.
selected	boolean Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn für die Auswahl nur ein Wert zulässig ist (z. B. bei Optionsfeldern oder einem Drop-down-Menü), legen Sie dieses Feld nur für ein Element fest.
bottomText	string Bei Menüs mit Mehrfachauswahl wird eine Textbeschreibung oder ein Label unter dem text-Feld des Elements angezeigt.
Union-Feld start_icon. Bei Menüs mit Mehrfachauswahl die URL für das Symbol, das neben dem Feld text des Elements angezeigt wird. PNG- und JPEG-Dateien werden unterstützt. Muss eine HTTPS-URL sein. Beispiel: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png. start_icon kann nur einer der folgenden Werte sein:
startIconUri	string

PlatformDataSource

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

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

JSON-Darstellung
{ // Union field data_source can be only one of the following: "commonDataSource": enum (CommonDataSource), "hostAppDataSource": { object (HostAppDataSourceMarkup) } // End of list of possible types for union field data_source. }

Felder
Union-Feld data_source. Die Datenquelle. data_source kann nur einer der folgenden Werte sein:
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 für eine Google Workspace-Hostanwendung verfügbar ist, z. B. Gruppenbereiche in Google Chat. Dieses Feld wird von den Google API-Clientbibliotheken unterstützt, ist aber in den Cloud-Clientbibliotheken nicht verfügbar. Weitere Informationen finden Sie unter Clientbibliotheken installieren.

CommonDataSource

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

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

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

HostAppDataSourceMarkup

Für ein SelectionInput-Widget, das ein Mehrfachauswahlmenü verwendet, eine Datenquelle aus einer Google Workspace-Anwendung. Die Datenquelle füllt die Auswahlmöglichkeiten für das Menü mit Mehrfachauswahl aus.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

JSON-Darstellung
{ // Union field data_source can be only one of the following: "chatDataSource": { object (ChatClientDataSourceMarkup) } // End of list of possible types for union field data_source. }

Felder
Union-Feld data_source. Die Google Workspace-Anwendung, die Elemente für ein Menü mit Mehrfachauswahl enthält. data_source kann nur einer der folgenden Werte sein:
chatDataSource	object (ChatClientDataSourceMarkup) Eine Datenquelle aus Google Chat.

ChatClientDataSourceMarkup

Für ein SelectionInput-Widget, das ein Menü mit Mehrfachauswahl verwendet, eine Datenquelle aus Google Chat. Die Datenquelle füllt die Auswahlmöglichkeiten für das Menü mit Mehrfachauswahl aus. Ein Nutzer kann beispielsweise Google Chat-Gruppenbereiche auswählen, in denen er Mitglied ist.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

JSON-Darstellung
{ // Union field source can be only one of the following: "spaceDataSource": { object (SpaceDataSource) } // End of list of possible types for union field source. }

Felder
Union-Feld source. Die Google Chat-Datenquelle. source kann nur einer der folgenden Werte sein:
spaceDataSource	object (SpaceDataSource) Google Chat-Gruppenbereiche, in denen der Nutzer Mitglied ist.

SpaceDataSource

Eine Datenquelle, die Google Chat-Gruppenbereiche als Auswahlmöglichkeiten für ein Menü mit Mehrfachauswahl enthält. Es werden nur Spaces ausgefüllt, in denen der Nutzer Mitglied ist.

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

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.

DateTimePicker

Ermöglicht Nutzern, ein Datum, eine Uhrzeit oder beides einzugeben. Unterstützt die Validierung von Formulareinsendungen. Wenn Action.all_widgets_are_required auf true festgelegt ist oder dieses Widget in Action.required_widgets angegeben ist, wird die Übermittlungsaktion blockiert, sofern kein Wert ausgewählt ist. 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 das Auswahlelement verwenden, um Daten und Uhrzeiten auszuwählen. Wenn Nutzer ein ungültiges Datum oder eine ungültige Uhrzeit eingeben, wird im Picker eine Fehlermeldung angezeigt, in der sie aufgefordert werden, die Informationen richtig einzugeben.

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

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

Felder
name	string Der Name, mit dem die 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 planen, 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	int64 Der im Widget angezeigte Standardwert in Millisekunden seit der Unix-Epochenzeit. Geben Sie den Wert basierend auf dem Typ der Auswahl an ( DateTimePickerType): 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 UTC. Um beispielsweise den 1. Januar 2023 darzustellen, verwenden Sie 1672531200000. TIME_ONLY : eine Zeit in UTC. Um beispielsweise 12:00 PM darzustellen, verwenden Sie 43200000 (oder 12 * 60 * 60 * 1000).
timezoneOffsetDate	integer Die Zahl, die den Zeitzonenversatz zu UTC in Minuten darstellt. Wenn festgelegt, wird valueMsEpoch in der angegebenen Zeitzone angezeigt. Wenn der Wert nicht festgelegt ist, wird standardmäßig die Zeitzoneneinstellung des Nutzers verwendet.
onChangeAction	object (Action) Wird ausgelöst, wenn der Nutzer in der DateTimePicker-Oberfläche auf Speichern oder Löschen klickt.

DateTimePickerType

Das Format für Datum und Uhrzeit im DateTimePicker-Widget. 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 einfügen.

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

Mit dem folgenden JSON-Code wird beispielsweise eine Trennlinie erstellt:

"divider": {}

Raster

Zeigt ein Raster mit einer Sammlung von Elementen an. Elemente können nur Text oder Bilder enthalten. Verwenden Sie für responsive Spalten oder um mehr als Text oder Bilder einzufügen, Columns. 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 Rasterüberschrift angezeigt wird.
items[]	object (GridItem) Die im Raster anzuzeigenden Elemente.
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 wird, wird ein Standardwert verwendet. Dieser Standardwert hängt davon ab, wo das Raster angezeigt wird (Dialogfeld oder Companion).
onClick	object (OnClick) Dieser Callback wird für jedes einzelne Rasterelement wiederverwendet. Den Parametern des Callbacks werden jedoch die Kennung und der Index des Elements in der Liste „items“ hinzugefügt.

GridItem

Stellt ein Element in einem Rasterlayout dar. Elemente können Text, ein Bild oder sowohl Text als auch ein Bild 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 Gridelement 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 auf das Bild anzuwendende Zuschneidestil.
borderStyle	object (BorderStyle) Der auf das Bild anzuwendende Rahmenstil.

ImageCropStyle

Stellt den auf ein Bild angewendeten Zuschneidestil dar.

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 Zuschneidetyp.
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 auf ein Bild angewendeten Zuschneidestil dar.

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 Rahmentyp.
strokeColor	object (Color) Die Farben, die verwendet werden sollen, wenn der Typ BORDER_TYPE_STROKE ist. Um die Strichfarbe festzulegen, geben Sie einen Wert für die Felder red, green und blue an. Der Wert muss eine Gleitkommazahl zwischen 0 und 1 basierend auf dem RGB-Farbwert sein, wobei 0 (0/255) das Fehlen von Farbe und 1 (255/255) die maximale Intensität der Farbe darstellt. Im Folgenden wird beispielsweise die Farbe auf 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 auf Widgets angewendeten Rahmentypen dar.

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

Enums
BORDER_TYPE_UNSPECIFIED	Nicht verwenden. Nicht angegeben
NO_BORDER	Kein Rahmen.
STROKE	Standardwert. Umriss

GridItemLayout

Stellt die verschiedenen Layoutoptionen dar, die für ein Gridelement 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	Titel und Untertitel werden unter dem Bild des Rasterelements angezeigt.
TEXT_ABOVE	Titel und Untertitel werden über dem Bild des Rasterelements angezeigt.

Spalten

Im Columns-Widget werden bis zu zwei Spalten auf einer Karte oder in einem Dialogfeld angezeigt. Sie können jeder Spalte Widgets hinzufügen. Die Widgets werden in der angegebenen Reihenfolge angezeigt. 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 Spalte ist, haben beide Spalten die Höhe der ersten Spalte. Da jede Spalte eine unterschiedliche Anzahl von Widgets enthalten kann, können Sie keine Zeilen definieren oder Widgets zwischen den Spalten ausrichten.

Spalten werden nebeneinander angezeigt. Mit dem Feld HorizontalSizeStyle können Sie die Breite der einzelnen Spalten 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 kleiner oder gleich 480 Pixel ist.
• 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. Die Add-on-Benutzeroberflächen, die Spalten unterstützen, sind:

• Das Dialogfeld, das angezeigt wird, wenn Nutzer das Add-on über einen 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 in der Mitte 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 der einzelnen Spalten 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 aus, bis zu 70% der Kartenbreite. Wenn beide Spalten auf FILL_AVAILABLE_SPACE festgelegt sind, füllt jede Spalte 50% des verfügbaren Platzes aus.
FILL_MINIMUM_SPACE	Die Spalte nimmt so wenig Platz wie möglich ein, aber nicht mehr als 30% der Kartenbreite.

HorizontalAlignment

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

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

Enums
HORIZONTAL_ALIGNMENT_UNSPECIFIED	Nicht verwenden. Nicht angegeben
START	Standardwert. Richtet Widgets an der Startposition der Spalte aus. Bei rechtsläufigen Layouts wird links ausgerichtet. Bei Rechts-nach-links-Layouts wird rechts ausgerichtet.
CENTER	Richtet Widgets in der Mitte der Spalte aus.
END	Richtet Widgets an der Endposition der Spalte aus. Bei Layouts von links nach rechts werden Widgets rechts ausgerichtet. Bei Layouts mit Leserichtung von rechts nach links werden Widgets links 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 in 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

{ // Union field data can be only one of the following: "textParagraph": { object (TextParagraph) }, "image": { object (Image) }, "decoratedText": { object (DecoratedText) }, "buttonList": { object (ButtonList) }, "textInput": { object (TextInput) }, "selectionInput": { object (SelectionInput) }, "dateTimePicker": { object (DateTimePicker) }, "chipList": { object (ChipList) } // End of list of possible types for union field data. }

Felder
Union-Feld data. data kann nur einer der folgenden Werte sein:
textParagraph	object (TextParagraph) TextParagraph Widget
image	object (Image) Image Widget
decoratedText	object (DecoratedText) DecoratedText Widget
buttonList	object (ButtonList) ButtonList Widget
textInput	object (TextInput) TextInput Widget
selectionInput	object (SelectionInput) SelectionInput Widget
dateTimePicker	object (DateTimePicker) DateTimePicker Widget
chipList	object (ChipList) ChipList Widget

ChipList

Eine Liste mit 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) Angegebene Chip-Listenanordnung.
chips[]	object (Chip) Ein Array von Chips.

Layout

Das Layout der Chip-Liste.

Enums
LAYOUT_UNSPECIFIED	Nicht verwenden. Nicht angegeben
WRAPPED	Standardwert. Die Chip-Liste wird in die nächste Zeile umgebrochen, wenn nicht genügend horizontaler Platz vorhanden ist.
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 text festgelegt sind, wird das Symbol vor dem Text 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 Dieses Element ist veraltet. Gibt an, ob sich der Chip in einem aktiven Zustand befindet und auf Nutzeraktionen reagiert. Die Standardeinstellung ist true. Verworfen. Verwenden Sie stattdessen disabled.
disabled	boolean Gibt an, ob sich der Chip in einem inaktiven Zustand befindet 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 erklärt, was der Chip macht. Wenn ein Chip beispielsweise einen Hyperlink öffnet, schreiben Sie: „Öffnet einen neuen Browsertab und ruft die Google Chat-Entwicklerdokumentation unter https://developers.google.com/workspace/chat" auf.“

Karussell

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet.

Ein Karussell, auch als Slider bezeichnet, dreht sich und zeigt eine Liste von Widgets in einem Diashow-Format an. Mit Schaltflächen kann zum vorherigen oder nächsten Widget navigiert werden.

Im Folgenden sehen Sie ein Beispiel für die JSON-Darstellung eines Karussells mit drei Textabsatz-Widgets.

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

Für Google Chat-Apps verfügbar, für Google Workspace-Add‑ons nicht.

JSON-Darstellung
{ "carouselCards": [ { object (CarouselCard) } ] }

Felder
carouselCards[]	object (CarouselCard) Eine Liste der Karten, die im Karussell enthalten sind.

CarouselCard

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet.

Eine Karte, die als Karussellelement angezeigt werden kann. Für Google Chat-Apps verfügbar, nicht 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) Unten auf der Karussellkarte wird eine Liste mit Widgets angezeigt. Die Widgets werden in der Reihenfolge angezeigt, in der sie angegeben sind.

NestedWidget

Entwicklervorschau:Verfügbar im Rahmen des Google Workspace-Entwicklervorschauprogramms, das Vorabzugriff auf bestimmte Funktionen bietet.

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

JSON-Darstellung
{ // Union field data can be only one of the following: "textParagraph": { object (TextParagraph) }, "buttonList": { object (ButtonList) }, "image": { object (Image) } // End of list of possible types for union field data. }

Felder
Union-Feld data. data kann nur einer der folgenden Werte sein:
textParagraph	object (TextParagraph) Ein Textabsatz-Widget.
buttonList	object (ButtonList) Ein Widget mit einer Liste von Schaltflächen.
image	object (Image) Ein Bild-Widget.

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. Definieren Sie eine benutzerdefinierte Schaltfläche, 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 berücksichtigt. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.
collapseButton	object (Button) Optional. Definieren Sie eine benutzerdefinierte Schaltfläche, 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 berücksichtigt. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.

DividerStyle

Der Stil des Trennzeichens 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. Stelle eine durchgezogene Trennlinie dar.
NO_DIVIDER	Wenn diese Option festgelegt ist, wird keine Trennlinie gerendert. Bei diesem Stil wird die Trennlinie vollständig aus dem Layout entfernt. Das Ergebnis ist dasselbe, als wenn Sie überhaupt keine Trennlinie hinzufügen.

CardAction

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

Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

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

Felder
actionLabel	string Das Label, das als Aktionsmenüelement angezeigt wird.
onClick	object (OnClick) Die onClick-Aktion 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, tritt ein Fehler auf.

Für Chat-Apps können Sie feste Fußzeilen in Dialogfeldern, aber nicht in Karten-Nachrichten verwenden. Ein Beispiel für Google Chat-Apps finden Sie unter Eine dauerhafte Fußzeile 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) Die primäre Schaltfläche der fixierten Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit Text und Farbe sein.
secondaryButton	object (Button) Die sekundäre Schaltfläche 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

Bestimmt in Google Workspace-Add-ons, wie eine Karte angezeigt wird.

Für Google Workspace-Add‑ons verfügbar, für Google Chat-Apps nicht.

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 Überschrift klicken, wird die Karte in den Kartenstapel eingefügt. Wenn die Karte keinen Header hat, wird stattdessen ein generierter Header verwendet.
REPLACE	Standardwert. Die Karte wird angezeigt, indem die Ansicht der obersten Karte im Kartenstapel ersetzt wird.