Package google.apps.card.v1

Index

Aktion

Eine Aktion, die das Verhalten beim Senden 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.

Felder
function

string

Eine benutzerdefinierte Funktion, die aufgerufen wird, wenn auf das enthaltende Element geklickt oder es anderweitig aktiviert wird.

Anwendungsbeispiele finden Sie unter Formulardaten lesen.
parameters[]

ActionParameter

Liste der Aktionsparameter.
loadIndicator

LoadIndicator

Gibt den Ladeindikator an, der angezeigt wird, während die Aktion ausgeführt wird.
persistValues

bool

Gibt an, ob Formularwerte nach der Aktion bestehen bleiben. Der Standardwert ist false.

Bei true bleiben die Formularwerte bestehen, nachdem die Aktion ausgelöst wurde. Damit der Nutzer Änderungen vornehmen kann, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf NONE. Für Kartennachrichten in Chat-Apps müssen Sie auch ResponseType der Aktion auf UPDATE_MESSAGE setzen und dasselbe card_id wie die Karte verwenden, die die Aktion enthält.

Wenn false, werden die Formularwerte gelöscht, wenn die Aktion ausgelöst wird. Um zu verhindern, dass der Nutzer Änderungen vornimmt, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf SPINNER.
interaction

Interaction

Optional. Erforderlich beim Öffnen eines Dialogfelds.

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

Wird kein Wert angegeben, führt die App wie gewohnt eine action aus, z. B. das Öffnen eines Links oder das Ausführen einer Funktion.

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 angezeigt. Wenn für ein Add-on angegeben, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

string

Optional. Füllen Sie diese Liste mit den Namen der Widgets, die diese Aktion für eine gültige Einreichung benötigt.

Wenn die hier aufgeführten Widgets beim Aufrufen dieser Aktion keinen Wert aufweisen, wird die Formularübermittlung abgebrochen.

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

bool

Optional. Wenn dies wahr ist, gelten für diese Aktion alle Widgets als erforderlich.

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

ActionParameter

Liste der Stringparameter, die beim Aufrufen der Aktionsmethode angegeben werden sollen. Betrachten Sie zum Beispiel drei Schaltflächen für die Schlummerfunktion: "Jetzt pausieren", "Schlummern an einem Tag" und "Schlummern für nächste Woche". Sie können action method = snooze() verwenden und den Typ und die Zeit für die Schlummerfunktion in der Liste der Stringparameter übergeben.

Weitere Informationen finden Sie unter CommonEventObject.

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

Felder
key

string

Der Name des Parameters für das Aktionsskript.
value

string

Wert des Parameters.

Interaktion

Optional. Erforderlich beim Öffnen eines Dialogfelds.

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

Wird kein Wert angegeben, führt die App wie gewohnt eine action aus, z. B. das Öffnen eines Links oder das Ausführen einer Funktion.

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 angezeigt. Wenn für ein Add-on angegeben, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

Enums
INTERACTION_UNSPECIFIED Standardwert. action wird wie gewohnt ausgeführt.
OPEN_DIALOG

Ein Dialogfeld wird geöffnet. Dies ist eine kartenbasierte Oberfläche im Fenstermodus, über die Chat-Apps mit Nutzern interagieren.

Wird nur von Chat-Apps als Reaktion auf Schaltflächenklicks auf Kartennachrichten unterstützt. Wenn für ein Add-on angegeben, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

LoadIndicator

Gibt den Ladeindikator an, der angezeigt wird, während die Aktion ausgeführt wird.

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

Enums
SPINNER Ein rotierendes Ladesymbol wird angezeigt, wenn der Inhalt geladen wird.
NONE Es wird nichts angezeigt.

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.

Felder
type

BorderType

Der Rahmentyp.
strokeColor

Color

Die zu verwendenden Farben, 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 sein, basierend auf dem RGB-Farbwert, wobei 0 (0/255) für das Fehlen von Farbe und 1 (255/255) die maximale Intensität der Farbe darstellt.

Das folgende Beispiel legt die Farbe bei maximaler Intensität auf Rot fest:

"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

int32

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 Standardwert. Kein Rahmen.
STROKE Gliederung.

Schaltfläche

Text-, Symbol- oder Text- und Symbolschaltflächen, auf die Nutzende klicken können. Ein Beispiel für eine Google Chat App finden Sie unter Schaltfläche hinzufügen.

Wenn Sie ein Bild zu einer klickbaren Schaltfläche machen möchten, geben Sie ein Image (kein ImageComponent) und eine onClick-Aktion an.

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

Felder
text

string

Der auf der Schaltfläche angezeigte Text.
icon

Icon

Ein Symbol, das innerhalb der Schaltfläche angezeigt wird. Wenn sowohl icon als auch text festgelegt sind, wird das Symbol vor dem Text angezeigt.
color

Color

Optional. Die Farbe der Schaltfläche. Ist dies der Fall, wird die Schaltfläche type auf FILLED gesetzt und die Farbe der Felder „text“ und „icon“ wird zur besseren Lesbarkeit auf eine Kontrastfarbe gesetzt. Wenn für die Schaltfläche beispielsweise Blau festgelegt ist, wird auch der gesamte Text und alle Symbole in der Schaltfläche weiß dargestellt.

Zum Festlegen der Farbe der Schaltfläche geben Sie einen Wert für die Felder red, green und blue an. Der Wert muss eine Gleitkommazahl zwischen 0 und 1 sein, basierend auf dem RGB-Farbwert, wobei 0 (0/255) für das Fehlen von Farbe und 1 (255/255) die maximale Intensität der Farbe darstellt.

Das folgende Beispiel legt die Farbe bei maximaler Intensität auf Rot fest:

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

Das Feld „alpha“ ist für die Farbe der Schaltfläche nicht verfügbar. Wenn angegeben, wird dieses Feld ignoriert.
onClick

OnClick

Erforderlich. Die auszuführende Aktion, wenn ein Nutzer auf die Schaltfläche klickt, z. B. das Öffnen eines Hyperlinks oder das Ausführen einer benutzerdefinierten Funktion.
disabled

bool

Wenn true, wird die Schaltfläche inaktiv angezeigt und reagiert nicht auf Nutzeraktionen.
altText

