Package google.apps.card.v1

Indeks

Działanie

Działanie opisujące zachowanie po przesłaniu formularza. Możesz na przykład wywołać skrypt Apps Script do obsługi formularza. Jeśli to działanie zostanie wywołane, wartości formularza zostaną przesłane na serwer.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
function

string

Funkcja niestandardowa wywoływana po kliknięciu lub aktywowaniu elementu zawierającego element.

Informacje o używaniu znajdziesz w artykule Odczytywanie danych formularzy.
parameters[]

ActionParameter

Lista parametrów działań.
loadIndicator

LoadIndicator

Określa wskaźnik wczytywania, który wyświetla się podczas wywoływania wezwania do działania.
persistValues

bool

Wskazuje, czy wartości formularza są zachowywane po wykonaniu działania. Wartością domyślną jest false.

Jeśli ustawiona jest wartość true, wartości formularza pozostają po wywołaniu działania. Aby umożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw wartość LoadIndicator na NONE. W przypadku kart w aplikacjach do obsługi czatu musisz też ustawić wartość ResponseType działania na UPDATE_MESSAGE i użyć tego samego elementu card_id co na karcie, która go zawierała.

Jeśli jest ustawiona wartość false, wartości formularza są czyszczone po uruchomieniu działania. Aby uniemożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw wartość LoadIndicator na SPINNER.
interaction

Interaction

Opcjonalnie. Wymagane przy otwieraniu okna.

Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.

Jeśli nie określono inaczej, aplikacja odpowiada, wykonując action (np. otwierając link lub uruchamiając funkcję) w zwykły sposób.

Dzięki określeniu interaction aplikacja może reagować w specjalny, interaktywny sposób. Na przykład ustawiając dla opcji interaction wartość OPEN_DIALOG, aplikacja może otwierać okno dialogowe. Gdy podasz ten parametr, wskaźnik wczytywania nie będzie wyświetlany. Jeśli określisz konfigurację dla dodatku, cała karta zostanie usunięta i klient nie będzie wyświetlać żadnych danych.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

ActionParameter

Lista parametrów ciągu znaków, które mają zostać dostarczone po wywołaniu metody działania. Rozważmy na przykład trzy przyciski drzemki: Drzemka teraz, Odłóż na jeden dzień i Drzemka w kolejnym tygodniu. Możesz użyć funkcji action method = snooze(), która przekazuje typ drzemki i czas drzemki na liście parametrów ciągu znaków.

Więcej informacji: CommonEventObject.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
key

string

Nazwa parametru skryptu działania.
value

string

Wartość parametru.

Interakcja

Opcjonalnie. Wymagane przy otwieraniu okna.

Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.

Jeśli nie określono inaczej, aplikacja odpowiada, wykonując action (np. otwierając link lub uruchamiając funkcję) w zwykły sposób.

Dzięki określeniu interaction aplikacja może reagować w specjalny, interaktywny sposób. Na przykład ustawiając dla opcji interaction wartość OPEN_DIALOG, aplikacja może otwierać okno dialogowe.

Gdy podasz ten parametr, wskaźnik wczytywania nie będzie wyświetlany. Jeśli określisz konfigurację dla dodatku, cała karta zostanie usunięta i klient nie będzie wyświetlać żadnych danych.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Wartości w polu enum
INTERACTION_UNSPECIFIED Wartość domyślna. action działa normalnie.
OPEN_DIALOG

Otwiera okno, czyli okienny interfejs z kartami, za pomocą którego aplikacje Google Chat komunikują się z użytkownikami.

Obsługiwane tylko przez aplikacje do obsługi czatu w odpowiedzi na kliknięcia przycisków w wiadomościach kart. Jeśli określisz konfigurację dla dodatku, cała karta zostanie usunięta i klient nie będzie wyświetlać żadnych danych.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

LoadIndicator

Określa wskaźnik wczytywania, który wyświetla się podczas wywoływania wezwania do działania.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SPINNER Wyświetla wskaźnik postępu ładowania treści.
NONE Nic nie jest wyświetlane.

BorderStyle

Opcje stylu obramowania karty lub widżetu, w tym typ i kolor obramowania.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
type

BorderType

Typ obramowania.
strokeColor

Color

Kolory, które mają być używane, gdy typ to BORDER_TYPE_STROKE.
cornerRadius

int32

Promień narożnika obramowania.

BorderType

Reprezentuje typy obramowań zastosowane do widżetów.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
BORDER_TYPE_UNSPECIFIED Nie używaj. Nie określono.
NO_BORDER Wartość domyślna. Bez obramowania.
STROKE Outline.

Przycisk

Tekst, ikona lub tekst i przycisk ikony, które użytkownicy mogą kliknąć. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie przycisku.

Aby ustawić obraz jako przycisk klikalny, określ właściwość Image (nie ImageComponent) i ustaw działanie onClick.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst wyświetlany na przycisku.
icon

Icon

Obraz ikony. Jeśli masz ustawione zarówno zasady icon, jak i text, ikona pojawi się przed tekstem.
color

Color

Jeśli zasada jest skonfigurowana, przycisk zostanie wypełniony jednolitym kolorem tła, a kolor czcionki zostanie zmieniony, aby zachować kontrast z tłem. Na przykład ustawienie niebieskiego tła powoduje prawdopodobnie utworzenie białego tekstu.

Jeśli zasada jest nieskonfigurowana, tło obrazu jest białe, a czcionka jest niebieska.

W przypadku czerwonego, zielonego i niebieskiego wartość każdego pola jest liczbą float, którą można wyrazić na jeden z dwóch sposobów: jako liczbę z zakresu od 0 do 255 podzieloną przez 255 (153/255) lub jako wartość z zakresu od 0 do 1 (0,6). 0 oznacza brak koloru, a 1 lub 255/255 oznacza pełną obecność tego koloru na skali RGB.

Opcjonalnie ustaw wartość alpha, która ustawia poziom przezroczystości przy użyciu tego równania:

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

W przypadku alpha wartość 1 odpowiada jednolitego koloru, a wartość 0 – całkowicie przezroczystemu kolorowi.

Na przykład ten kolor oznacza półprzezroczystą czerwień:

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

OnClick

Wymagane. Działanie, które ma zostać wykonane po kliknięciu przycisku przez użytkownika, np. otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.
disabled

bool

Jeśli true, przycisk jest nieaktywny i nie reaguje na działania użytkownika.
altText

string

Tekst alternatywny używany na potrzeby ułatwień dostępu.

