Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

Die Überschrift der Karte. Eine Kopfzeile enthält normalerweise ein vorangestelltes Bild und einen Titel. Überschriften werden immer oben auf einer Karte angezeigt.

object (Section)

Enthält eine Sammlung von Widgets. Jeder Bereich hat eine eigene optionale Überschrift. Die einzelnen Abschnitte sind durch eine Trennlinie voneinander getrennt. Ein Beispiel in Google Chat-Apps findest du im Abschnitt „Karten“.

enum (DividerStyle)

Der Trennungsstil zwischen Abschnitten.

object (CardAction)

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

Da Chat-App-Karten keine Symbolleiste haben, wird cardActions[] in Chat-Apps nicht unterstützt.

Mit der folgenden JSON-Datei wird beispielsweise ein Kartenaktionsmenü 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"
      }
    }
  }
]

string

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

Da Chat-Apps keine Kartennavigation unterstützen, wird dieses Feld ignoriert.

object (CardFixedFooter)

Die feste Fußzeile, die unten auf dieser Karte angezeigt wird.

Wenn Sie fixedFooter ohne Angabe von primaryButton oder secondaryButton festlegen, verursacht dies einen Fehler.

Unterstützt von Google Workspace-Add-ons und Chat-Apps. Für Chat-Apps können Sie feste Fußzeilen in Dialogfeldern verwenden, aber keine Kartennachrichten.

enum (DisplayStyle)

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

Wird von Chat-Apps nicht unterstützt.

object (CardHeader)

Bei der Anzeige von kontextbezogenen Inhalten fungiert die Peek-Kartenüberschrift als Platzhalter, sodass der Nutzer vorwärts zwischen den Startseitenkarten und den Kontextkarten navigieren kann.

Wird von Chat-Apps nicht unterstützt.

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

Erforderlich. Der Titel der Kartenüberschrift. Die Kopfzeile hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben sind, wird jeweils eine Zeile eingenommen. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen in Anspruch.

string

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

enum (ImageType)

Die Form, die zum Zuschneiden des Bildes verwendet wird.

string

Die HTTPS-URL des Bildes im Kartenheader.

string

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

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer
}

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-Anwendungen formatieren und Text in Google Workspace-Add-ons formatieren.

object (Widget)

Alle Widgets in diesem Bereich. Muss mindestens ein Widget enthalten.

boolean

Gibt an, ob dieser Abschnitt minimierbar ist.

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

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

integer

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

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.

{
  "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)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

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

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-Anwendungen formatieren und Text in Google Workspace-Add-ons formatieren.

Mit der folgenden JSON-Datei wird beispielsweise ein fett formatierter Text erstellt:

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

object (Image)

Zeigt ein Bild an.

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

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

object (DecoratedText)

Zeigt ein dekoriertes Textelement an.

Mit dem folgenden JSON-Code 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"
  }
}

object (ButtonList)

Eine Liste mit Schaltflächen.

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

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

object (TextInput)

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

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

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

Als weiteres Beispiel wird mit dem folgenden JSON-Code 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"
      }
    ]
  }
}

object (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-Datei 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
    }
  ]
}

object (DateTimePicker)

Zeigt ein Widget an, in das Benutzer ein Datum, eine Uhrzeit oder ein Datum und eine Uhrzeit eingeben können.

Mit der folgenden JSON-Datei wird beispielsweise eine Datums- und Zeitauswahl erstellt, um einen Termin zu planen:

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

object (Divider)

Zeigt eine horizontale Trennlinie zwischen Widgets an

Mit der folgenden JSON-Datei wird beispielsweise eine Trennlinie erstellt:

"divider": {
}

object (Grid)

Zeigt ein Raster mit mehreren Elementen an.

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

Mit der folgenden JSON-Datei wird beispielsweise ein zweispaltiges Raster mit 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"
    }
  }
}

object (Columns)

Es können bis zu zwei Spalten angezeigt werden.

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

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

{
  "text": string
}

string

Der Text, der im Widget angezeigt wird.

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

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

Beispiel:

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

object (OnClick)

Wenn ein Nutzer auf das Bild klickt, wird diese Aktion durch den Klick ausgelöst.

string

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