string

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

Legen Sie einen beschreibenden Text fest, der die Nutzer über die Funktion der Schaltfläche informiert. Wenn durch eine 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

Type

Optional. Die Art einer Schaltfläche. Wenn kein Wert festgelegt ist, wird standardmäßig OUTLINED als Schaltflächentyp verwendet. Wenn das Feld „color“ festgelegt ist, wird der Schaltflächentyp auf FILLED festgelegt und alle für dieses Feld festgelegten Werte werden ignoriert.

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

Typ

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

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

Enums
TYPE_UNSPECIFIED Nicht verwenden. Nicht angegeben
OUTLINED Umrissene Schaltflächen sind Schaltflächen mit mittlerer Betonung. Sie enthalten in der Regel wichtige Aktionen, die nicht die primäre Aktion in einer Chat-App oder einem Add-on sind.
FILLED Eine ausgefüllte Schaltfläche hat einen Container mit einer Volltonfarbe. 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 ausgefüllte Tonschaltfläche ist ein alternativer Mittelweg zwischen ausgefüllten und umrissenen Schaltflächen. Sie sind nützlich, wenn eine Schaltfläche mit niedrigerer Priorität etwas mehr Betonung erfordert als eine Umrissschaltfläche.
BORDERLESS Im Standardzustand hat eine Schaltfläche keinen unsichtbaren Container. Sie wird häufig für Aktionen mit der niedrigsten Priorität verwendet, insbesondere wenn mehrere Optionen präsentiert werden.

ButtonList

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

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

Felder
buttons[]

Button

Mehrere Schaltflächen

Infokarte

Eine Karte, die in einer Google Chat-Nachricht oder einem Google Workspace-Add-on angezeigt wird

Karten unterstützen ein festgelegtes Layout, interaktive UI-Elemente wie Schaltflächen und Rich Media wie Bilder. Verwenden Sie Karten, um detaillierte Informationen zu präsentieren, Informationen von Nutzern zu erfassen und sie bei den nächsten Schritten zu unterstützen.

Entwerfen Sie Karten mit dem Card Builder und zeigen Sie Vorschauen an.

Card Builder öffnen

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

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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Felder
header

CardHeader

Der Header der Karte. Eine Kopfzeile enthält normalerweise ein führendes Bild und einen Titel. Überschriften werden immer oben auf einer Karte angezeigt.
sections[]

Section

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

DividerStyle

Der Trennungsstil zwischen Abschnitten.
cardActions[]

CardAction

Die Aktionen der Karte. Aktionen werden dem Symbolleistenmenü der Karte hinzugefügt.

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

Die folgende JSON-Datei erstellt beispielsweise ein Kartenaktionsmenü mit den Optionen Settings und Send Feedback:

"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 Kartenkennung in der Kartennavigation verwendet.

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

CardFixedFooter

Die feste Fußzeile, die unten auf dieser 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 verwenden, aber keine Kartennachrichten.

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

DisplayStyle

Legen Sie in den Google Workspace-Add-ons die Anzeigeeigenschaften von peekCardHeader fest.

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

CardHeader

Bei der Anzeige von kontextbezogenen Inhalten fungiert der Header der Peek-Karte als Platzhalter, sodass der Nutzer zwischen den Startseiten- und den Kontextkarten vorwärts navigieren kann.

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

CardAction

Eine Kartenaktion ist die mit der Karte verknüpfte Aktion. Eine Rechnungskarte kann beispielsweise Aktionen wie das Löschen einer Rechnung, eine E-Mail-Rechnung oder das Öffnen der Rechnung in einem Browser enthalten.

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

Felder
actionLabel

string

Das Label, das als Menüelement für Aktionen angezeigt wird.
onClick

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 verwenden, aber keine Kartennachrichten. Ein Beispiel für eine Google Chat App finden Sie unter Dauerhafte Fußzeile hinzufügen.

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

Felder
primaryButton

Button

Die primäre Schaltfläche der festen Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit einem festgelegten Text und einer bestimmten Farbe sein.
secondaryButton

Button

Die sekundäre Schaltfläche der festen Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit einem festgelegten Text und einer bestimmten Farbe sein. Wenn secondaryButton festgelegt ist, müssen Sie auch primaryButton festlegen.

CardHeader

Stellt eine Kartenüberschrift dar. Ein Beispiel für eine Google Chat App finden Sie im Hilfeartikel Header hinzufügen.

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

Felder
title

string

Erforderlich. Der Titel der Kartenüberschrift. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch eine Unterüberschrift angegeben sind, belegt jede eine Zeile. Wenn nur der Titel angegeben ist, werden beide Zeilen ausgefüllt.
subtitle

string

Der Untertitel der Kartenüberschrift. Falls angegeben, wird es in einer eigenen Zeile unterhalb von title angezeigt.
imageType

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 im Kartenheader.
imageAltText

string

Der alternative Text dieses Bildes, der als Bedienungshilfe verwendet wird.

DisplayStyle

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

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

Enums
DISPLAY_STYLE_UNSPECIFIED Nicht verwenden. Nicht angegeben
PEEK Der Header der Karte wird unten in der Seitenleiste angezeigt und verdeckt die aktuelle oberste Karte des Stapels teilweise. Wenn Sie auf den Header klicken, wird die Karte im Kartenstapel geöffnet. Wenn die Karte keinen Header hat, wird stattdessen ein generierter Header verwendet.
REPLACE Standardwert. Die obere Karte im Stapel wird durch die neue Ansicht ersetzt.

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. Stellt eine durchgehende Trennlinie dar.
NO_DIVIDER Wenn festgelegt, wird keine Trennlinie gerendert. Durch diesen Stil wird die Trennlinie aus dem Layout vollständig entfernt. Das Ergebnis ist dasselbe, wenn gar keine Trennlinie hinzugefügt wird.

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.

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[]

Widget

Alle Widgets in diesem Abschnitt. Muss mindestens ein Widget enthalten.
collapsible

bool

Gibt an, ob dieser Abschnitt minimierbar ist.

Minimierbare Bereiche blenden einige oder alle Widgets aus. Nutzer können den Bereich jedoch maximieren und die ausgeblendeten Widgets einblenden, indem Sie auf Mehr anzeigen klicken. Nutzer können die Widgets wieder ausblenden, indem sie auf Weniger anzeigen klicken.