Ustaw tekst opisu, który poinformuje użytkowników, do czego służy przycisk. Jeśli na przykład przycisk otwiera hiperlink, możesz napisać: „Otwiera nową kartę przeglądarki i przechodzi do dokumentacji dla deweloperów Google Chat na stronie https://developers.google.com/workspace/chat".

ButtonList

Lista przycisków ułożonych poziomo. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie przycisku.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
buttons[]

Button

Kilka przycisków.

Karta

Interfejs karty wyświetlany w wiadomości w Google Chat lub dodatku do Google Workspace.

Karty obsługują zdefiniowany układ, interaktywne elementy interfejsu (np. przyciski) i elementy multimedialne (np. obrazy). Za pomocą kart możesz prezentować szczegółowe informacje, zbierać informacje od użytkowników i pomagać im zrobić kolejny krok.

Projektuj karty i wyświetl ich podgląd w kreatorze kart.

Otwórz Kreator kart

Aby dowiedzieć się, jak tworzyć karty, zapoznaj się z tą dokumentacją:

Przykład: wiadomość na karcie do aplikacji Google Chat

Przykładowa wizytówka

Aby utworzyć przykładową wiadomość karty w Google Chat, użyj tego kodu JSON:

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Pola
header

CardHeader

Nagłówek karty. Nagłówek zazwyczaj zawiera obraz i tytuł. Nagłówki są zawsze wyświetlane u góry karty.
sections[]

Section

Zawiera kolekcję widżetów. Każda sekcja ma własny, opcjonalny nagłówek. Sekcje są wizualnie oddzielone separatorem liniowym. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Definiowanie sekcji karty.
sectionDividerStyle

DividerStyle

Styl podziału między sekcjami.
cardActions[]

CardAction

Działania karty. Działania są dodawane do menu karty na pasku narzędzi.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Na przykład ten kod JSON tworzy menu czynności karty z opcjami Settings i Send Feedback:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Nazwa karty. Używany jako identyfikator karty w nawigacji kart.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
fixedFooter

CardFixedFooter

Stała stopka wyświetlana u dołu tej karty.

Ustawienie fixedFooter bez określenia primaryButton lub secondaryButton powoduje błąd. W przypadku aplikacji do obsługi czatu możesz używać stałych stopek w oknach dialogowych, ale nie w wiadomościach na kartach.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
displayStyle

DisplayStyle

W Dodatkach do Google Workspace ustawia właściwości wyświetlania elementu peekCardHeader.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
peekCardHeader

CardHeader

Podczas wyświetlania treści kontekstowych nagłówek karty podglądu działa jak obiekt zastępczy, aby użytkownik mógł przechodzić między kartami strony głównej i kartami kontekstowymi.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

CardAction

Działanie karty to działanie powiązane z kartą. Na przykład karta faktury może zawierać takie działania jak usunięcie faktury lub jej wysłanie e-mailem czy otwarcie faktury w przeglądarce.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Pola
actionLabel

string

Etykieta, która wyświetla się jako element menu czynności.
onClick

OnClick

Działanie onClick powiązane z tym działaniem.

CardFixedFooter

Trwała (przyklejona) stopka wyświetlana u dołu karty.

Ustawienie fixedFooter bez określenia primaryButton lub secondaryButton powoduje błąd.

W przypadku aplikacji do obsługi czatu możesz używać stałych stopek w oknach dialogowych, ale nie w wiadomościach na kartach. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie trwałej stopki.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
primaryButton

Button

Przycisk główny stałej stopki. Przycisk musi być przyciskiem tekstowym z ustawionym tekstem i kolorem.
secondaryButton

Button

Przycisk dodatkowy stałej stopki. Przycisk musi być przyciskiem tekstowym z ustawionym tekstem i kolorem. Jeśli ustawiona jest zasada secondaryButton, musisz też ustawić parametr primaryButton.

CardHeader

Reprezentuje nagłówek karty. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie nagłówka.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
title

string

Wymagane. Tytuł nagłówka karty. Nagłówek ma stałą wysokość: jeśli określono zarówno tytuł, jak i podtytuł, każdy z nich zajmuje 1 wiersz. Jeśli określisz tylko tytuł, zajmie on oba wiersze.
subtitle

string

Podtytuł karty. Jeśli zostanie podany, pojawi się w osobnym wierszu pod title.
imageType

ImageType

Kształt użyty do przycięcia obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
imageUrl

string

Adres URL HTTPS obrazu w nagłówku karty.
imageAltText

string

Tekst alternatywny tego obrazu, który jest używany na potrzeby ułatwień dostępu.

DisplayStyle

W przypadku dodatków do Google Workspace określa sposób wyświetlania karty.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Wartości w polu enum
DISPLAY_STYLE_UNSPECIFIED Nie używaj. Nie określono.
PEEK Nagłówek karty pojawia się u dołu paska bocznego i częściowo zasłania bieżącą górną kartę stosu. Kliknięcie nagłówka powoduje umieszczenie karty w stosie kart. Jeśli karta nie ma nagłówka, zamiast niego używany jest wygenerowany nagłówek.
REPLACE Wartość domyślna. Karta wyświetla się po zastąpieniu widoku górnej karty w grupie kart.

DividerStyle

Styl przerywnika karty. Obecnie ten typ jest używany tylko do rozdzielania sekcji kart.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
DIVIDER_STYLE_UNSPECIFIED Nie używaj. Nie określono.
SOLID_DIVIDER Opcja domyślna. Utwórz linię podziału między sekcjami.
NO_DIVIDER Jeśli zasada jest skonfigurowana, separatory między sekcjami nie są renderowane.

Sekcja

Sekcja zawiera zbiór widżetów, które są renderowane w pionie w określonej kolejności.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
header

string

Tekst widoczny u góry sekcji. Obsługuje prosty tekst w formacie HTML. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
widgets[]

Widget

Wszystkie widżety w sekcji. Musi zawierać co najmniej jeden widżet.
collapsible

bool

Wskazuje, czy ta sekcja jest zwijana.

Sekcje zwijane ukrywają niektóre lub wszystkie widżety, ale użytkownicy mogą je rozwinąć, aby wyświetlić ukryte widżety, klikając Pokaż więcej. Użytkownicy mogą ponownie ukryć widżety, klikając Pokaż mniej.

Aby określić, które widżety są ukryte, wybierz uncollapsibleWidgetsCount.
uncollapsibleWidgetsCount

int32

Liczba widżetów, których nie można zwijać, które pozostają widoczne nawet po zwinięciu sekcji.