{

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

object (Action)

Wenn angegeben, wird durch diese onClick eine Aktion ausgelöst.

object (OpenLink)

Wenn angegeben, löst diese onClick eine Aktion zum Öffnen von Links aus.

object (Action)

Ein Add-on löst diese Aktion aus, wenn durch die Aktion ein Link geöffnet werden muss. Dies unterscheidet sich vom obigen openLink dadurch, dass dieser mit dem Server kommunizieren muss, um den Link zu erhalten. Daher muss der Webclient einige Vorbereitungen treffen, bevor die Antwort auf die Aktion für den offenen Link zurückgegeben wird. Unterstützt von Google Workspace-Add-ons, aber nicht von Google Chat-Apps.

object (Card)

Sofern angegeben, wird nach dem Anklicken eine neue Karte auf den Kartenstapel verschoben.

Unterstützt von Google Workspace-Add-ons, aber nicht von Google Chat-Apps.

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

string

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

Beispiele für die Verwendung finden Sie unter Interaktive Karten erstellen.

object (ActionParameter)

Liste der Aktionsparameter.

enum (LoadIndicator)

Gibt die Ladeanzeige an, die während des Aufrufs der Aktion eingeblendet wird.

boolean

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

Bei true bleiben Formularwerte erhalten, nachdem die Aktion ausgelöst wurde. Damit der Nutzer Änderungen vornehmen kann, während die Aktion verarbeitet wird, setzen Sie LoadIndicator auf NONE. Bei Kartennachrichten in Chat-Apps müssen Sie auch ResponseType der Aktion auf UPDATE_MESSAGE setzen und denselben cardId von der Karte verwenden, die die Aktion enthielt.

Bei false werden die Formularwerte beim Auslösen der Aktion gelöscht. Wenn du verhindern möchtest, dass der Nutzer Änderungen vornimmt, während die Aktion verarbeitet wird, setze LoadIndicator auf SPINNER.

enum (Interaction)

Optional. Erforderlich beim Öffnen eines Dialogfelds.

Vorgehensweise als Reaktion auf eine Interaktion mit einem Nutzer, z. B. wenn er auf eine Schaltfläche in einer Kartennachricht klickt

Wenn kein Wert angegeben ist, antwortet die Anwendung wie gewohnt mit einem action, z. B. Öffnen eines Links oder Ausführen einer Funktion.

Durch Angabe eines interaction kann die App auf spezielle interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG setzen, kann in der Anwendung ein Dialogfeld geöffnet werden. Wenn angegeben, wird kein Ladeindikator angezeigt.

Von Chat-Apps unterstützt, aber nicht von Google Workspace-Add-ons. Wenn dies für ein Add-on angegeben wird, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

{
  "key": string,
  "value": string
}

string

Der Name des Parameters für das Aktionsskript.

string

Wert des Parameters.

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

string

Die zu öffnende URL.

enum (OpenAs)

So öffnen Sie einen Link: Wird von Chat-Apps nicht unterstützt.

enum (OnClose)

Gibt an, ob der Client einen Link nach dem Öffnen vergisst oder bis zum Schließen des Fensters beobachtet. Wird von Chat-Apps nicht unterstützt.

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "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.
}

object (Icon)

Zugunsten von startIcon verworfen.

object (Icon)

Das Symbol vor dem Text

string

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

string

Erforderlich. Der Haupttext.

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

boolean

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

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

string

Der Text, der unter text angezeigt wird. Umschließt immer.

object (OnClick)

Diese Aktion wird ausgelöst, wenn Nutzer auf topLabel oder bottomLabel klicken.

object (Button)

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

object (SwitchControl)

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

object (Icon)

Ein Symbol, das nach dem Text angezeigt wird.

Unterstützt integrierte und benutzerdefinierte Symbole.

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string
  // End of list of possible types for union field icons.
}

string

Optional. Eine Beschreibung des Symbols, die für die Barrierefreiheit verwendet wird. Wenn kein Wert angegeben ist, wird der Standardwert Button angegeben. Als Best Practice empfiehlt es sich, eine hilfreiche Beschreibung für den Inhalt des Symbols und gegebenenfalls dessen Funktion festzulegen. 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/chat.