Wenn Sie festlegen möchten, welche Widgets ausgeblendet sind, geben Sie uncollapsibleWidgetsCount an.
uncollapsibleWidgetsCount

int32

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 gesetzt ist, werden die ersten beiden Widgets immer angezeigt und die letzten drei standardmäßig minimiert. uncollapsibleWidgetsCount wird nur berücksichtigt, wenn collapsible gleich true ist.
collapseControl

CollapseControl

Optional. Definieren Sie die Schaltfläche zum Maximieren und Minimieren des Abschnitts. Diese Schaltfläche wird nur angezeigt, wenn der Bereich minimierbar ist. Ist dieses Feld nicht festgelegt, wird die Standardschaltfläche verwendet. Verfügbar für Google Chat-Apps und nicht für Google Workspace-Add-ons.

Chip

Ein Text, ein Symbol oder ein Text- und Symbolchip, auf den Nutzer klicken können.

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

Felder
icon

Icon

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

string

Der im Chip angezeigte Text.
onClick

OnClick

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

bool

Gibt an, ob der Chip aktiv ist und auf Nutzeraktionen reagiert. Die Standardeinstellung ist true. Verworfen. Verwenden Sie stattdessen disabled.
disabled

bool

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

string

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

Legen Sie einen beschreibenden Text fest, der Nutzer über die Funktion des Chips informiert. Wenn durch einen Chip beispielsweise ein Hyperlink geöffnet wird, schreiben Sie: „Öffnet einen neuen Browsertab und ruft die Google Chat-Entwicklerdokumentation unter https://developers.google.com/workspace/chat&quot; auf.

ChipList

Eine Liste von horizontal angeordneten Chips, die entweder horizontal gescrollt werden oder zur nächsten Zeile springen können.

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

Felder
layout

Layout

Angegebenes Layout der Chipliste.
chips[]

Chip

Eine Reihe von Chips.

Layout

Das Layout der Chipliste.

Enums
LAYOUT_UNSPECIFIED Nicht verwenden. Nicht angegeben
WRAPPED Standardwert. Wenn horizontal nicht genügend Platz vorhanden ist, wird von der Chipliste zur nächsten Zeile gewechselt.
HORIZONTAL_SCROLLABLE Die Chips scrollen horizontal, wenn sie nicht in den verfügbaren Platz passen.

CollapseControl

Stellt ein Steuerelement zum Maximieren und Minimieren dar. Verfügbar für Google Chat-Apps und nicht für Google Workspace-Add-ons.

Felder
horizontalAlignment

HorizontalAlignment

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

Button

Optional. Definieren Sie eine anpassbare Schaltfläche, um den Bereich zu maximieren. Es muss sowohl das Feld "expandButton" als auch das Feld "collapsbutton" festgelegt werden. Nur ein Feldsatz wird nicht wirksam. Ist dieses Feld nicht festgelegt, wird die Standardschaltfläche verwendet.
collapseButton

Button

Optional. Definieren Sie eine anpassbare Schaltfläche, um den Abschnitt zu minimieren. Es muss sowohl das Feld "expandButton" als auch das Feld "collapsbutton" festgelegt werden. Nur ein Feldsatz wird nicht wirksam. Ist dieses Feld nicht festgelegt, wird die Standardschaltfläche verwendet.

Spalten

Das Columns-Widget zeigt bis zu zwei Spalten in einer Karte oder einem Dialogfeld an. Sie können Widgets zu jeder Spalte hinzufügen. werden die Widgets 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 ist als die zweite Spalte, 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.

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

  • 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 Grid-Widget.

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

Felder
columnItems[]

Column

Ein Array von Spalten. Eine Karte oder ein Dialogfeld kann bis zu zwei Spalten enthalten.

Spalte

Spalte

Google Workspace-Add-ons und Chat-Apps

Felder
horizontalSizeStyle

HorizontalSizeStyle

Gibt an, wie eine Spalte die Breite der Karte einnimmt.
horizontalAlignment

HorizontalAlignment

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

VerticalAlignment

Gibt an, ob Widgets am oberen, unteren oder mittleren Rand einer Spalte ausgerichtet werden.
widgets[]

Widgets

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

HorizontalSizeStyle

Gibt an, wie eine Spalte die Breite der Karte einnimmt. Die Breite jeder Spalte hängt sowohl vom 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, und zwar bis zu 70% der Kartenbreite. Wenn beide Spalten auf FILL_AVAILABLE_SPACE gesetzt sind, füllt jede Spalte 50% des Bereichs aus.
FILL_MINIMUM_SPACE Die Spalte füllt den geringsten Platz aus und nicht mehr als 30% der Kartenbreite.

VerticalAlignment

Gibt an, ob Widgets am oberen, unteren oder mittleren Rand 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 Anfang einer Spalte aus.
BOTTOM Richtet Widgets am unteren Rand einer Spalte aus.

Widgets

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

Google Workspace-Add-ons und Chat-Apps

Felder

Union-Feld data.

Für data ist nur einer der folgenden Werte zulässig:
textParagraph

TextParagraph

Widget TextParagraph
image

Image

Widget Image
decoratedText

DecoratedText

Widget DecoratedText
buttonList

ButtonList

Widget ButtonList
textInput

TextInput

Widget TextInput
selectionInput

SelectionInput

Widget SelectionInput
dateTimePicker

DateTimePicker

Widget DateTimePicker
chipList

ChipList

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

DateTimePicker

Damit können Nutzer ein Datum, eine Uhrzeit oder beides eingeben. Ein Beispiel für Google Chat-Apps finden Sie im Hilfeartikel Nutzer dürfen Datum und Uhrzeit auswählen.

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 in der Auswahl eine Fehlermeldung angezeigt, in der sie aufgefordert werden, die Informationen korrekt einzugeben.

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

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

Text, mit dem die Nutzer aufgefordert werden, 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

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 Unixzeit.

Geben Sie den Wert basierend auf dem Auswahltyp (DateTimePickerType) an:

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

int32