Jeśli na przykład sekcja zawiera 5 widżetów, a element uncollapsibleWidgetsCount ma wartość 2, pierwsze 2 widżety są zawsze wyświetlane, a 3 – domyślnie zwinięte. Pole uncollapsibleWidgetsCount jest uwzględniane tylko wtedy, gdy collapsible ma wartość true.

Kolumny

Widżet Columns wyświetla maksymalnie 2 kolumny na karcie lub w oknie. Do każdej kolumny można dodać widżety. Widżety wyświetlają się w określonej kolejności. Informacje o aplikacjach Google Chat znajdziesz w artykule Wyświetlanie kart i okien w kolumnach.

Wysokość każdej kolumny jest określana na podstawie jej wyższej kolumny. Jeśli na przykład pierwsza kolumna jest wyższa od drugiej, obie kolumny mają wysokość pierwszej kolumny. Każda kolumna może zawierać różną liczbę widżetów, więc nie możesz definiować wierszy ani wyrównywać widżetów między kolumnami.

Kolumny są wyświetlane obok siebie. Możesz dostosować szerokość każdej kolumny za pomocą pola HorizontalSizeStyle. Jeśli szerokość ekranu użytkownika jest zbyt mała, druga kolumna zawija się pod pierwszą:

  • W witrynach na komputery druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 480 pikseli.
  • Na urządzeniach z iOS druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 300 punktów.
  • Na urządzeniach z Androidem druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 320 dp.

Aby uwzględnić więcej niż 2 kolumny lub użyć wierszy, użyj widżetu Grid.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.

Pola
columnItems[]

Column

Tablica kolumn. Na karcie lub w oknie możesz umieścić maksymalnie 2 kolumny.

Kolumna

Kolumna.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.

Pola
horizontalSizeStyle

HorizontalSizeStyle

Określa, w jaki sposób kolumna wypełnia szerokość karty.
horizontalAlignment

HorizontalAlignment

Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny.
verticalAlignment

VerticalAlignment

Określa, czy widżety mają być wyrównywane do góry, do dołu czy do środka kolumny.
widgets[]

Widgets

Tablica widżetów w kolumnie. Widżety wyświetlają się w określonej kolejności.

HorizontalSizeStyle

Określa, w jaki sposób kolumna wypełnia szerokość karty. Szerokość każdej kolumny zależy zarówno od szerokości HorizontalSizeStyle, jak i szerokości widżetów w kolumnie.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.

Wartości w polu enum
HORIZONTAL_SIZE_STYLE_UNSPECIFIED Nie używaj. Nie określono.
FILL_AVAILABLE_SPACE Wartość domyślna. Kolumna wypełnia dostępną przestrzeń, do 70% szerokości karty. Jeśli obie kolumny mają wartość FILL_AVAILABLE_SPACE, każda z nich zajmuje 50% miejsca.
FILL_MINIMUM_SPACE Kolumna zapełnia najmniejszą możliwą ilość miejsca i nie może przekraczać 30% szerokości karty.

VerticalAlignment

Określa, czy widżety mają być wyrównywane do góry, do dołu czy do środka kolumny.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.

Wartości w polu enum
VERTICAL_ALIGNMENT_UNSPECIFIED Nie używaj. Nie określono.
CENTER Wartość domyślna. Wyrównuje widżety do środka kolumny.
TOP Wyrównuje widżety do góry kolumny.
BOTTOM Wyrównuje widżety do dołu kolumny.

Widżety

Obsługiwane widżety, które możesz uwzględnić w kolumnie.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.

Pola

Pole sumy data.

data może być tylko jedną z tych wartości:
textParagraph

TextParagraph

Widżet TextParagraph.
image

Image

Widżet Image.
decoratedText

DecoratedText

Widżet DecoratedText.
buttonList

ButtonList

Widżet ButtonList.
textInput

TextInput

Widżet TextInput.
selectionInput

SelectionInput

Widżet SelectionInput.
dateTimePicker

DateTimePicker

Widżet DateTimePicker.

DateTimePicker

Pozwala użytkownikom wpisać datę, godzinę lub zarówno datę, jak i godzinę. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Zezwalanie użytkownikowi na wybór daty i godziny.

Użytkownicy mogą wpisywać tekst lub wybierać daty i godziny za pomocą selektora. Jeśli użytkownicy wprowadzą nieprawidłową datę lub godzinę, w selektorze wyświetli się błąd i prośba o prawidłowe wpisanie informacji.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Nazwa, pod którą element DateTimePicker jest identyfikowany w zdarzeniu danych wejściowych formularza.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
label

string

Tekst, który prosi użytkownika o wpisanie daty, godziny lub daty i godziny. Jeśli na przykład użytkownicy planują spotkanie, użyj etykiety takiej jak Appointment date lub Appointment date and time.
type

DateTimePickerType

Określa, czy widżet obsługuje wprowadzanie daty, godziny czy daty i godziny.
valueMsEpoch

int64

Wartość domyślna wyświetlana w widżecie (w milisekundach od czasu uniksowego).

