Cards v2

object (CardHeader)

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

object (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.

enum (DividerStyle)

Der Trennungsstil zwischen Kopfzeile, Abschnitten und Fußzeile.

object (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:

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

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

object (CardFixedFooter)

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

Wenn Sie fixedFooter festlegen, ohne primaryButton oder secondaryButton anzugeben, tritt ein Fehler auf. Für Chat-Apps können Sie feste Fußzeilen in Dialogfeldern verwenden, aber keine Kartennachrichten.

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

enum (DisplayStyle)

Hier legen Sie in Google Workspace Add-ons die Anzeigeeigenschaften der peekCardHeader fest.

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

object (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

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.

string

Der Untertitel der Kartenüberschrift. Falls angegeben, wird es in einer eigenen Zeile unterhalb des title-Elements angezeigt.

enum (ImageType)

Die Form, mit der das Bild zugeschnitten 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 Bildes, der als Bedienungshilfe verwendet wird.

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.

object (Widget)

Alle Widgets im Abschnitt. Muss mindestens ein Widget enthalten.

boolean

Gibt an, ob dieser Bereich minimierbar ist.

Minimierbare Abschnitte blenden einige oder alle Widgets aus. Nutzer können den Bereich aber maximieren, um die ausgeblendeten Widgets einzublenden, indem sie auf Mehr anzeigen klicken. Nutzer können die Widgets durch Klicken auf Weniger anzeigen wieder ausblenden.

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

integer

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

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

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

enum (HorizontalAlignment)

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

object (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.

Mit dem folgenden JSON-Code wird beispielsweise fett formatierter Text erstellt:

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

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

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

object (ButtonList)

Eine Liste mit Schaltflächen.

Mit dem folgenden JSON-Code werden beispielsweise zwei Schaltflächen erstellt. Die erste ist eine blaue Textschaltfläche und die zweite eine Bildschaltfläche, die einen Link öffnet:

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

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

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

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 dem folgenden JSON-Code wird beispielsweise ein Drop-down-Menü erstellt, über das Nutzer eine Größe auswählen können:

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

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

object (Divider)

Zeigt eine horizontale Trennlinie zwischen den Widgets an.

Die folgende JSON-Datei erstellt beispielsweise eine Trennlinie:

"divider": {
}

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

object (Columns)

Es werden bis zu zwei Spalten angezeigt.

Wenn Sie mehr als zwei Spalten einbeziehen 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"
          }
        }
      ]
    }
  ]
}