Zahl in Minuten, die die Zeitzonenverschiebung gegenüber UTC darstellt. Wenn festgelegt, wird value_ms_epoch in der angegebenen Zeitzone angezeigt. Wenn kein Wert festgelegt ist, wird standardmäßig die Zeitzoneneinstellung des Nutzers verwendet.
onChangeAction

Action

Wird ausgelöst, wenn der Nutzer auf der DateTimePicker-Oberfläche auf Speichern oder Löschen klickt.
validation

Validation

Optional. Geben Sie die Validierung an, die für diese Datetimer-Auswahl erforderlich ist.

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

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 Uhrzeit ein.

DecoratedText

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

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

Felder
icon
(deprecated)

Icon

Zugunsten von startIcon verworfen.
startIcon

Icon

Das vor dem Text angezeigte Symbol
topLabel

string

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

string

Erforderlich. Der Haupttext.

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.
wrapText

bool

Die Einstellung für den Textumbruch. Bei true wird der Text umgebrochen und auf 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.
onClick

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 im decoratedText-Widget rechts neben dem Text erscheint. Für control ist nur einer der folgenden Werte zulässig:
button

Button

Eine Schaltfläche, auf die Nutzende klicken können, um eine Aktion auszulösen.
switchControl

SwitchControl

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

Icon

Ein Symbol, das nach dem Text angezeigt wird.

Unterstützt integrierte und benutzerdefinierte Symbole.

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.

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

bool

Wenn true, ist der Schalter ausgewählt.
onChangeAction

Action

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

ControlType

Darstellung des Schalters auf der Benutzeroberfläche.

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

ControlType

Darstellung des Schalters auf der Benutzeroberfläche.

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

Enums
SWITCH Ein Schalter
CHECKBOX Zugunsten von CHECK_BOX verworfen.
CHECK_BOX Ein Kästchen.

Trennlinie

Dieser Typ hat keine Felder.

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

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

Die folgende JSON erstellt beispielsweise eine Trennlinie:

"divider": {}

EndNavigation

Ablaufaktion im Dialogfeld.

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

Felder
action

Action

Die Renderingaktion für den Client zum Beenden eines Dialogs.

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

Aktion

Die Renderingaktionstypen, mit denen der Client einen Dialogvorgang beenden kann.

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

Enums
ACTION_UNSPECIFIED Aktion nicht angegeben.
CLOSE_DIALOG Dialogfeld schließen.
CLOSE_DIALOG_AND_EXECUTE Schließen Sie den Dialogvorgang und aktualisieren Sie die Karte, mit der der Dialog geöffnet wurde.

GetAutocompletionResponse

Eine Antwort auf den Abruf eines Containers für die automatische Vervollständigung, der Elemente enthält, die zum Anzeigen von Elementen der automatischen Vervollständigung für das Textfeld erforderlich sind.

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

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Felder
autoComplete

Suggestions
schema

string

Dies ist ein No-Op-Schemafeld, das möglicherweise in der Auszeichnung für die Syntaxprüfung vorhanden ist.

Raster

Zeigt ein Raster mit einer Sammlung von Elementen an. Elemente dürfen nur Text oder Bilder enthalten. Verwenden Sie Columns, wenn Sie responsive Spalten verwenden oder mehr als Text oder Bilder einfügen möchten. 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 ergibt sich aus den Elementen geteilt durch die Spalten. 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.

Die folgende JSON erstellt beispielsweise ein zweispaltiges Raster mit einem einzelnen Element:

"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"
    }
  }
}
Felder
title

string

Der Text, der in der Rasterüberschrift angezeigt wird.
items[]

GridItem

Die Elemente, die im Raster angezeigt werden sollen.
borderStyle

BorderStyle

Der Rahmenstil, der auf die einzelnen Rasterelemente angewendet werden soll.
columnCount

int32

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

OnClick

Dieser Callback wird von jedem einzelnen Rasterelement wiederverwendet, wobei jedoch die Kennung und der Index des Elements in der Elementliste den Parametern des Callbacks hinzugefügt werden.

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.

Felder
id

string

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

ImageComponent

Das Bild, das im Rasterelement angezeigt wird.
title

string

Der Titel des Rasterelements.
subtitle

string

Untertitel des Rasterelements
layout

GridItemLayout

Das für das Rasterelement zu verwendende Layout.

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 Titel und Untertitel werden unter dem Bild des Rasterelements angezeigt.
TEXT_ABOVE Titel und Untertitel werden über dem Bild des Rasterelements angezeigt.

Symbol

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

Unterstützt integrierte und benutzerdefinierte Symbole.

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

Felder
altText

string

Optional. Eine Beschreibung des Symbols, das für Barrierefreiheit verwendet wird. Wenn keine Vorgabe erfolgt, wird der Standardwert Button angegeben. Als Best Practice sollten Sie eine hilfreiche Beschreibung für die Anzeige des Symbols und gegebenenfalls dessen Funktion festlegen. 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 Hilfstext angezeigt, wenn der Nutzer den Mauszeiger auf die Schaltfläche bewegt. Wird über die Schaltfläche allerdings zusätzlich „text“ festgelegt, wird der „altText“-Wert des Symbols ignoriert.
imageType

ImageType

Der auf das Bild angewendete Zuschnittsstil. In einigen Fällen führt das Zuschneiden von CIRCLE dazu, dass das Bild größer gezeichnet wird als ein integriertes Symbol.
Union-Feld icons. Das Symbol, das im Widget auf der Karte angezeigt wird. Für icons ist nur einer der folgenden Werte zulässig:
knownIcon

string

Rufen Sie eines der integrierten Symbole von Google Workspace auf.

Wenn beispielsweise ein Flugzeugsymbol angezeigt werden soll, geben Sie AIRPLANE an. Für einen Bus geben Sie BUS an.

Eine vollständige Liste der unterstützten Symbole finden Sie unter Integrierte Symbole.
iconUrl

string

Zeigt ein benutzerdefiniertes Symbol an, 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

MaterialIcon

Zeigen Sie eines der Material-Symbole von Google an.

Wenn beispielsweise ein Kästchensymbol angezeigt werden soll, verwenden Sie

"materialIcon": {
  "name": "check_box"
}

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

Bild

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

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

Felder
imageUrl

string

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

Beispiel:

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

OnClick

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