Określ wartość na podstawie typu selektora (DateTimePickerType):

  • DATE_AND_TIME: data i godzina kalendarzowa w strefie czasowej UTC. Na przykład do oznaczenia daty 1 stycznia 2023 r. o 12:00 czasu UTC użyj 1672574400000.
  • DATE_ONLY: data kalendarzowa o 00:00:00 czasu UTC. Aby na przykład wskazać 1 stycznia 2023 r., użyj formatu 1672531200000.
  • TIME_ONLY: godzina w strefie czasowej UTC. Na przykład, aby wskazać godzinę 12:00, użyj formatu 43200000 (lub 12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

Liczba określająca przesunięcie strefy czasowej w stosunku do czasu UTC w minutach. Jeśli zasada jest skonfigurowana, value_ms_epoch wyświetla się w określonej strefie czasowej. Jeśli zasada nie jest skonfigurowana, wartością domyślną jest ustawienie strefy czasowej użytkownika.
onChangeAction

Action

Wywoływane, gdy użytkownik kliknie Zapisz lub Wyczyść w interfejsie DateTimePicker.

DateTimePickerType

Format daty i godziny w widżecie DateTimePicker. Określa, czy użytkownicy mogą wpisywać datę, godzinę czy datę i godzinę.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
DATE_AND_TIME Użytkownicy wpisują datę i godzinę.
DATE_ONLY Użytkownicy wpisują datę.
TIME_ONLY Użytkownicy podają godzinę.

DecoratedText

Widżet wyświetlający tekst z opcjonalnymi dekoracjami, takimi jak etykieta nad lub pod tekstem, ikona przed tekstem, widżet wyboru czy przycisk za tekstem. Przykład w aplikacjach Google Chat znajdziesz w artykule Wyświetlanie tekstu z dekoracyjnym tekstem.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
icon
(deprecated)

Icon

Wycofano na rzecz: startIcon.
startIcon

Icon

Ikona wyświetlana przed tekstem.
topLabel

string

Tekst widoczny nad pozycją text. Zawsze skraca tekst.
text

string

Wymagane. Tekst główny.

Obsługuje proste formatowanie. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
wrapText

bool

Ustawienie zawijania tekstu. Jeśli ustawiona jest wartość true, tekst zawija się i wyświetla się w wielu wierszach. W przeciwnym razie tekst jest obcinany.

Dotyczy tylko text, a nie topLabel i bottomLabel.
bottomLabel

string

Tekst widoczny pod nagłówkiem text. Zawsze opakowany.
onClick

OnClick

To działanie jest wywoływane, gdy użytkownik kliknie topLabel lub bottomLabel.
Pole sumy control. Przycisk, przełącznik, pole wyboru lub obraz wyświetlane po prawej stronie tekstu w widżecie decoratedText. control może być tylko jedną z tych wartości:
button

Button

Przycisk, który użytkownik może kliknąć, aby wywołać działanie.
switchControl

SwitchControl

Widżet przełączania, który użytkownik może kliknąć, aby zmienić swój stan i wywołać działanie.
endIcon

Icon

Ikona wyświetlana po tekście.

Obsługuje ikony wbudowane i niestandardowe.

SwitchControl

Przełącznik stylu lub pole wyboru w widżecie decoratedText.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Obsługiwane tylko w widżecie decoratedText.

Pola
name

string

Nazwa, pod którą widżet przełączania jest identyfikowany w zdarzeniu danych wejściowych formularza.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
value

string

Wartość wpisana przez użytkownika, zwrócona w ramach zdarzenia wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
selected

bool

Gdy true jest wybrany, przełącznik jest wybrany.
onChangeAction

Action

Działanie, które ma zostać wykonane po zmianie stanu przełącznika, np. wybór funkcji, która ma zostać uruchomiona.
controlType

ControlType

Sposób wyświetlania przełącznika w interfejsie.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

ControlType

Sposób wyświetlania przełącznika w interfejsie.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SWITCH Przełącznik typu przełącznik.
CHECKBOX Wycofano na rzecz: CHECK_BOX.
CHECK_BOX Pole wyboru.

Separator

Ten typ nie ma żadnych pól.

Wyświetla linię między widżetami w postaci poziomej linii. Informacje o aplikacjach Google Chat znajdziesz w artykule Dodawanie poziomego separatora między widżetami.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Na przykład następujący kod JSON tworzy separator:

"divider": {}

EndNavigation

Działanie w oknie dialogowym.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Pola
action

Action

Działanie renderowania, które kończy proces renderowania przez klienta.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Działanie

Typy działań renderowania, których klient kończy okno dialogowe.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Wartości w polu enum
ACTION_UNSPECIFIED Nie określono działania.
CLOSE_DIALOG Zamknij okno dialogowe.
CLOSE_DIALOG_AND_EXECUTE Zamknij okno dialogowe i odśwież kartę, która go otworzyła.

GetAutocompletionResponse

Odpowiedź na żądanie pobrania kontenera autouzupełniania, który zawiera elementy niezbędne do wyświetlania elementów autouzupełniania w polu tekstowym.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. Na przykład:

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

Suggestions
schema

string

To jest pole schematu bez operacji, które może znajdować się w znacznikach na potrzeby sprawdzania składni.

GRid

Wyświetla siatkę z kolekcją elementów. Elementy mogą zawierać tylko tekst lub obrazy. Jeśli chcesz dodać do elastycznych kolumn więcej niż tekst lub obrazy, użyj funkcji Columns. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Wyświetlanie siatki z kolekcją elementów.

Siatka może zawierać dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez liczbę elementów podzieloną przez kolumny. Siatka zawierająca 10 elementów i 2 kolumny ma 5 wierszy. Siatka z 11 elementami i 2 kolumnami ma 6 wierszy.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Na przykład ten kod JSON tworzy siatkę z 2 kolumnami z 1 elementem:

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

string

Tekst wyświetlany w nagłówku siatki.
items[]

GridItem

Elementy do wyświetlenia w siatce.
borderStyle

BorderStyle

Styl obramowania, który ma być stosowany do każdego elementu siatki.
columnCount

int32

Liczba kolumn wyświetlanych w siatce. Jeśli nie określisz wartości tego pola, zostanie użyta wartość domyślna, która będzie się różnić w zależności od miejsca wyświetlania siatki (w oknie dialogowym lub w aplikacji towarzyszącej).
onClick

OnClick

Tego wywołania zwrotnego używa każdy element siatki, ale z identyfikatorem i indeksem elementu na liście elementów dodanymi do parametrów wywołania zwrotnego.

GridItem

Reprezentuje element w układzie siatki. Elementy mogą zawierać tekst, obraz lub zarówno tekst, jak i obraz.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
id

string

Określony przez użytkownika identyfikator tego elementu siatki. Ten identyfikator jest zwracany w parametrach wywołania zwrotnego onClick siatki nadrzędnej.
image

ImageComponent

Obraz wyświetlany w elemencie siatki.
title

string

Tytuł elementu siatki.
subtitle

string

Podtytuł elementu siatki.
layout

GridItemLayout

Układ elementu siatki.

GridItemLayout

Reprezentuje różne opcje układu dostępne dla elementu siatki.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
GRID_ITEM_LAYOUT_UNSPECIFIED Nie używaj. Nie określono.
TEXT_BELOW Tytuł i podtytuł są widoczne pod obrazem siatki.
TEXT_ABOVE Tytuł i podtytuł są widoczne nad obrazem siatki.

Ikona

Ikona wyświetlana w widżecie na karcie. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie ikony.

Obsługuje ikony wbudowane i niestandardowe.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
altText

string

Opcjonalnie. Opis ikony używanej na potrzeby ułatwień dostępu. Jeśli nie określono inaczej, podana jest wartość domyślna Button. Najlepiej jest dodać przydatny opis tego, co wyświetla się ikona i do czego służy. Na przykład A user's account portrait lub Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Jeśli ikona jest ustawiona w elemencie Button, po najechaniu przez użytkownika kursorem myszy na przycisk pojawi się altText jako tekst pomocniczy. Jeśli jednak przycisk ustawi również text, altText ikony jest ignorowana.
imageType

ImageType

Styl przycinania zastosowany do obrazu. W niektórych przypadkach przycięcie obrazu za pomocą CIRCLE powoduje, że obraz jest większy niż ikona wbudowanej.
Pole sumy icons. Ikona wyświetlana w widżecie na karcie. icons może być tylko jedną z tych wartości:
knownIcon

string

wyświetlać jedną z wbudowanych ikon dostępnych w Google Workspace;

Aby na przykład wyświetlić ikonę samolotu, podaj AIRPLANE. W przypadku autobusu wpisz BUS.

Pełną listę obsługiwanych ikon znajdziesz na stronie ikon wbudowanych.
iconUrl

string

Wyświetlaj ikonę niestandardową hostowaną pod adresem URL HTTPS.

Na przykład:

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

Obsługiwane typy plików to .png i .jpg.
materialIcon

MaterialIcon

Wyświetlaj jedną z ikon materiałów Google.

Aby na przykład wyświetlić ikonę pola wyboru, użyj

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

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Obraz

Obraz określony przez adres URL i który może mieć działanie onClick. Przykład: Dodawanie obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
imageUrl

string

Adres URL HTTPS hostujący obraz.

Na przykład:

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

OnClick

To działanie jest wywoływane, gdy użytkownik kliknie obraz.
altText

string

Tekst alternatywny tego obrazu, który jest używany na potrzeby ułatwień dostępu.

ImageComponent

Reprezentuje obraz.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
imageUri

string

Adres URL obrazu.
altText

string

Etykieta ułatwień dostępu dla obrazu.
cropStyle

ImageCropStyle

Styl przycinania obrazu.
borderStyle

BorderStyle

Styl obramowania, który ma być stosowany do obrazu.

ImageCropStyle

Reprezentuje styl przycinania zastosowany do obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Aby na przykład zastosować format obrazu 16:9:

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

ImageCropType

Typ przycinania.
aspectRatio

double

Format obrazu używany, gdy typ przycinania to RECTANGLE_CUSTOM.

Aby na przykład zastosować format obrazu 16:9:

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

ImageCropType

Reprezentuje styl przycinania zastosowany do obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
IMAGE_CROP_TYPE_UNSPECIFIED Nie używaj. Nie określono.
SQUARE Wartość domyślna. Przycina kwadratowe.
CIRCLE Powoduje przycięcie okrężne.
RECTANGLE_CUSTOM Powoduje zastosowanie prostokątnego przycięcia o niestandardowym współczynniku proporcji. Ustaw niestandardowy format obrazu za pomocą funkcji aspectRatio.
RECTANGLE_4_3 Zastosuje prostokątne przycięcie o współczynniku proporcji 4:3.

LinkPreview

Działanie karty, które pozwala wyświetlić podgląd linku innej firmy przez wyświetlenie karty i elementu inteligentnego. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Na przykład ten kod JSON zwraca unikalny tytuł podglądu linku i jego elementu inteligentnego oraz karty podglądu z nagłówkiem i opisem tekstowym:

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

W tym przykładzie zwracany jest następujący podgląd linku:

Podgląd przykładowego linku

Pola
previewCard

Card

Karta zawierająca informacje o linku z usługi innej firmy
title

string

Tytuł wyświetlany w elemencie inteligentnym w podglądzie linku. Jeśli nie jest, element inteligentny wyświetla nagłówek preview_card.
linkPreviewTitle

string

Tytuł wyświetlany w podglądzie linku. Jeśli nie jest skonfigurowana, w podglądzie linku wyświetla się nagłówek elementu preview_card.

MaterialIcon

Ikona Google Material, która zawiera ponad 2500 opcji.

Aby na przykład wyświetlić ikonę pola wyboru z niestandardową wagą i oceną, wpisz:

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

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Pola
name

string

Nazwa ikony zdefiniowana w ikonie Material Design, na przykład check_box. Nieprawidłowe nazwy są porzucane i zastępowane pustym ciągiem znaków, przez co ikona nie jest wyświetlana.
fill

bool

Określa, czy ikona wyświetla się jako wypełniona. Wartość domyślna to false (fałsz).

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj.
weight

int32

Grubość konturu ikony. Do wyboru masz {100, 200, 300, 400, 500, 600, 700}. Jeśli go brak, wartość domyślna to 400. Jeśli zostanie określona jakakolwiek inna wartość, zostanie użyta wartość domyślna.

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj.
grade

int32

Na grubość symbolu wpływa waga i stopień. Zmiany oceny są bardziej szczegółowe niż zmiany wagi i mają niewielki wpływ na wielkość symbolu. Wybierz wartość spośród {-25, 0, 200}. Jeśli go brak, wartość domyślna to 0. Jeśli zostanie określona jakakolwiek inna wartość, zostanie użyta wartość domyślna.

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj.

Działanie karty, które ma wpływ na stos kart.

Na przykład:

1) Dodaj do stosu nową kartę (przejdź dalej). W przypadku aplikacji do obsługi czatu ta opcja jest dostępna tylko na stronie głównej aplikacji.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

 navigations : {
    pushCard : CARD
  }

