Package google.apps.card.v1

string

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

Anwendungsbeispiele finden Sie unter Formulardaten lesen.

ActionParameter

Liste der Aktionsparameter.

LoadIndicator

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

bool

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

Bei true bleiben die Formularwerte nach dem Auslösen der Aktion erhalten. Wenn der Nutzer während der Verarbeitung der Aktion Änderungen vornehmen soll, legen Sie LoadIndicator auf NONE fest. 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.

Bei 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

Optional. Erforderlich, wenn ein Dialogfeld geöffnet wird.

Was soll bei einer Nutzerinteraktion passieren, z. B. wenn ein Nutzer auf eine Schaltfläche in einer Kartennachricht klickt?

Wenn Sie keine Angabe machen, führt die App wie gewohnt eine action aus, z. B. öffnet sie einen Link oder führt eine Funktion aus.

Durch Angabe eines interaction kann die App auf besondere interaktive Weise reagieren. Wenn Sie beispielsweise interaction auf OPEN_DIALOG festlegen, kann die App ein Dialogfeld öffnen. Wenn diese Option angegeben ist, wird keine Ladeanzeige angezeigt. Wenn dies für ein Add-on angegeben ist, wird die gesamte Karte entfernt und im Client wird nichts angezeigt.

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

string

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

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

bool

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

string

Der Name des Parameters für das Aktionsscript.

string

Wert des Parameters.

BorderType

Der Rahmentyp.

Color

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

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

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.

int32

Der Eckenradius für den Rahmen.

string

Der auf der Schaltfläche angezeigte Text.

Icon

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

Color

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 die Schaltfläche beispielsweise blau ist, sind alle Texte oder Symbole auf der Schaltfläche weiß.

Geben Sie einen Wert für die Felder red, green und blue an, um die Schaltflächenfarbe festzulegen. Der Wert muss eine Gleitkommazahl zwischen 0 und 1 sein, die auf dem RGB-Farbwert basiert. Dabei steht 0 (0/255) für das Fehlen von Farbe und 1 (255/255) für die maximale Intensität der Farbe.

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

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

bool

Bei true wird die Schaltfläche in einem inaktiven Zustand angezeigt und reagiert nicht auf Nutzeraktionen.

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

Optional. Der Typ einer Schaltfläche. Wenn nicht festgelegt, ist der Standardwert für den Schaltflächentyp OUTLINED. Wenn das Feld color festgelegt ist, wird der Schaltflächentyp auf FILLED festgelegt und alle für dieses Feld festgelegten Werte werden ignoriert.

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

Button

Mehrere Schaltflächen

CardHeader

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

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 Bereich einer Karte definieren.

DividerStyle

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

CardAction

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

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

Im folgenden JSON-Code wird beispielsweise ein Kartenaktionsmenü mit den Optionen Settings und Send Feedback erstellt:

"card_actions": [
  {
    "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 als Karten-ID in der Kartennavigation verwendet.

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

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

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

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

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.

string

Das Label, das als Menüpunkt angezeigt wird.

OnClick

Die onClick-Aktion für dieses Aufgabenelement.

Button

Die primäre Schaltfläche der festen Fußzeile. Die Schaltfläche muss eine Textschaltfläche mit festgelegtem Text und Farbe sein.

Button

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

string

Erforderlich. Der Titel der Kartenüberschrift. Die Überschrift hat eine feste Höhe: Wenn sowohl ein Titel als auch ein Untertitel angegeben werden, nimmt jeder eine Zeile ein. Wenn nur der Titel angegeben ist, nimmt er beide Zeilen ein.

string

Der Untertitel der Kartenüberschrift. Erscheint in einer eigenen Zeile unterhalb von title.

ImageType

Die Form, die zum Zuschneiden des Bildes verwendet wird.

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

string

Die HTTPS-URL des Bildes in der Kartenüberschrift.

string

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

string

Text, der oben in einem Abschnitt angezeigt wird. Unterstützt einfachen HTML-Text. Weitere Informationen zum Formatieren von Text finden Sie unter Text in Google Chat-Apps formatieren und Text in Google Workspace-Add-ons formatieren.

Widget

Alle Widgets im Abschnitt. Muss mindestens ein Widget enthalten.

bool

Gibt an, ob dieser Bereich minimierbar ist.

In minimierten Abschnitten sind einige oder alle Widgets ausgeblendet. Nutzer können den Abschnitt maximieren, um die ausgeblendeten Widgets zu sehen. Dazu klicken sie auf Mehr anzeigen. Nutzer können die Widgets wieder ausblenden, indem sie auf Weniger anzeigen klicken.

Geben Sie uncollapsibleWidgetsCount an, um festzustellen, welche Widgets ausgeblendet sind.

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

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

Icon

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

string

Der Text, der im Chip angezeigt wird.

OnClick

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

bool

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

bool

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

string

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

Geben Sie einen beschreibenden Text an, der Nutzern mitteilt, wozu der Chip dient. Wenn ein Chip beispielsweise einen Hyperlink öffnet, schreiben Sie: „Öffnet einen neuen Browsertab und wechselt zur Google Chat-Entwicklerdokumentation unter https://developers.google.com/workspace/chat".

Layout

Angegebenes Layout der Chipliste.

Chip

Ein Array von Chips.

HorizontalAlignment

Die horizontale Ausrichtung der Schaltfläche zum Maximieren/Minimieren.

Button

Optional. Definieren Sie eine anpassbare Schaltfläche, um den Bereich zu maximieren. Sowohl das Feld „expand_button“ als auch das Feld „collapse_button“ müssen festgelegt sein. Nur ein Feldsatz wird nicht wirksam. Ist dieses Feld nicht festgelegt, wird die Standardschaltfläche verwendet.

Button

Optional. Definieren Sie eine anpassbare Schaltfläche, um den Abschnitt zu minimieren. Die Felder "expand_button" und "min_button" müssen festgelegt werden. Nur ein Feldsatz wird nicht übernommen. Wenn dieses Feld nicht festgelegt ist, wird die Standardschaltfläche verwendet.

Column

Ein Array von Spalten. Sie können eine Karte oder ein Dialogfeld mit bis zu zwei Spalten versehen.

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

Widget TextParagraph

Image

Widget Image

DecoratedText

Widget DecoratedText

ButtonList

Widget ButtonList

TextInput

Widget TextInput

SelectionInput

Widget SelectionInput

DateTimePicker

Widget DateTimePicker

ChipList

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

string

Der Name, mit dem die DateTimePicker in einem Ereignis für Formulareingaben identifiziert wird.

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

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.

DateTimePickerType

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

int64

Der im Widget angezeigte Standardwert in Millisekunden seit der Unixzeit.

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

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

int32

Die Zahl, die den Zeitzonen-Unterschied zu UTC in Minuten angibt. Wenn diese Option festgelegt ist, wird value_ms_epoch in der angegebenen Zeitzone angezeigt. Wenn der Wert nicht festgelegt ist, wird standardmäßig die Zeitzone des Nutzers verwendet.

Action

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

Validation

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

Icon

Wurde zugunsten von startIcon verworfen.

Icon

Das Symbol, das vor dem Text angezeigt wird.

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

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.

string

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

OnClick

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

Button

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

SwitchControl

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

Icon

Ein Symbol, das nach dem Text angezeigt wird.

Unterstützt integrierte und benutzerdefinierte Symbole.

string

Der Name, mit dem das Schalter-Widget in einem Ereignis für die Formulareingabe identifiziert wird.

Weitere Informationen zum Arbeiten mit Formularinputs 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 Formularinputs finden Sie unter Formulardaten empfangen.

bool

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

Action

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

ControlType

Wie der Schalter in der Benutzeroberfläche angezeigt wird.

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

string

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

GridItem

Die Elemente, die im Raster angezeigt werden sollen.

BorderStyle

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

int32

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

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.

string

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

ImageComponent

Das Bild, das im Rasterelement angezeigt wird.

string

Der Titel des Rasterelements.

string

Der Untertitel des Rasterelements.

GridItemLayout

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

string

Optional. Beschreibung des Symbols für Bedienungshilfen. Wenn kein Wert angegeben ist, wird der Standardwert Button verwendet. 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

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.

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 Vordefinierte Symbole.

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

Zeigen Sie eines der Material-Symbole von Google an.

Wenn Sie beispielsweise ein Kästchensymbol anzeigen möchten, verwenden Sie

"material_icon": {
  "name": "check_box"
}

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

string

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

Beispiel:

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

OnClick

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

string

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

string

Die Bild-URL.

string

Das Bedienungshilfen-Label für das Bild.

ImageCropStyle

Der Zuschnittsstil, der auf das Bild angewendet werden soll.

BorderStyle

Der Rahmenstil, der auf das Bild angewendet werden soll.

ImageCropType

Der Erntetyp.

double

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

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

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

string

Der im Material-Symbol von Google definierte Symbolname, z. B. check_box. Ungültige Namen werden verworfen und durch einen leeren String ersetzt, wodurch das Symbol nicht gerendert wird.

bool

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

Wenn Sie sich eine Vorschau verschiedener Symboleinstellungen ansehen möchten, rufen Sie Google Fonts-Symbole auf und passen Sie die Einstellungen unter Anpassen an.

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.

int32

Gewicht und Grad wirken sich auf die Stärke eines Symbols aus. Anpassungen der Farbtonung sind detaillierter als Anpassungen des Gewichts und haben nur geringe Auswirkungen auf die Größe des Symbols. Wählen Sie eine der folgenden Optionen aus: {-25, 0, 200}. Wenn nicht vorhanden, ist der Standardwert 0. Wird ein anderer Wert angegeben, wird der Standardwert verwendet.

Wenn Sie sich eine Vorschau verschiedener Symboleinstellungen ansehen möchten, rufen Sie Google Fonts-Symbole auf und passen Sie die Einstellungen unter Anpassen an.

Action

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

OpenLink

Wenn angegeben, löst „onClick“ eine Aktion zum Öffnen eines Links aus.

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, nicht für Google Chat-Apps.

Card

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

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

OverflowMenu

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

string

Die URL, die geöffnet werden soll.

OpenAs

So öffnen Sie einen Link.

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

OnClose

Ob der Kunde einen Link nach dem Öffnen vergisst oder ihn bis zum Schließen des Fensters beobachtet.

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

OverflowMenuItem

Erforderlich. Die Liste der Menüoptionen.

Icon

Das Symbol, das vor dem Text angezeigt wird.

string

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

OnClick

Erforderlich. Die Aktion, die ausgeführt 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.

bool

Ob die Menüoption deaktiviert ist. Die Standardeinstellung ist "false".

string

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

Weitere Informationen zum Arbeiten mit Formularinputs 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 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“.

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.

SelectionItem

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

Action

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

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.

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

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

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

Action

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

PlatformDataSource

Eine Datenquelle aus Google Workspace.

CommonDataSource

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

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.

string

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

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 Formularinputs finden Sie unter Formulardaten empfangen.

bool

Gibt an, ob das Element standardmäßig ausgewählt ist. Wenn für die Auswahl nur ein Wert zulässig ist (z. B. bei Optionsfeldern oder Drop-down-Menüs), legen Sie dieses Feld nur für einen Artikel fest.

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

string

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

SuggestionItem

Eine Liste mit Vorschlägen, die für Empfehlungen zur automatischen Vervollständigung in Texteingabefeldern verwendet werden.

string

Der Wert einer vorgeschlagenen Eingabe für ein Texteingabefeld. Das entspricht dem, was Nutzer selbst eingeben.

string

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

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

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. Andernfalls optional.

string

Text, der unter dem Texteingabefeld angezeigt wird, um Nutzer zu einem bestimmten Wert zu bewegen. Dieser Text ist immer sichtbar.

Erforderlich, wenn label nicht angegeben ist. Andernfalls optional.

string

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

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

Type

Wie ein Texteingabefeld in der Benutzeroberfläche angezeigt wird. Beispielsweise, ob es sich um ein einzelnes oder ein mehrzeiliges Feld handelt.

Action

Was passiert, wenn sich etwas im Textfeld ändert? Beispiel: Ein Nutzer fügt dem Feld etwas hinzu oder löscht Text.

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

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 es um JavaScript geht, geben manche Nutzer möglicherweise javascript und andere java script ein. Wenn du JavaScript vorschlägst, kannst du standardisieren, wie Nutzer mit deiner App interagieren.

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

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

Action

Optional. Geben Sie an, welche Aktion ausgeführt werden soll, wenn Nutzer, die mit dem Textfeld interagieren, Vorschläge erhalten.

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, nicht für Google Chat-Apps.

Validation

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

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

string

Der Text, der im Widget angezeigt wird.

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. Wenn der Text der angegebenen maximalen Anzahl von Zeilen entspricht oder kürzer ist, wird keine Schaltfläche Mehr anzeigen angezeigt.

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

int32

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

InputType

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

HorizontalAlignment

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

TextParagraph

Zeigt einen Textabschnitt an. Unterstützt einfachen HTML-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

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

Ein Textelement mit Verzierungen.

Mit der folgenden JSON-Datei wird beispielsweise ein bearbeitetes Text-Widget 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

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

Ein Textfeld, in das Nutzer etwas eingeben können.

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

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

Im folgenden JSON-Beispiel wird eine Texteingabe für eine Programmiersprache mit statischen Vorschlägen erstellt:

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

SelectionInput

Zeigt ein Auswahlsteuerelement an, mit dem Nutzer Elemente auswählen können. Auswahlsteuerelemente können Kontrollkästchen, Optionsfelder, Schalter oder Dropdown-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

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

Im folgenden JSON-Beispiel wird beispielsweise eine Datumsauswahl erstellt, um einen Termin zu planen:

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

Divider

Zwischen den Widgets wird eine horizontale Trennlinie angezeigt.

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

"divider": {
}

Grid

Ein Raster mit einer Sammlung von Elementen.

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

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

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

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

Columns

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 dem folgenden JSON-Code werden beispielsweise zwei Spalten erstellt, die jeweils Textabsätze enthalten:

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

ChipList

Eine Liste mit Chips.

Mit der folgenden JSON-Datei werden beispielsweise zwei Chips erstellt. Der erste ist ein Text-Chip und der zweite ein Symbol-Chip, der einen Link öffnet:

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

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