string

Der alternative Text dieses Bildes, der als Bedienungshilfe verwendet wird.

ImageComponent

Stellt ein Bild dar.

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

Felder
imageUri

string

Die Bild-URL.
altText

string

Das Bedienungshilfen-Label für das Bild.
cropStyle

ImageCropStyle

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

BorderStyle

Der Rahmenstil, der auf das Bild angewendet werden soll.

ImageCropStyle

Stellt den auf ein Bild angewendeten Zuschnittsstil dar.

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

So können Sie beispielsweise ein Seitenverhältnis von 16:9 verwenden:

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

ImageCropType

Der Zuschneidetyp.
aspectRatio

double

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

So können Sie beispielsweise ein Seitenverhältnis von 16:9 verwenden:

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

ImageCropType

Stellt den auf ein Bild angewendeten Zuschnittsstil dar.

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

Enums
IMAGE_CROP_TYPE_UNSPECIFIED Nicht verwenden. Nicht angegeben
SQUARE Standardwert. Quadratzuschnitt anwenden.
CIRCLE Macht einen kreisförmigen Schnitt.
RECTANGLE_CUSTOM schneidet einen rechteckigen Ausschnitt mit einem benutzerdefinierten Seitenverhältnis zu. Legen Sie das benutzerdefinierte Seitenverhältnis mit aspectRatio fest.
RECTANGLE_4_3 schneidet einen rechteckigen Ausschnitt mit einem Seitenverhältnis von 4:3 zu.

LinkPreview

Kartenaktion, bei der eine Karte und ein Smartchip als Vorschau eines Drittanbieterlinks angezeigt werden. Weitere Informationen finden Sie unter Vorschaulinks mit Smartchips.

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

Die folgende JSON-Datei gibt beispielsweise einen eindeutigen Titel für die Linkvorschau und ihren Smartchip sowie eine Vorschaukarte mit einer Überschrift und einer Textbeschreibung zurück:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

Im Beispiel wird die folgende Linkvorschau zurückgegeben:

Beispiel für eine Linkvorschau

Felder
previewCard

Card

Eine Karte mit Informationen zu einem Link eines Drittanbieterdienstes.
title

string

Der Titel, der auf dem Smartchip für die Linkvorschau angezeigt wird. Wenn kein Wert festgelegt ist, zeigt der Smartchip den Header von preview_card an.
linkPreviewTitle

string

Der Titel, der in der Linkvorschau angezeigt wird. Wenn kein Wert festgelegt ist, wird in der Linkvorschau der Header von preview_card angezeigt.

MaterialIcon

Ein Material-Symbol von Google mit über 2.500 Optionen.

Wenn beispielsweise ein Kästchensymbol mit benutzerdefinierten Gewichtungen und Stufen angezeigt werden soll, geben Sie Folgendes ein:

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

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

Felder
name

string

Der im Material-Symbol von Google 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

bool

Gibt an, ob das Symbol gefüllt wird. Der Standardwert ist "false".

Wenn Sie sich eine Vorschau der verschiedenen Symboleinstellungen ansehen möchten, gehen Sie zu Google-Schriftsymbole und passen Sie die Einstellungen unter Anpassen an.
weight

int32

Die Strichstärke des Symbols. Wählen Sie {100, 200, 300, 400, 500, 600, 700} aus. Wenn nicht vorhanden, ist der Standardwert 400. Wird ein anderer Wert angegeben, wird der Standardwert verwendet.

Wenn Sie sich eine Vorschau der verschiedenen Symboleinstellungen ansehen möchten, gehen Sie zu Google-Schriftsymbole und passen Sie die Einstellungen unter Anpassen an.
grade

int32

Gewicht und Grad wirken sich auf die Stärke eines Symbols aus. Anpassungen der Noten sind detaillierter als Anpassungen der Gewichtung und wirken sich nur geringfügig auf die Größe des Symbols aus. Wählen Sie {-25, 0, 200} aus. Wenn nicht vorhanden, ist der Standardwert 0. Wird ein anderer Wert angegeben, wird der Standardwert verwendet.

Wenn Sie sich eine Vorschau der verschiedenen Symboleinstellungen ansehen möchten, gehen Sie zu Google-Schriftsymbole und passen Sie die Einstellungen unter Anpassen an.

Kartenaktion, die den Kartenstapel manipuliert.

Beispiel:

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

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

 navigations : {
    pushCard : CARD
  }

2) Aktualisieren Sie die Karte oben auf dem Stapel (mit Update).

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

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Gehe einen Schritt zurück, ohne zu aktualisieren.

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

  navigations : {
    popCard : true,
  }

4) Gehen Sie mehrere Schritte zurück und aktualisieren Sie die Karte.

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

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Es werden mehrere Schritte zu einem definierten CARD_NAME-Objekt zurückverfolgt.

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

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Wechseln Sie zurück zum Stammverzeichnis und aktualisieren Sie die Karte.

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

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Rufen Sie die angegebene Karte auf und schließen Sie diese ebenfalls.

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

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Ersetzen Sie die obere Karte durch eine neue. Für Chat-Apps nur für den App-Startbildschirm 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:
popToRoot

bool

Der Kartenstapel entfernt alle Karten mit Ausnahme der Root-Karte.
pop

bool

Beim Kartenstapel wird eine Karte geöffnet.
popToCard

string

Der Kartenstapel platziert alle Karten über der angegebenen Karte mit dem angegebenen Kartennamen.
pushCard

Card

Ein Kartenstapel schiebt eine Karte auf den Kartenstapel.
updateCard

Card

Der Kartenstapel aktualisiert die obere Karte mit einer neuen Karte und behält die Werte der ausgefüllten Formularfelder bei. Bei nicht übereinstimmenden Feldern wird der Wert verworfen.
endNavigation

EndNavigation

Dialogfeld für Navigationsaktion zum Beenden des Ablaufs. Weitere Informationen finden Sie im Hilfeartikel Startseite für eine Google Chat-App erstellen.

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

Benachrichtigung

Kartenaktion, durch die eine Benachrichtigung in der Host-App angezeigt wird.

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

Felder
text

string

Nur-Text ohne HTML-Tags, der für die Benachrichtigung angezeigt werden soll