Wenn das Symbol in einem Button festgelegt ist, wird altText als Hilfstext angezeigt, wenn der Nutzer den Mauszeiger auf die Schaltfläche bewegt. Wenn durch die Schaltfläche jedoch auch text festgelegt wird, wird der altText des Symbols ignoriert.

enum (ImageType)

Der Zuschneidestil, der auf das Bild angewendet wird. In einigen Fällen führt ein CIRCLE-Zuschneiden dazu, dass das Bild größer als ein integriertes Symbol gezeichnet wird.

string

Zeigen Sie eines der integrierten Symbole von Google Workspace an.

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.

string

Benutzerdefiniertes Symbol anzeigen, das unter einer HTTPS-URL gehostet wird

Beispiel:

"iconUrl":
"https://developers.google.com/chat/images/quickstart-app-avatar.png"

Unterstützte Dateitypen sind .png und .jpg.

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}

string

Der Text, der in der Schaltfläche angezeigt wird.

object (Icon)

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

object (Color)

Wenn diese Option aktiviert ist, wird die Schaltfläche mit einer einfarbigen Hintergrundfarbe gefüllt und die Schriftfarbe ändert sich, um den Kontrast zur Hintergrundfarbe aufrechtzuerhalten. Wenn Sie beispielsweise einen blauen Hintergrund festlegen, wird wahrscheinlich weißer Text angezeigt.

Wenn die Richtlinie nicht konfiguriert ist, ist der Bildhintergrund weiß und die Schriftfarbe Blau.

Bei Rot, Grün und Blau ist der Wert jedes Feldes eine float-Zahl, die Sie auf zwei Arten ausdrücken können: als Zahl zwischen 0 und 255 geteilt durch 255 (153/255) oder als Wert zwischen 0 und 1 (0,6). 0 steht für das Fehlen einer Farbe und 1 oder 255/255 für das vollständige Vorhandensein dieser Farbe auf der RGB-Skala.

Legen Sie optional alpha fest. Damit wird mithilfe der folgenden Gleichung ein Grad an Transparenz festgelegt:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Für alpha entspricht der Wert 1 einer Volltonfarbe und ein Wert von 0 einer vollständig transparenten Farbe.

Die folgende Farbe stellt beispielsweise ein halbtransparentes Rot dar:

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

object (OnClick)

Erforderlich. Die Aktion, die ausgeführt werden soll, wenn ein Nutzer auf die Schaltfläche klickt, wie z. B. das Öffnen eines Hyperlinks oder das Ausführen einer benutzerdefinierten Funktion.

boolean

Bei true wird die Schaltfläche inaktiv angezeigt und reagiert nicht auf Nutzeraktionen.

string

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

Legen Sie einen beschreibenden Text fest, der die Nutzenden über die Funktion der Schaltfläche informiert. Wenn beispielsweise über eine Schaltfläche ein Hyperlink geöffnet wird, können Sie Folgendes schreiben: „Öffnet einen neuen Browsertab und navigiert zur Google Chat-Entwicklerdokumentation unter https://developers.google.com/chat.

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

Der Rotanteil der Farbe als Wert im Intervall [0, 1].

number

Der Grünanteil der Farbe als Wert im Intervall [0, 1].

number

Der Blauanteil der Farbe als Wert im Intervall [0, 1].

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 dieses Farbobjekt nicht angegeben wird, wird es als Vollton dargestellt, als ob dem Alpha-Wert explizit der Wert 1,0 gegeben worden wäre.

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

string

Der Name, durch den das Schalter-Widget in einem Formulareingabeereignis identifiziert wird.

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

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.

boolean

Wenn true ausgewählt ist, ist der Schalter ausgewählt.

object (Action)

Die auszuführende Aktion, wenn sich der Schalterstatus ändert, z. B. die auszuführende Funktion.

enum (ControlType)

Wie der Schalter in der Benutzeroberfläche angezeigt wird

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

Ein Array mit Schaltflächen.

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

string

Der Name, anhand dessen die Texteingabe in einem Formulareingabeereignis identifiziert wird.

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

string

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

Geben Sie Text an, mit dem der Nutzer die Informationen eingeben kann, die Ihre App benötigt. Wenn Sie beispielsweise nach dem Namen einer Person fragen, aber ausdrücklich nach ihrem Nachnamen suchen, schreiben Sie surname anstelle von name.