object (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.

string

Der Text, der im Widget angezeigt wird.

integer

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

string

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

Beispiel:

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

object (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.

object (Action)

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

object (OpenLink)

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

object (Action)

Ein Add-on löst diese Aktion aus, wenn die Aktion einen Link öffnen muss. Im Unterschied zu openLink oben muss dieser mit dem Server kommunizieren, um den Link zu erhalten. 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.

object (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.

object (OverflowMenu)

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

string

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

Anwendungsbeispiele finden Sie unter Formulardaten lesen.

object (ActionParameter)

Liste der Aktionsparameter.

enum (LoadIndicator)

Gibt die Fortschrittsanzeige an, die während der Ausführung der Aktion angezeigt wird.

boolean

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 für LoadIndicator den Wert NONE fest. Bei Kartennachrichten in Chat-Apps müssen Sie außerdem die ResponseType der Aktion auf UPDATE_MESSAGE festlegen und dieselbe cardId aus der Karte verwenden, die die Aktion enthält.

Bei false werden die Formularwerte gelöscht, wenn die Aktion ausgelöst wird. Wenn der Nutzer während der Verarbeitung der Aktion keine Änderungen vornehmen soll, legen Sie LoadIndicator auf SPINNER fest.

enum (Interaction)

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

Was soll bei einer Interaktion mit einem Nutzer passieren, 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 festlegen, kann die App ein Dialogfeld öffnen. Wenn angegeben, 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.

boolean

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

string

Der Name des Parameters für das Aktionsskript.

string

Wert des Parameters.

string

Die zu öffnende URL.

enum (OpenAs)

So öffnen Sie einen Link.

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

enum (OnClose)

Ob der Kunde einen Link nach dem Öffnen vergisst oder ihn beobachtet, bis das Fenster geschlossen wird.

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

object (OverflowMenuItem)

Erforderlich. Die Liste der Menüoptionen.

object (Icon)

Das Symbol, das vor dem Text angezeigt wird.

string

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

object (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.

boolean

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

string

Optional. Eine Beschreibung des Symbols, das als Bedienungshilfe verwendet wird. Wenn keine Vorgabe erfolgt, wird der Standardwert Button angegeben. Als Best Practice sollten Sie eine hilfreiche Beschreibung dafür festlegen, was das Symbol darstellt und gegebenenfalls, was es bewirkt. Beispiel: A user's account portrait oder Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Wenn das Symbol in einem Button festgelegt ist, wird der altText als Hilfetext angezeigt, wenn der Nutzer den Mauszeiger auf die Schaltfläche bewegt. Wird über die Schaltfläche außerdem text festgelegt, wird der altText des Symbols ignoriert.

enum (ImageType)

Der auf das Bild angewendete Zuschnittsstil. In einigen Fällen wird das Bild durch das Zuschneiden mit CIRCLE größer als ein integriertes Symbol dargestellt.

string

Rufen Sie eines der integrierten Symbole von Google Workspace auf.

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

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

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"

Zu den unterstützten Dateitypen gehören .png und .jpg.

object (MaterialIcon)

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

string

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

boolean

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.

integer

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

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

integer

Gewicht und Stärke wirken sich auf die Dicke 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.

Eine Vorschau der verschiedenen Symboleinstellungen findest du unter Google-Schriftsymbole. Die entsprechenden Einstellungen kannst du unter Anpassen anpassen.

object (Icon)

Wurde zugunsten von startIcon verworfen.

object (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.

boolean

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.

object (OnClick)

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

object (Button)

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

object (SwitchControl)

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

object (Icon)

Ein Symbol, das nach dem Text angezeigt wird.

Unterstützt integrierte und benutzerdefinierte Symbole.

string

Der auf der Schaltfläche angezeigte Text.

object (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.

object (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 festgelegt. Wenn für die Schaltfläche beispielsweise Blau festgelegt ist, wird auch der gesamte Text und alle Symbole in der Schaltfläche weiß dargestellt.

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

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

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

Das Feld alpha ist für die Schaltflächenfarbe nicht verfügbar. Wenn angegeben, wird dieses Feld ignoriert.

object (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.

boolean

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önntest du Folgendes schreiben: „Öffnet einen neuen Browsertab und ruft die Google Chat-Entwicklerdokumentation unter https://developers.google.com/workspace/chat" auf.

enum (Type)

Optional. Der Typ einer Schaltfläche. Wenn kein Wert festgelegt ist, wird standardmäßig der Schaltflächentyp OUTLINED verwendet. Wenn das Feld color festgelegt ist, wird der Schaltflächentyp auf FILLED gesetzt und jeder für dieses Feld festgelegte Wert wird ignoriert.

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

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 nicht angegeben, wird das Farbobjekt als Volltonfarbe dargestellt (als ob für den Alphawert explizit 1,0 angegeben worden wäre).

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.

boolean

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

object (Action)

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

enum (ControlType)

Wie der Schalter in der Benutzeroberfläche angezeigt wird.

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

object (Button)

Ein Array von Schaltflächen.

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 Sie beispielsweise nach dem Namen einer Person fragen, aber ausdrücklich den Nachnamen benötigen, geben Sie surname anstelle von name ein.

Erforderlich, wenn hintText nicht angegeben ist. Ansonsten optional.

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

enum (Type)

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

object (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.

object (Suggestions)

Vorgeschlagene Werte, die Nutzer eingeben können. Diese Werte werden angezeigt, wenn Nutzer in das Textfeld 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, wird die Liste der Vorschläge so gefiltert, dass nur Java und JavaScript angezeigt werden.

Vorgeschlagene Werte helfen Nutzern, Werte einzugeben, die für Ihre App sinnvoll sind. Wenn es um JavaScript geht, geben einige Nutzer möglicherweise javascript ein, andere java script. 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.

object (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 kein Wert angegeben ist, 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.

object (Validation)

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

string

Text, der im Texteingabefeld erscheint, wenn das Feld leer ist. Mit diesem Text werden Nutzer aufgefordert, einen Wert einzugeben. Beispiel: Enter a number from 0 to 100.

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

Action

Navigation

Drücken oder aktualisieren Sie angezeigte Karten.

Card

Ein Kartenstapel schiebt eine Karte auf den Kartenstapel.

Card

Bei der Kartenstapel-Funktion wird die oberste Karte durch eine neue Karte ersetzt und die Werte aus ausgefüllten Formularfeldern bleiben erhalten. Bei nicht übereinstimmenden Feldern wird der Wert verworfen.

object (SuggestionItem)

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

string

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

integer

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

enum (InputType)

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

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 Auswahleingabefeld angezeigt wird.

Geben Sie Text an, der den Nutzern hilft, die für Ihre App erforderlichen Informationen einzugeben. Wenn Nutzer beispielsweise die Dringlichkeit eines geschäftlichen Tickets aus einem Drop-down-Menü auswählen, kann das Label „Dringlichkeit“ oder „Dringlichkeit auswählen“ lauten.

enum (SelectionType)

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

object (SelectionItem)

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

object (Action)

Wenn Sie diese Option aktivieren, 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 Formularinputs finden Sie unter Formulardaten empfangen.

integer

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.

integer

Bei Menüs mit Mehrfachauswahl ist dies die Anzahl der Textzeichen, die ein Nutzer eingibt, bevor die App die automatische Vervollständigung abfragt und Vorschläge 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.

object (Validation)

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

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

object (Action)

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

object (PlatformDataSource)

Eine Datenquelle aus Google Workspace.

string

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

string

Der mit diesem Element verknüpfte Wert. Der Kunde sollte diesen Wert als Formulareingabe verwenden.

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

boolean

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.

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.

enum (CommonDataSource)

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

object (HostAppDataSourceMarkup)

Eine Datenquelle, die nur für eine Google Workspace-Hostanwendung wie Gruppenbereiche in Google Chat gilt.

Dieses Feld wird von den Google API-Clientbibliotheken unterstützt, ist aber in den Cloud-Clientbibliotheken nicht verfügbar. Weitere Informationen finden Sie unter Clientbibliotheken installieren.

object (ChatClientDataSourceMarkup)

Eine Datenquelle aus Google Chat.

object (SpaceDataSource)

Google Chat-Gruppenbereiche, in denen der Nutzer Mitglied ist.

boolean

Wenn true festgelegt ist, wird im Menü für die Mehrfachauswahl standardmäßig der aktuelle Google Chat-Bereich ausgewählt.

string

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

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

string

Der Text, in dem Nutzer aufgefordert werden, ein Datum, eine Uhrzeit oder ein Datum und eine Uhrzeit einzugeben. Wenn Nutzer beispielsweise einen Termin planen, verwenden Sie ein Label wie Appointment date oder Appointment date and time.

enum (DateTimePickerType)

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

string (int64 format)

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

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

• DATE_AND_TIME: ein Kalenderdatum und eine Kalenderzeit in UTC. Wenn Sie beispielsweise den 1. Januar 2023 um 12:00 Uhr UTC angeben möchten, verwenden Sie 1672574400000.
• DATE_ONLY : ein Kalenderdatum um 00:00:00 Uhr (UTC). Verwenden Sie beispielsweise 1672531200000 für den 1. Januar 2023.
• TIME_ONLY: eine Zeit in UTC. Verwenden Sie beispielsweise 43200000 (oder 12 * 60 * 60 * 1000), um 12:00 Uhr anzugeben.

integer

Die Zahl, die den Zeitzonen-Unterschied zu UTC in Minuten angibt. Wenn dies festgelegt ist, wird valueMsEpoch in der angegebenen Zeitzone angezeigt. Wenn kein Wert festgelegt ist, wird standardmäßig die Zeitzoneneinstellung des Nutzers verwendet.

object (Action)

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

object (Validation)

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

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 die einzelnen Rasterelemente angewendet werden soll.

integer

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

object (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 vom Nutzer angegebene 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

Untertitel des Rasterelements

enum (GridItemLayout)

Das für das Rasterelement zu verwendende Layout.

string

Die Bild-URL.

string

Das Bedienungshilfen-Label für das Bild.

object (ImageCropStyle)

Der Zuschnittsstil, der auf das Bild angewendet werden soll.

object (BorderStyle)

Der Rahmenstil, der auf das Bild angewendet werden soll.

enum (ImageCropType)

Der Zuschneidetyp.

number

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

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

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

enum (BorderType)

Der Rahmentyp.

object (Color)

Die zu verwendenden Farben, wenn der Typ BORDER_TYPE_STROKE ist.

Geben Sie zum Festlegen der Strichfarbe 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.

integer

Der Eckenradius für den Rahmen.

object (Column)

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

enum (HorizontalSizeStyle)

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

enum (HorizontalAlignment)

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

enum (VerticalAlignment)

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

object (Widgets)

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

object (TextParagraph)

TextParagraph.

object (Image)

Image.

object (DecoratedText)

DecoratedText.

object (ButtonList)

ButtonList Widget.

object (TextInput)

TextInput Widget.

object (SelectionInput)

SelectionInput.

object (DateTimePicker)

DateTimePicker.

object (ChipList)

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

enum (Layout)

Angegebenes Layout der Chipliste.

object (Chip)

Eine Reihe von Chips.

object (Icon)

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

string

Der im Chip angezeigte Text.

object (OnClick)

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

boolean

Gibt an, ob sich der Chip in einem aktiven Zustand befindet und auf Nutzeraktionen reagiert. Die Standardeinstellung ist true. Verworfen. Verwenden Sie stattdessen disabled.

boolean

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.

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" auf.

enum (HorizontalAlignment)

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

object (Button)

Optional. Definieren Sie eine benutzerdefinierte 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.

object (Button)

Optional. Definieren Sie eine benutzerdefinierte Schaltfläche, um den Bereich zu minimieren. Sowohl das Feld „expandButton“ als auch das Feld „collapseButton“ müssen festgelegt sein. Nur ein Feldsatz wird nicht übernommen. Ist dieses Feld nicht festgelegt, wird die Standardschaltfläche verwendet.

string

Das Label, das als Menüpunkt für die Aktion angezeigt wird.

object (OnClick)

Die Aktion onClick für diese Aufgabe.

object (Button)

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

object (Button)

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