OnClick

Stellt dar, wie eine Reaktion erfolgen soll, wenn Nutzer auf ein interaktives Element auf einer Karte, z. B. eine Schaltfläche, klicken.

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

Felder

Union-Feld data.

Für data ist nur einer der folgenden Werte zulässig:
action

Action

Wenn angegeben, wird eine Aktion von diesem onClick ausgelöst.
openDynamicLinkAction

Action

Diese Aktion wird durch ein Add-on ausgelöst, wenn mit der Aktion ein Link geöffnet werden muss. Der Unterschied zur open_link oben besteht darin, dass zum Abrufen des Links mit dem Server kommuniziert werden muss. Daher muss der Webclient einige Vorbereitungen treffen, bevor die Antwort der Aktion für offene Links zurückgegeben wird.

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

Card

Wenn angegeben, wird nach dem Klicken eine neue Karte in den Stapel verschoben.

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

OverflowMenu

Wenn angegeben, öffnet dies onClick ein Dreipunkt-Menü. Verfügbar für Google Chat-Apps und nicht für Google Workspace-Add-ons.

OnClose

Aktion des Clients, wenn ein durch eine OnClick-Aktion geöffneter Link geschlossen wird

Die Implementierung hängt von den Funktionen der Clientplattform ab. Beispielsweise kann in einem Webbrowser ein Link mit einem OnClose-Handler in einem Pop-up-Fenster geöffnet werden.

Wenn sowohl der OnOpen- als auch der OnClose-Handler festgelegt ist und die Clientplattform nicht beide Werte unterstützt, hat OnClose Vorrang.

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

Enums
NOTHING Standardwert. Die Karte wird nicht aufgeladen. passiert nichts.
RELOAD

Lädt die Karte neu, nachdem das untergeordnete Fenster geschlossen wurde.

Wenn das untergeordnete Fenster in Verbindung mit OpenAs.OVERLAY verwendet wird, fungiert es als modales Dialogfeld. Die übergeordnete Karte wird blockiert, bis das untergeordnete Fenster geschlossen wird.

OpenAs

Wenn durch eine OnClick-Aktion ein Link geöffnet wird, kann der Client diesen entweder als Fenster in voller Größe (wenn dieser Frame vom Client verwendet wird) oder als Overlay (z. B. ein Pop-up) öffnen. Die Implementierung hängt von den Funktionen der Clientplattform ab. Der ausgewählte Wert wird möglicherweise ignoriert, wenn er vom Client nicht unterstützt wird. FULL_SIZE wird von allen Clients unterstützt.

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

Enums
FULL_SIZE Der Link wird in voller Größe geöffnet (wenn dieser Frame vom Client verwendet wird).
OVERLAY Der Link wird als Overlay geöffnet, z. B. als Pop-up.

OverflowMenu

Ein Widget, das ein Pop-up-Menü mit einer oder mehreren Aktionen anzeigt, die Nutzer aufrufen können. Beispiel: Anzeige von nicht primären Aktionen in einer Karte. Sie können dieses Widget verwenden, wenn der verfügbare Platz für Aktionen nicht ausreicht. Gib dieses Widget in der OnClick-Aktion der Widgets an, die es unterstützen. Zum Beispiel in einem Button.

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

Felder
items[]

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 nicht für Google Workspace-Add-ons.

Felder
startIcon

Icon

Das vor dem Text angezeigte Symbol
text

string

Erforderlich. Der Text, mit dem der Artikel für Nutzer identifiziert oder beschrieben wird.
onClick

OnClick

Erforderlich. Die Aktion, die aufgerufen wird, wenn eine Menüoption ausgewählt wird. Dieses OnClick darf kein OverflowMenu enthalten, ein angegebenes OverflowMenu wird gelöscht und der Menüpunkt deaktiviert.
disabled

bool

Gibt an, ob die Menüoption deaktiviert ist. Die Standardeinstellung ist "false".

RenderActions

Eine Reihe von Rendering-Anweisungen, mit denen eine Karte aufgefordert wird, eine Aktion auszuführen, oder die die Add-on-Host-App oder die Chat-App auffordern, eine appspezifische Aktion auszuführen.

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

Felder
action

Action
hostAppAction

HostAppActionMarkup

Aktionen, die von einzelnen Host-Apps ausgeführt werden.
schema

string

Dies ist ein No-Op-Schemafeld, das möglicherweise in der Auszeichnung für die Syntaxprüfung vorhanden ist.

Aktion

Felder
navigations[]

Navigation

Angezeigte Karten per Push, Pop-up oder Update aktualisieren
notification

Notification

Benachrichtigung für den Endnutzer anzeigen
linkPreview

LinkPreview

Zeigen Sie dem Endnutzer eine Linkvorschau an.

SelectionInput

Ein Widget, das ein oder mehrere UI-Elemente erstellt, die Nutzer auswählen können. Zum Beispiel ein Drop-down-Menü 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.

Mit dem TextInput-Widget können Sie nicht definierte oder abstrakte Daten von Nutzern erheben.

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

Felder
name

string

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

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

string

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

Geben Sie Text ein, der dem Nutzer die Eingabe der Informationen erleichtert, die Ihre App benötigt. Wenn Nutzer beispielsweise die Dringlichkeit eines Arbeitstickets aus einem Drop-down-Menü auswählen, kann das Label „Dringlichkeit“ lauten. oder „Dringlichkeit auswählen“.
type

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ü auswählen.
items[]

SelectionItem

Ein Array mit auswählbaren Elementen. Dies kann beispielsweise ein Array von Optionsfeldern oder Kästchen sein. Unterstützt bis zu 100 Artikel.
onChangeAction

Action

Falls angegeben, wird das Formular gesendet, wenn sich die Auswahl ändert. Wenn nicht angegeben, musst du eine separate Schaltfläche zum Senden des Formulars angeben.

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

int32

Bei Menüs mit Mehrfachauswahl die maximale Anzahl von Elementen, die ein Nutzer auswählen kann. Der Mindestwert beträgt 1 Element. Wenn keine Vorgabe erfolgt, werden standardmäßig 3 Elemente verwendet.
multiSelectMinQueryLength

int32