Erforderlich, wenn hintText nicht angegeben ist. Optional.

string

Text, der unterhalb des Texteingabefelds erscheint und Nutzende zur Eingabe eines bestimmten Werts auffordert. Dieser Text ist immer sichtbar.

Erforderlich, wenn label nicht angegeben ist. Optional.

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.

enum (Type)

Wie ein Texteingabefeld in der Benutzeroberfläche angezeigt wird. Geben Sie beispielsweise an, ob das Feld einzeilig oder mehrzeilig ist.

object (Action)

Vorgehensweise bei einer Änderung im Texteingabefeld Das kann beispielsweise der Fall sein, wenn ein Nutzer etwas in ein Feld einfügt oder Text löscht.

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

object (Suggestions)

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Benutzer in das Texteingabefeld klicken. Während der Eingabe werden die vorgeschlagenen Werte dynamisch gefiltert, damit sie dem entsprechen, was sie eingegeben haben.

Ein Texteingabefeld für eine Programmiersprache kann beispielsweise Java, JavaScript, Python und C++ vorschlagen. Wenn Nutzer beginnen, Jav einzugeben, wird die Liste der Vorschläge so gefiltert, dass nur Java und JavaScript angezeigt werden.

Vorgeschlagene Werte helfen Nutzern dabei, Werte einzugeben, die Ihre App verständlich ist. Wenn von JavaScript verwiesen wird, geben einige Nutzer möglicherweise javascript und andere java script ein. Durch den Vorschlag von JavaScript kann die Interaktion von Nutzern mit deiner App standardisiert werden.

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

object (Action)

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

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

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

Unterstützt von Google Workspace-Add-ons, aber nicht von Google Chat-Apps.

string

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

Von Google Chat-Apps unterstützt, aber nicht von Google Workspace-Add-ons.

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

Eine Liste von Vorschlägen, die für automatisch vervollständigte Empfehlungen in Texteingabefeldern verwendet werden.

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

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

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

string

Der Name, der die Auswahleingabe in einem Formulareingabeereignis identifiziert.

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

string

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

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

enum (SelectionType)

Der Elementtyp, der Nutzern in einem SelectionInput-Widget angezeigt wird. Bei Auswahltypen werden verschiedene Arten von Interaktionen unterstützt. Nutzende können beispielsweise ein oder mehrere Kontrollkästchen auswählen, aber sie können nur einen Wert aus einem Dropdown-Menü auswählen.

object (SelectionItem)

Ein Array aus auswählbaren Elementen. Beispiel: ein Array mit Optionsfeldern oder Kontrollkästchen. Unterstützt bis zu 100 Artikel.

object (Action)

Wenn angegeben, wird das Formular gesendet, wenn sich die Auswahl ändert. Falls 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.

integer

Bei Mehrfachauswahl-Menüs ist dies die maximale Anzahl von Elementen, die ein Nutzer auswählen kann. Der Mindestwert beträgt 1 Element. Wenn nicht angegeben, legen Sie 3 Elemente fest.

integer

Bei Mehrfachauswahl-Menüs die Anzahl der Textzeichen, die ein Nutzer eingibt, bevor die Chat-App Abfragen ausführt und vorgeschlagene Elemente auf der Karte angezeigt werden.

Wenn Sie nichts angeben, legen Sie für statische Datenquellen 0 Zeichen und für externe Datenquellen 3 Zeichen fest.

object (Action)

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

object (PlatformDataSource)

Eine Datenquelle aus einer Google Workspace-Hostanwendung.

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

Der Text, der den Artikel für Nutzende identifiziert oder beschreibt.

string

Der mit diesem Element verknüpfte Wert. Der Client sollte diesen Wert als Formulareingabewert verwenden.

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

boolean

Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn die Auswahleingabe nur einen Wert akzeptiert (z. B. für Optionsfelder oder ein Dropdown-Menü), legen Sie dieses Feld nur für ein Element fest.

string

Bei Mehrfachauswahl-Menüs 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/chat/images/quickstart-app-avatar.png.

string

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

{

  // 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.
}

enum (CommonDataSource)