2) Ułóż kartę na górze stosu (aktualizacja).

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

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

3) Cofnij się o jeden krok bez aktualizacji.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

  navigations : {
    popCard : true,
  }

4) Cofnij się o kilka kroków i zaktualizuj kartę.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

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

5) Wróć do zdefiniowanego elementu CARD_NAME o kilku krokach.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

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

6) Wróć do poziomu głównego i zaktualizuj kartę.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

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

7) Przejdź na określoną kartę i ją umieść.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

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

8) Zastąp górną kartę nową kartą. W przypadku aplikacji do obsługi czatu ta opcja jest dostępna tylko na stronie głównej aplikacji.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

  navigations : {
    updateCard : CARD
  }
Pola

Pole sumy navigate_action.

navigate_action może być tylko jedną z tych wartości:
popToRoot

bool

Stos kart wyskakuje wszystkie karty oprócz karty głównej.
pop

bool

Stos kart odsuwa jedną.
popToCard

string

Stos kart wyświetla wszystkie karty z podaną nazwą powyżej określonej karty.
pushCard

Card

Stos kart umieszcza kartę na stosie.
updateCard

Card

Stos kart aktualizuje górną kartę o nową kartę i zachowuje wartości wypełnionych pól formularza. W przypadku pól, które nie są równoważne, wartość jest pomijana.
endNavigation

EndNavigation

Działanie zakończenia nawigacji w oknie dialogowym. Więcej informacji znajdziesz w artykule Odpowiadanie na wiadomości z karty głównej aplikacji.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Powiadomienie

Działanie karty, które powoduje wyświetlenie powiadomienia w aplikacji hosta.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Pola
text