Bei Mehrfachauswahl-Menüs die Anzahl der Textzeichen, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt und vorgeschlagene Elemente im Menü anzeigt.

Wenn kein Wert angegeben ist, wird standardmäßig 0 Zeichen für statische Datenquellen und 3 Zeichen für externe Datenquellen verwendet.
validation

Validation

Bei Drop-down-Menüs die Validierung für dieses Auswahleingabefeld.

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

Union-Feld multi_select_data_source. Bei einem Mehrfachauswahl-Menü die Datenquelle, über die die Auswahlelemente gefüllt werden.

Verfügbar für Google Chat-Apps und nicht für Google Workspace-Add-ons. Für multi_select_data_source ist nur einer der folgenden Werte zulässig:
externalDataSource

Action

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

PlatformDataSource

Eine Datenquelle aus Google Workspace.

PlatformDataSource

Bei einem SelectionInput-Widget mit Mehrfachauswahl-Menü eine Datenquelle aus Google Workspace. Wird zum Füllen von Elementen in einem Mehrfachauswahlmenü verwendet.

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

Felder
Union-Feld data_source. Die Datenquelle. Für data_source ist nur einer der folgenden Werte zulässig:
commonDataSource

CommonDataSource

Eine Datenquelle, die von allen Google Workspace-Anwendungen freigegeben wird, z. B. Nutzern in einer Google Workspace-Organisation.
hostAppDataSource

HostAppDataSourceMarkup

Eine Datenquelle, die für eine Google Workspace-Hostanwendung eindeutig 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.

CommonDataSource

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

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

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

SelectionItem

Ein Element, das Nutzer in einer Auswahleingabe auswählen können, z. B. ein Kästchen oder einen Schalter.

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

Felder
text

string

Der Text, mit dem der Artikel für Nutzer identifiziert oder beschrieben wird.
value

string

Der mit diesem Element verknüpfte Wert. Der Client sollte diesen Wert als Eingabewert für das Formular verwenden.

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

bool

Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn in der Auswahl nur ein Wert zulässig ist (z. B. für Optionsfelder oder ein Dropdown-Menü), legen Sie dieses Feld nur für ein Element fest.
startIconUri

string

Bei Menüs mit Mehrfachauswahl die URL für das Symbol, das neben dem Feld text des Elements angezeigt wird. Unterstützt PNG- und JPEG-Dateien. Muss eine HTTPS-URL sein. Beispiel: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
bottomText

string

Bei Menüs mit Mehrfachauswahl eine Textbeschreibung oder ein Label, das unter dem Feld text des Elements angezeigt wird.

SelectionType

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

Jede Auswahleingabe unterstützt einen Auswahltyp. Die Kombination 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 Mehrere Kästchen. Nutzer können ein oder mehrere Kästchen anklicken.
RADIO_BUTTON Mehrere Optionsfelder. 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.
MULTI_SELECT

Ein Mehrfachauswahl-Menü für statische oder dynamische Daten. In der Menüleiste wählen Nutzer ein oder mehrere Elemente aus. Nutzer können auch Werte eingeben, um dynamische Daten zu füllen. Nutzer können beispielsweise mit der Eingabe des Namens eines Google Chat-Bereichs beginnen und das Widget schlägt den Gruppenbereich automatisch vor.

Wenn Sie Elemente in einem Mehrfachauswahlmenü füllen möchten, können Sie einen der folgenden Datenquellentypen verwenden:

  • Statische Daten: Elemente werden im Widget als SelectionItem-Objekte angegeben. Bis zu 100 Elemente.
  • Google Workspace-Daten: Elemente werden anhand von Daten aus Google Workspace gefüllt, z. B. aus Google Workspace-Nutzern oder Google Chat-Gruppenbereichen.
  • Externe Daten: Elemente werden aus einer externen Datenquelle außerhalb von Google Workspace übernommen.

Beispiele für die Implementierung von Menüs mit Mehrfachauswahl finden Sie unter Mehrfachauswahlmenü hinzufügen.

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

SubmitFormResponse

Eine Antwort auf eine Formulareinreichung mit Ausnahme des Abrufs eines Containers zur automatischen Vervollständigung, der die Aktionen enthält, die die Karte ausführen soll und/oder die Add-on-Host-App ausführen soll und ob sich der Status der Karte geändert hat.

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

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Felder
renderActions

RenderActions

Eine Reihe von Renderinganweisungen, mit denen die Karte aufgefordert wird, eine Aktion auszuführen, und/oder die Add-on-Host-App aufgefordert wird, eine appspezifische Aktion auszuführen.
stateChanged

bool

Gibt an, ob sich der Status der Karten geändert hat und die Daten in den vorhandenen Karten veraltet sind.
schema

string

Dies ist ein No-Op-Schemafeld, das möglicherweise in der Auszeichnung für die Syntaxprüfung vorhanden ist.

Vorschläge

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzende in das Texteingabefeld klicken. Während die Nutzer tippen, werden die vorgeschlagenen Werte dynamisch gefiltert, damit sie den Eingaben der Nutzer entsprechen.

Ein Texteingabefeld für eine Programmiersprache könnte beispielsweise Java, JavaScript, Python und C++ vorschlagen. Wenn Nutzer mit der Eingabe von Jav beginnen, werden in der Liste der Vorschläge Java und JavaScript angezeigt.

Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die für Ihre App sinnvoll sind. Wenn auf JavaScript verwiesen wird, geben einige Nutzer möglicherweise javascript und andere java script ein. Wenn du JavaScript vorschlägst, kannst du standardisieren, wie Nutzer mit deiner App interagieren.

Wenn dieses Flag angegeben ist, ist TextInput.type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE gesetzt ist.

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

Felder
items[]

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.

Felder

Union-Feld content.

Für content ist nur einer der folgenden Werte zulässig:
text

string

Der Wert einer vorgeschlagenen Eingabe für ein Texteingabefeld. Dies entspricht den Angaben, die Nutzer selbst eingeben.

TextInput

Ein Feld, in das Nutzer Text eingeben können. Unterstützt Vorschläge und Aktionen bei Änderungen. Ein Beispiel für Google Chat-Apps finden Sie im Hilfeartikel Feld hinzufügen, in das Nutzer Text eingeben können.

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