Für ein SelectionInput-Widget, das ein Mehrfachauswahl-Menü verwendet, eine Datenquelle, die von allen Google Workspace-Hostanwendungen freigegeben wird, z. B. Nutzer in einer Google Workspace-Organisation.

object (HostAppDataSourceMarkup)

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

{

  // 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.
}

object (ChatClientDataSourceMarkup)

Die Datenquelle ist Google Chat.

{

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

object (SpaceDataSource)

Eine Datenquelle, die einen Google Chat-Bereich darstellt.

Format: Leerzeichen/{Leerzeichen}

{
  "defaultToCurrentSpace": boolean
}

boolean

Bei true wird der Google Chat-Bereich der Karte als Standardauswahl verwendet. Der Standardwert ist false.

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

string

Der Name, durch den die DateTimePicker in einem Formulareingabeereignis identifiziert wird.

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

string

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

enum (DateTimePickerType)

Gibt an, ob das Widget die Eingabe eines Datums, einer Uhrzeit oder des Datums und der Uhrzeit unterstützt.

string (int64 format)

Der im Widget angezeigte Standardwert in Millisekunden seit der UNIX-Epoche.

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

• DATE_AND_TIME: ein Kalenderdatum und eine Kalenderzeit 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 Wenn Sie beispielsweise den 1. Januar 2023 darstellen möchten, verwenden Sie 1672531200000.
• TIME_ONLY: eine Zeit in UTC Wenn Sie beispielsweise 12:00 Uhr darstellen möchten, verwenden Sie 43200000 (oder 12 * 60 * 60 * 1000).

integer

Die Zahl in Minuten, die den Zeitzonenunterschied zur koordinierten Weltzeit (UTC) angibt. Wenn festgelegt, wird valueMsEpoch in der angegebenen Zeitzone angezeigt. Wenn kein Wert festgelegt ist, wird standardmäßig die Zeitzone des Nutzers verwendet.

object (Action)

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

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

Der Text, der in der Rasterüberschrift angezeigt wird.

object (GridItem)

Die Elemente, die im Raster angezeigt werden sollen.

object (BorderStyle)

Der Rahmenstil, der auf jedes Rasterelement angewendet wird.

integer

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

object (OnClick)

Dieser Callback wird von jedem einzelnen Rasterelement wiederverwendet, allerdings werden die ID und der Index des Elements aus der Elementliste zu den Callback-Parametern hinzugefügt.

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

string

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

object (ImageComponent)

Das Bild, das im Rasterelement angezeigt wird.

string

Der Titel des Rasterelements.

string

Der Untertitel des Rasterelements.

enum (GridItemLayout)

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

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

Die Bild-URL.

string

Das Bedienungshilfen-Label für das Bild.

object (ImageCropStyle)

Der Zuschneidestil, der auf das Bild angewendet werden soll.

object (BorderStyle)

Der Rahmenstil, der auf das Bild angewendet werden soll.

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

Der Zuschnitttyp.

number

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

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

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

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

Der Rahmentyp.

object (Color)

Die zu verwendenden Farben, wenn der Typ BORDER_TYPE_STROKE ist.

integer

Der Eckenradius für die Rahmenlinie.

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

Ein Array von Spalten. Sie können einer Karte oder einem Dialogfeld bis zu zwei Spalten hinzufügen.

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

Gibt an, ob Widgets am oberen oder unteren Rand oder in der Mitte einer Spalte ausgerichtet werden.

object (Widgets)

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

{

  // 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)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph.

object (Image)

Image.

object (DecoratedText)

DecoratedText.

object (ButtonList)

ButtonList.

object (TextInput)

TextInput.

object (SelectionInput)

SelectionInput.

object (DateTimePicker)

DateTimePicker.

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

string

Das Label, das als Element im Aktionsmenü angezeigt wird.

object (OnClick)

Die Aktion onClick für diese Aufgabe.

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

Die Hauptschaltfläche der festen Fußzeile. Bei der Schaltfläche muss es sich um eine Textschaltfläche mit Text- und Farbeinstellung handeln.

object (Button)

Die sekundäre Schaltfläche der festen Fußzeile. Bei der Schaltfläche muss es sich um eine Textschaltfläche mit Text- und Farbeinstellung handeln. Wenn secondaryButton festgelegt ist, müssen Sie auch primaryButton festlegen.