string

Zwykły tekst wyświetlany w powiadomieniu, bez tagów HTML.

OnClick

Określa, jak odpowiedzieć, gdy użytkownik kliknie interaktywny element na karcie, np. przycisk.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola

Pole sumy data.

data może być tylko jedną z tych wartości:
action

Action

Jeśli zostanie określony, działanie jest wywoływane przez ten onClick.
openDynamicLinkAction

Action

Dodatek uruchamia to działanie, gdy trzeba otworzyć link. Różni się to od metody open_link powyżej tym, że uzyskanie linku wymaga komunikacji z serwerem. Z tego względu klient internetowy musi wykonać pewne czynności przygotowawcze, zanim pojawi się odpowiedź związana z otwartym linkiem.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
card

Card

Nowa karta jest przekazywana do stosu kart po kliknięciu, jeśli została podana.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

OnClose

Co robi klient, gdy link otwarty przez działanie OnClick zostanie zamknięty.

Implementacja zależy od możliwości platformy klienta. Na przykład przeglądarka może otworzyć link w wyskakującym okienku z modułem obsługi OnClose.

Jeśli ustawione są zarówno moduły obsługi OnOpen, jak i OnClose, a platforma kliencka nie obsługuje obu wartości, parametr OnClose ma pierwszeństwo.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Wartości w polu enum
NOTHING Wartość domyślna. Karta nie jest doładowywana i nic się nie dzieje.
RELOAD

Wczytuje ponownie kartę po zamknięciu okna podrzędnego.

W połączeniu z OpenAs.OVERLAY okno podrzędne działa jak okno modalne, a karta nadrzędna jest blokowana do czasu zamknięcia okna podrzędnego.

OpenAs

Gdy akcja OnClick otwiera link, klient może otworzyć go jako okno pełnowymiarowe (jeśli jest to ramka używana przez klienta) lub jako nakładkę (np. wyskakujące okienko). Implementacja zależy od możliwości platformy klienta, a wybrana wartość może zostać ignorowana, jeśli klient jej nie obsługuje. Usługa FULL_SIZE jest obsługiwana przez wszystkie klienty.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.

Wartości w polu enum
FULL_SIZE Link otwiera się jako okno pełnowymiarowe (jeśli jest to ramka używana przez klienta).
OVERLAY Link otwiera się jako nakładka, np. wyskakujące okienko.

RenderActions

Zestaw instrukcji renderowania, które informują kartę o wykonaniu działania lub informuje aplikację hostującą dodatek lub aplikację Google Chat o wykonanie działania związanego z aplikacją.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
action

Action
hostAppAction

HostAppActionMarkup

Działania obsługiwane przez poszczególne aplikacje hostujące.
schema

string

To jest pole schematu bez operacji, które może znajdować się w znacznikach na potrzeby sprawdzania składni.

Działanie

Pola
navigations[]

Navigation

Możesz przesuwać, wyróżniać i aktualizować wyświetlane karty.
notification

Notification

Wyświetl powiadomienie użytkownikowi.
linkPreview

LinkPreview

Wyświetl podgląd linku użytkownikowi.

SelectionInput

Widżet, który tworzy co najmniej 1 element interfejsu, który użytkownicy mogą wybrać. Może to być na przykład menu lub pola wyboru. Za pomocą tego widżetu możesz zbierać dane, które można prognozować lub wyliczać. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Dodawanie elementów interfejsu do wyboru.

Aplikacje do obsługi czatu mogą przetwarzać wartość elementów wybranych lub wprowadzonych przez użytkowników. Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.

Aby zbierać niezdefiniowane lub abstrakcyjne dane o użytkownikach, używaj widżetu TextInput.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Nazwa, która określa wybór w zdarzeniu wejścia formularza.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
label

string

Tekst, który pojawia się w interfejsie nad polem do wprowadzania wyboru.

Wpisz tekst, który pomoże użytkownikowi wpisać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład użytkownicy wybierają z menu pilność zgłoszenia do pracy, etykieta może mieć wartość „Pilne” lub „Wybierz pilne”.
type

SelectionType

Typ elementów wyświetlanych użytkownikom w widżecie SelectionInput. Typy wyboru obsługują różne typy interakcji. Na przykład użytkownicy mogą zaznaczyć jedno lub więcej pól wyboru, ale tylko jedną wartość w menu.
items[]

SelectionItem

Tablica elementów do wyboru. Może to być na przykład tablica przycisków opcji lub pól wyboru. Obsługuje do 100 elementów.
onChangeAction

Action

Jeśli określisz, formularz zostanie przesłany, gdy wybór ulegnie zmianie. Jeśli go nie podasz, musisz określić osobny przycisk służący do przesyłania formularza.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
multiSelectMaxSelectedItems

int32

W przypadku menu wielokrotnego wyboru jest to maksymalna liczba elementów, które użytkownik może wybrać. Minimalna wartość to 1 element. Jeśli nie określono inaczej, domyślnie są to 3 elementy.
multiSelectMinQueryLength

int32

W przypadku menu wyboru wielokrotnego jest to liczba znaków tekstowych wpisanych przez użytkownika przed autouzupełnieniem zapytania aplikacji i wyświetlenie sugerowanych elementów w menu.

Jeśli nie określono inaczej, domyślnie jest to 0 znaków w przypadku statycznych źródeł danych i 3 znaki w przypadku zewnętrznych źródeł danych.

Pole sumy multi_select_data_source. W przypadku menu wielokrotnego wyboru jest to źródło danych, które wypełnia elementy wyboru.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace. multi_select_data_source może być tylko jedną z tych wartości:
externalDataSource

Action

Zewnętrzne źródło danych, np. relacyjna baza danych.
platformDataSource

PlatformDataSource

Źródło danych z Google Workspace.

PlatformDataSource

W przypadku widżetu SelectionInput, który korzysta z menu wielokrotnego wyboru, jest to źródło danych z Google Workspace. Służy do wypełniania elementów w menu wielokrotnego wyboru.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Pola
Pole sumy data_source. Źródło danych. data_source może być tylko jedną z tych wartości:
commonDataSource

CommonDataSource

Źródło danych udostępniane przez wszystkie aplikacje Google Workspace, w tym przez użytkowników w organizacji Google Workspace.
hostAppDataSource

HostAppDataSourceMarkup

Źródło danych unikalne dla aplikacji hosta Google Workspace, takiej jak pokoje w Google Chat.

CommonDataSource