Wenn Sie nicht definierte oder abstrakte Daten von Nutzenden erfassen müssen, verwenden Sie eine Texteingabe. Mit dem SelectionInput-Widget können Sie definierte oder aufgezählte Daten von Nutzern erheben.

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

Felder
name

string

Der Name, mit 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 ein, der dem Nutzer die Eingabe der Informationen erleichtert, die Ihre App benötigt. Wenn du beispielsweise den Namen einer Person fragst, aber den Nachnamen benötigst, schreibe surname statt name.

Erforderlich, wenn hintText nicht angegeben ist. Ansonsten optional.
hintText

string

Text, der unter dem Texteingabefeld erscheint und Nutzer auffordern soll, einen bestimmten Wert einzugeben. Dieser Text ist immer sichtbar.

Erforderlich, wenn label nicht angegeben ist. Ansonsten 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

Type

Darstellung eines Texteingabefelds auf der Benutzeroberfläche. z. B. ob das Feld ein- oder mehrzeilig ist.
onChangeAction

Action

Vorgehensweise bei einer Änderung im Texteingabefeld Beispiel: Ein Nutzer fügt dem Feld etwas hinzu oder löscht Text.

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

Suggestions

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzende in das Texteingabefeld klicken. Während die Nutzer tippen, werden die vorgeschlagenen Werte dynamisch gefiltert, damit sie den Eingaben der Nutzer entsprechen.

Ein Texteingabefeld für eine Programmiersprache könnte beispielsweise Java, JavaScript, Python und C++ vorschlagen. Wenn Nutzer mit der Eingabe von Jav beginnen, werden in der Liste der Vorschläge nur Java und JavaScript angezeigt.

Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die für Ihre App sinnvoll sind. Wenn auf JavaScript verwiesen wird, geben einige Nutzer möglicherweise javascript und andere java script ein. Wenn du JavaScript vorschlägst, kannst du standardisieren, wie Nutzer mit deiner App interagieren.

Wenn dieses Flag angegeben ist, ist TextInput.type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE gesetzt ist.

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

Action

Optional. Geben Sie an, welche Aktion ausgeführt werden soll, wenn das Texteingabefeld Vorschläge für Nutzer enthält, die damit interagieren.

Wenn Sie nichts angeben, werden die Vorschläge von initialSuggestions festgelegt und vom Client verarbeitet.

Wenn angegeben, führt die App die hier angegebene Aktion aus, z. B. das Ausführen einer benutzerdefinierten Funktion.

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

Validation

Gib die für dieses Texteingabefeld erforderliche Validierung an.

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

string

Text, der im Texteingabefeld erscheint, 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 für Google Workspace-Add-ons.

Typ

Darstellung eines Texteingabefelds auf der Benutzeroberfläche. Das kann beispielsweise ein einzeiliges Eingabefeld oder eine mehrzeilige Eingabe sein. Wenn initialSuggestions angegeben ist, ist type immer SINGLE_LINE, auch wenn es auf MULTIPLE_LINE gesetzt 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.

TextParagraph

Ein Textabschnitt, der die Formatierung unterstützt. Ein Beispiel für die Google Chat App 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.

Felder
text

string

Der Text, der im Widget angezeigt wird.
maxLines

int32

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

Der Standardwert ist 0, sodass der gesamte Kontext angezeigt wird. Negative Werte werden ignoriert. Verfügbar für Google Chat-Apps und nicht für Google Workspace-Add-ons.

Validierung

Die erforderlichen Daten zur Validierung des Widgets, mit dem es verbunden ist.

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

Felder
characterLimit

int32

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

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

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 aus der vom System bereitgestellten Emoji-Auswahl ausgewählt wurde.

Widget

Jede Karte besteht aus Widgets.

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

Felder
horizontalAlignment

HorizontalAlignment

Gibt an, ob Widgets links, rechts oder Mitte einer Spalte ausgerichtet werden.
Union-Feld data. Ein Widget kann nur eines der folgenden Elemente haben. Sie können mehrere Widget-Felder verwenden, um mehr Elemente anzuzeigen. Für data ist nur einer der folgenden Werte zulässig:
textParagraph

TextParagraph

Zeigt einen Textabschnitt 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.

Durch die folgende JSON-Datei wird beispielsweise ein fett formatierter Text erstellt:

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

Image

Zeigt ein Bild an.

Die folgende JSON-Datei erstellt beispielsweise ein Bild mit alternativem Text:

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

DecoratedText

Zeigt einen dekorierten Textgegenstand an.

Mit der folgenden JSON-Datei wird beispielsweise ein Widget mit dekoriertem Text erstellt, das die E-Mail-Adresse anzeigt:

"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

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

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"
}

Als weiteres Beispiel erstellt die folgende JSON-Datei eine Texteingabe für eine Programmiersprache mit statischen Vorschlägen:

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

SelectionInput

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

Mit der folgenden JSON 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

DateTimePicker

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

Mit der folgenden JSON-Datei wird beispielsweise eine Datums-/Uhrzeitauswahl zum Planen eines Termins erstellt:

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

Divider

Zeigt eine horizontale Trennlinie zwischen den Widgets an.

Die folgende JSON erstellt beispielsweise eine Trennlinie:

"divider": {
}
grid

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.

Die folgende JSON erstellt beispielsweise ein zweispaltiges Raster mit einem einzelnen Element:

"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

Columns

Es werden bis zu zwei Spalten angezeigt.

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

Mit der folgenden JSON-Datei 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"
          }
        }
      ]
    }
  ]
}
chipList

ChipList

Eine Liste mit Chips.

Mit der folgenden JSON-Datei werden beispielsweise zwei Chips erstellt. Der erste ist ein Textchip und der zweite ein Symbolchip, über den ein Link geöffnet wird:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

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

HorizontalAlignment

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

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

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

ImageType

Die Form, die zum Zuschneiden des Bildes verwendet wird.

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

Enums
SQUARE Standardwert. Wendet eine quadratische Maske auf das Bild an. Ein 4 x 3-Bild wird beispielsweise zu 3 x 3.
CIRCLE Wendet eine runde Maske auf das Bild an. Beispielsweise wird ein 4x3-Bild zu einem Kreis mit einem Durchmesser von 3.