Źródło danych współdzielone przez wszystkie aplikacje Google Workspace.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Wartości w polu enum
UNKNOWN Wartość domyślna. Nie używaj.
USER Użytkownicy Google Workspace. Użytkownik może tylko wyświetlać i wybierać użytkowników z organizacji Google Workspace.

SelectionItem

Element, który użytkownicy mogą wybrać w ramach zaznaczenia, np. pole wyboru lub przełącznik.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst, który określa lub opisuje produkt użytkownikom.
value

string

Wartość powiązana z tym elementem. Klient powinien użyć jej jako wartości wejściowej formularza.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
selected

bool

Określa, czy element jest wybrany domyślnie. Jeśli dane wejściowe wyboru akceptują tylko jedną wartość (np. dla przycisków lub menu), ustaw to pole tylko dla 1 elementu.
startIconUri

string

W przypadku menu wyboru wielokrotnego jest to adres URL ikony wyświetlany obok pola text elementu. Obsługuje pliki PNG i JPEG. Musi to być adres URL w formacie HTTPS. Na przykład: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
bottomText

string

W przypadku menu wielokrotnego wyboru jest to opis tekstowy lub etykieta wyświetlana pod polem text elementu.

SelectionType

Format elementów, które użytkownicy mogą wybierać. Różne opcje obsługują różne typy interakcji. Na przykład użytkownicy mogą zaznaczyć wiele pól wyboru, ale tylko jeden element z menu.

Każde pole wyboru obsługuje 1 typ wyboru. Nie obsługuje na przykład mieszania pól wyboru i przełączników.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
CHECK_BOX Zestaw pól wyboru. Użytkownicy mogą zaznaczyć jedno lub więcej pól wyboru.
RADIO_BUTTON Zestaw opcji. Użytkownicy mogą wybrać 1 przycisk.
SWITCH Zestaw przełączników. Użytkownicy mogą włączyć co najmniej 1 przełącznik.
DROPDOWN Menu. Użytkownicy mogą wybrać w menu 1 element.
MULTI_SELECT

Menu wielokrotnego wyboru na potrzeby danych statycznych lub dynamicznych. Na pasku menu użytkownicy wybierają co najmniej 1 element. Użytkownicy mogą też wpisywać wartości, aby wypełnić dane dynamiczne. Użytkownicy mogą na przykład zacząć wpisywać nazwę pokoju w Google Chat, a widżet automatycznie zasugeruje pokój.

Aby wypełnić elementy w menu wyboru wielokrotnego, możesz użyć jednego z tych typów źródeł danych:

  • Dane statyczne: elementy są określane w widżecie jako obiekty SelectionItem. Maksymalnie 100 elementów.
  • Dane Google Workspace: elementy są wypełniane na podstawie danych z Google Workspace, takich jak użytkownicy Google Workspace czy pokoje czatu.
  • Dane zewnętrzne: elementy są pobierane z zewnętrznego źródła danych spoza Google Workspace.

Przykłady implementacji menu wyboru wielokrotnego znajdziesz w artykule Dodawanie menu wyboru wielokrotnego.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Wybór wielokrotny dla dodatków do Google Workspace jest dostępny w wersji przedpremierowej dla programistów.

SubmitFormResponse

Odpowiedź na przesłanie formularza inną niż pobranie kontenera autouzupełniania zawierającego działania, które powinna wykonać karta lub aplikacja hostująca dodatek, a także informacje o tym, czy stan karty uległ zmianie.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. Na przykład:

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

RenderActions

Zestaw instrukcji renderowania, które informują kartę o wykonaniu działania lub informuje aplikację będącą hostem dodatku, aby wykonała działanie związane z aplikacją.
stateChanged

bool

Wskazuje, czy stan kart się zmienił, a dane istniejących kart są nieaktualne.
schema

string

To jest pole schematu bez operacji, które może znajdować się w znacznikach na potrzeby sprawdzania składni.

Sugestie

Sugerowane wartości, które użytkownicy mogą wpisywać. Te wartości pojawiają się, gdy użytkownik kliknie wewnątrz pola do wprowadzania tekstu. Gdy użytkownik wpisuje tekst, sugerowane wartości są dynamicznie filtrowane na podstawie wpisywanego przez niego tekstu.

Na przykład w polu do wprowadzania tekstu w języku programowania możesz zobaczyć propozycje Javy, JavaScriptu, Pythona i C++. Gdy użytkownik zacznie pisać Jav, pojawi się lista filtrów sugestii, które wyświetlą Java i JavaScript.

Sugerowane wartości pomagają kierować użytkowników do wpisywania wartości, które są zrozumiałe dla aplikacji. W odniesieniu do języka JavaScript niektórzy użytkownicy mogą wpisywać javascript, a inni java script. Sugerowanie JavaScript może ujednolicić sposób interakcji użytkowników z aplikacją.

Jeśli została określona, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawiona na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
items[]

SuggestionItem

Lista sugestii używanych do autouzupełniania rekomendacji w polach do wprowadzania tekstu.

SuggestionItem

Jedna sugerowana wartość, którą użytkownicy mogą wpisać w polu do wprowadzania tekstu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola

Pole sumy content.

content może być tylko jedną z tych wartości:
text

string

Wartość sugerowanej wartości wejściowej w polu do wprowadzania tekstu. Jest to odpowiednik strony wpisywanej przez użytkownika.

TextInput

Pole, w którym użytkownicy mogą wpisywać tekst. Obsługuje sugestie i działania związane ze zmianą. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Dodawanie pola, w którym użytkownik może wpisywać tekst.

Aplikacje do obsługi czatu odbierają i mogą przetwarzać wartość wpisanego tekstu podczas zdarzeń wprowadzania danych w formularzu. Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.

Jeśli chcesz zbierać niezdefiniowane lub abstrakcyjne dane o użytkownikach, używaj tekstu do wprowadzania danych. Aby zbierać określone lub wyliczane dane użytkowników, używaj widżetu SelectionInput.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Nazwa, pod którą wpisywane są dane w zdarzeniu do wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
label

string

Tekst, który pojawia się nad polem wprowadzania tekstu w interfejsie.

Wpisz tekst, który pomoże użytkownikowi wpisać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład pytasz kogoś o imię, ale potrzebujesz imienia i nazwiska, zamiast name wpisz surname.

Wymagane, jeśli hintText nie jest określony. W przeciwnym razie opcjonalne.
hintText

string

Tekst wyświetlany poniżej pola do wprowadzania tekstu, który ma pomóc użytkownikom przez prośbę o wpisanie określonej wartości. Ten tekst jest zawsze widoczny.

Wymagane, jeśli label nie jest określony. W przeciwnym razie opcjonalne.
value

string

Wartość wpisana przez użytkownika, zwrócona w ramach zdarzenia wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularzy znajdziesz w artykule Odbieranie danych formularzy.
type

Type

Sposób wyświetlania pola do wprowadzania tekstu w interfejsie. np. czy pole jest jednowierszowe czy wielowierszowe.
onChangeAction

Action

Co zrobić, gdy zmiana wprowadzona w polu wprowadzania tekstu Na przykład użytkownik dodaje informacje do pola lub usuwa tekst.

Może to być na przykład uruchomienie funkcji niestandardowej lub otwarcie okna w Google Chat.
initialSuggestions

Suggestions

Sugerowane wartości, które użytkownicy mogą wpisywać. Te wartości pojawiają się, gdy użytkownik kliknie wewnątrz pola do wprowadzania tekstu. Gdy użytkownik wpisuje tekst, sugerowane wartości są dynamicznie filtrowane na podstawie wpisywanego przez niego tekstu.

Na przykład w polu do wprowadzania tekstu w języku programowania możesz zobaczyć propozycje Javy, JavaScriptu, Pythona i C++. Gdy użytkownik zacznie wpisywać Jav, lista filtrów sugestii wyświetli tylko Java i JavaScript.

Sugerowane wartości pomagają kierować użytkowników do wpisywania wartości, które są zrozumiałe dla aplikacji. W odniesieniu do języka JavaScript niektórzy użytkownicy mogą wpisywać javascript, a inni java script. Sugerowanie JavaScript może ujednolicić sposób interakcji użytkowników z aplikacją.

Jeśli została określona, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawiona na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
autoCompleteAction

Action

Opcjonalnie. Określ działanie, które ma być wykonywane, gdy pole wprowadzania tekstu zawiera sugestie użytkownikom, którzy z niego korzystają.

Jeśli nie określono inaczej, sugestie są ustawiane przez initialSuggestions i przetwarzane przez klienta.

Jeśli zostanie określone, aplikacja podejmuje określone tu działanie, na przykład uruchamia funkcję niestandardową.

Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
placeholderText

string

Tekst, który pojawia się w polu do wprowadzania tekstu, gdy pole jest puste. Użyj tego tekstu, aby prosić użytkowników o wpisanie wartości. Na przykład: Enter a number from 0 to 100.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Typ

Sposób wyświetlania pola do wprowadzania tekstu w interfejsie. np. jednowierszowe czy wielowierszowe. Jeśli określono initialSuggestions, type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawiona na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SINGLE_LINE Pole do wprowadzania tekstu ma stałą wysokość 1 wiersza.
MULTIPLE_LINE Pole do wprowadzania tekstu ma stałą wysokość wielu wierszy.

TextParagraph

Akapit tekstu, który obsługuje formatowanie. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie akapitu sformatowanego tekstu. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst widoczny w widżecie.

Widżet

Każda karta składa się z widżetów.

Widżet to obiekt złożony, który może reprezentować jeden z tekstów, obrazów, przycisków i innych typów obiektów.

Pola
horizontalAlignment

HorizontalAlignment

Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny.
Pole sumy data. Widżet może zawierać tylko jeden z poniższych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól widżetu. data może być tylko jedną z tych wartości:
textParagraph

TextParagraph

Wyświetla akapit tekstu. Obsługuje prosty tekst w formacie HTML. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

Na przykład ten kod JSON tworzy pogrubienie tekstu:

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

Image

Wyświetla obraz.

Na przykład ten kod JSON tworzy obraz z tekstem alternatywnym:

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

DecoratedText

Wyświetla ozdobiony element tekstowy.

Na przykład poniższy kod JSON tworzy ozdobny widżet tekstowy z adresem e-mail:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

Lista przycisków.

Poniższy przykładowy kod JSON tworzy 2 przyciski. Pierwszy to niebieski przycisk tekstowy, a drugi to przycisk graficzny, którego kliknięcie otwiera link:

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

TextInput

Wyświetla pole tekstowe, w którym użytkownicy mogą pisać.

Na przykład ten kod JSON tworzy pole tekstowe do wpisania adresu e-mail:

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

W kolejnym przykładzie ten kod JSON tworzy dane wejściowe na potrzeby języka programowania ze statycznymi sugestiami:

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

SelectionInput

Wyświetla element sterujący, który pozwala użytkownikom wybierać elementy. Elementami sterującymi mogą być pola wyboru, przyciski, przełączniki lub menu.

Na przykład ten kod JSON tworzy menu, które pozwala użytkownikom wybrać rozmiar:

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

DateTimePicker

Wyświetla widżet, który umożliwia użytkownikom wpisywanie daty, godziny lub daty i godziny.

Na przykład ten kod JSON tworzy selektor daty i godziny, aby zaplanować spotkanie:

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

Divider

Wyświetla linię poziomą między widżetami.

Na przykład następujący kod JSON tworzy separator:

"divider": {
}
grid

Grid

Wyświetla siatkę z kolekcją elementów.

Siatka może zawierać dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez górne granice elementów, które są podzielone przez liczbę kolumn. Siatka zawierająca 10 elementów i 2 kolumny ma 5 wierszy. Siatka z 11 elementami i 2 kolumnami ma 6 wierszy.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Na przykład ten kod JSON tworzy siatkę z 2 kolumnami z 1 elementem:

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

Columns

Wyświetla do 2 kolumn.

Aby uwzględnić więcej niż 2 kolumny lub użyć wierszy, użyj widżetu Grid.

Na przykład ten plik JSON tworzy 2 kolumny, z których każda zawiera akapity tekstu:

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

HorizontalAlignment

Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny.

Dostępne w aplikacjach Google Chat. Nie są dostępne w przypadku dodatków do Google Workspace.

Wartości w polu enum
HORIZONTAL_ALIGNMENT_UNSPECIFIED Nie używaj. Nie określono.
START Wartość domyślna. Wyrównuje widżety do pozycji początkowej kolumny. W przypadku układów od lewej do prawej wyrównuje do lewej. W przypadku układów od prawej do lewej wyrównuje się do prawej.
CENTER Wyrównuje widżety do środka kolumny.
END Wyrównuje widżety do pozycji końcowej kolumny. W przypadku układów od lewej do prawej wyrównuje widżety do prawej. W przypadku układów od prawej do lewej wyrównuje widżety do lewej strony.

ImageType

Kształt użyty do przycięcia obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SQUARE Wartość domyślna. Stosuje do obrazu kwadratową maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się na 3 x 3.
CIRCLE Stosuje do obrazu okrągłą maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się w koło o średnicy 3.