Package google.apps.card.v1

string

Funkcja niestandardowa wywoływana po kliknięciu lub w inny sposób aktywowanego elementu zawierającego jej treść.

Przykładowe zastosowanie znajdziesz w sekcji Czytanie danych z formularza.

ActionParameter

Lista parametrów działania.

LoadIndicator

Określa wskaźnik ładowania wyświetlany podczas wywoływania działania.

bool

Wskazuje, czy wartości formularza utrzymują się po wykonaniu działania. Wartością domyślną jest false.

Jeśli true, wartości w formularzu pozostają po wywołaniu działania. Aby umożliwić użytkownikowi wprowadzanie zmian w trakcie przetwarzania działania, ustaw LoadIndicator na NONE. W przypadku wiadomości z karty w aplikacjach do obsługi czatu musisz też ustawić ResponseType na UPDATE_MESSAGE i użyć tej samej wartości card_id z karty zawierającej działanie.

Jeśli false, wartości formularza są wyczyszczane po uruchomieniu działania. Aby uniemożliwić użytkownikowi wprowadzanie zmian w trakcie przetwarzania działania, ustaw opcję LoadIndicator na SPINNER.

Interaction

Opcjonalnie: Wymagane przy otwieraniu okna.

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

Jeśli nie zostanie określony, aplikacja zareaguje, wykonując action (np. otwierając link lub wykonując funkcję) w zwykły sposób.

Po określeniu interaction aplikacja może reagować w specjalny sposób. Na przykład ustawienie interaction na OPEN_DIALOG może spowodować otwarcie okna. Jeśli jest określone, wskaźnik wczytywania nie jest wyświetlany. Jeśli określisz dodatek w przypadku dodatku, cała karta będzie usunięta i nic nie będzie widoczne w kliencie.

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

string

Jeśli podczas wywołania tego działania widżety wymienione w tym miejscu nie mają wartości, przesłanie formularza zostanie przerwane.

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

bool

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

string

Nazwa parametru skryptu działania.

string

Wartość parametru.

BorderType

Typ obramowania.

Color

Kolory, których należy używać, gdy typ to BORDER_TYPE_STROKE.

Aby ustawić kolor obrysu, podaj wartości pól red, green i blue. Wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 1 na podstawie wartości koloru RGB, gdzie 0 (0/255) oznacza brak koloru, a 1 (255/255) – maksymalną intensywność koloru.

Na przykład ten kod ustawia kolor czerwony z maksymalną intensywnością:

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

Pole alpha jest niedostępne w przypadku koloru obrysu. Jeśli jest określone, to pole jest ignorowane.

int32

Promień zaokrąglenia rogów obramowania.

string

Tekst wyświetlany na przycisku.

Icon

Ikona wyświetlana na przycisku. Jeśli ustawione są zarówno icon, jak i text, ikona pojawia się przed tekstem.

Color

Opcjonalnie: Kolor przycisku. Jeśli zasada jest skonfigurowana, przycisk type ma wartość FILLED, a kolor pól text i icon jest ustawiony na kontrast, aby zwiększyć czytelność. Jeśli np. kolor przycisku jest ustawiony na niebieski, tekst lub ikony w przycisku są białe.

Aby ustawić kolor przycisku, podaj wartość w polach red, green i blue. Wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 1 obliczoną na podstawie wartości koloru RGB, gdzie 0 (0/255) oznacza brak koloru, a 1 (255/255) reprezentuje jego maksymalną intensywność.

Na przykład ten kod ustawia kolor czerwony z maksymalną intensywnością:

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

Pole alpha jest niedostępne w przypadku koloru przycisku. Jeśli pole jest określone, jest ignorowane.

OnClick

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

bool

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

string

Tekst zastępczy używany do ułatwień dostępu.

Ustaw tekst opisowy, który informuje 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 Google Chat dla deweloperów na https://developers.google.com/workspace/chat"”.

Type

Opcjonalnie: Typ przycisku. Jeśli nie jest skonfigurowana, domyślnym typem przycisku jest OUTLINED. Jeśli pole color ma ustawioną wartość, typ przycisku jest narzucony jako FILLED, a jakakolwiek wartość ustawiona w tym polu jest ignorowana.

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

Button

Tablica przycisków.

CardHeader

Nagłówek karty. Nagłówek zwykle zawiera obraz początkowy i tytuł. Nagłówki zawsze wyświetlają się u góry karty.

Section

Zawiera kolekcję widżetów. Każda sekcja ma swój opcjonalny nagłówek. Sekcje są wizualnie oddzielone linią. Przykład w przypadku aplikacji Google Chat znajdziesz w sekcji Definiowanie sekcji karty.

DividerStyle

Styl separatora między nagłówkiem, sekcjami a stopką.

CardAction

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

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

Na przykład ten fragment kodu JSON tworzy menu działania karty z opcjami Settings i Send Feedback:

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

string

Nazwa karty. Używany jako identyfikator karty w nawigacji po kartach.

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

CardFixedFooter

U dołu tej karty znajduje się stały stopka.

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 wiadomości kart.

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

DisplayStyle

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

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach Google Chat.

CardHeader

Podczas wyświetlania treści kontekstowych nagłówek karty podglądu działa jako element zastępczy, dzięki czemu użytkownik może przełączać się między kartami na stronie głównej a kartami kontekstowymi.

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach Google Chat.

string

Etykieta wyświetlana jako element menu działania.

OnClick

Działanie onClick dotyczące tego elementu czynności.

Button

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

Button

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

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 po jednym wierszu. Jeśli podany jest tylko tytuł, zajmuje on obie linie.

string

Podtytuł nagłówka karty. Jeśli jest określony, pojawia się w osobnym wierszu pod title.

ImageType

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

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

string

Adres URL HTTPS obrazu w nagłówku karty.

string

Alternatywny tekst tego obrazu używany w ułatwieniach dostępu.

string

Tekst wyświetlany 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.

Widget

wszystkie widżety w sekcji. Musi zawierać co najmniej 1 widżet.

bool

Wskazuje, czy tę sekcję można zwijać.

Zwijane sekcje ukrywają niektóre lub wszystkie widżety, ale użytkownicy mogą rozwinąć sekcję, aby zobaczyć 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, użyj parametru uncollapsibleWidgetsCount.

int32

Liczba widżetów niezwijanych, które pozostają widoczne nawet po zwinięciu sekcji.

Jeśli na przykład sekcja zawiera pięć widżetów, a uncollapsibleWidgetsCount ma wartość 2, pierwsze dwa widżety są zawsze wyświetlane, a trzy ostatnie są domyślnie zwinięte. Wartość uncollapsibleWidgetsCount jest brana pod uwagę tylko wtedy, gdy pole collapsible ma wartość true.

CollapseControl

Opcjonalnie: Zdefiniuj przycisk rozwijania i zwijania sekcji. Ten przycisk jest widoczny tylko w przypadku zwijania sekcji. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny. Dostępny w aplikacjach Google Chat i niedostępny w przypadku dodatków do Google Workspace.

Icon

Obraz ikony. Jeśli ustawisz parametry icon i text, ikona pojawi się przed tekstem.

string

Tekst wyświetlany w elemencie.

OnClick

Opcjonalnie: Działanie, które ma być wykonywane po kliknięciu elementu przez użytkownika, na przykład otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.

bool

Czy element jest aktywny i reaguje na działania użytkownika. Domyślna wartość to true. Rola wycofana. Zamiast tego użyj disabled.

bool

Określa, czy element jest nieaktywny i ignoruje działania użytkownika. Domyślna wartość to false.

string

Tekst alternatywny używany w ułatwieniach dostępu.

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

Layout

Określony układ listy elementów.

Chip

Tablica elementów.

HorizontalAlignment

Ustawienie poziome przycisku rozwijania i zwijania.

Button

Opcjonalnie: Zdefiniuj przycisk konfigurowalny, aby rozwinąć tę sekcję. Należy ustawić pola expand_button i collapse_button. Tylko 1 z nich nie zostanie zastosowany. Jeśli to pole nie jest ustawione, używany jest przycisk domyślny.

Button

Opcjonalnie: Zdefiniuj konfigurowalny przycisk, aby zwinąć sekcję. Trzeba ustawić zarówno poleexpand_button, jak i Zwiń_button. Tylko jedno ustawienie pola nie będzie działać. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Column

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

HorizontalSizeStyle

Określa, jak kolumna wypełnia szerokość karty.

HorizontalAlignment

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

VerticalAlignment

Określa, czy widżety mają się znajdować na górze, na dole czy na środku kolumny.

Widgets

Tablica widżetów w kolumnie. Widżety są wyświetlane w kolejności, w jakiej zostały określone.

TextParagraph

Widżet TextParagraph.

Image

Widżet Image.

DecoratedText

Widżet DecoratedText.

ButtonList

Widżet ButtonList.

TextInput

Widżet TextInput.

SelectionInput

Widżet SelectionInput.

DateTimePicker

Widżet DateTimePicker.

ChipList

Widżet ChipList. Dostępny w aplikacjach Google Chat i niedostępny w przypadku dodatków do Google Workspace.

string

Nazwa, pod którą element DateTimePicker jest identyfikowany w zdarzeniu wprowadzania danych w formularzu.

Szczegółowe informacje na temat pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych formularza.

string

Tekst, który zachęca użytkowników do wpisania 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.

DateTimePickerType

Określa, czy widżet umożliwia wpisywanie daty, godziny lub daty i godziny.

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 w kalendarzu w czasie UTC. Na przykład 1 stycznia 2023 r., godz. 12:00 czasu UTC zapisz w ten sposób: 1672574400000.
• DATE_ONLY: data kalendarzowa o godzinie 00:00:00 UTC. Na przykład, aby wskazać 1 stycznia 2023 r., użyj wartości 1672531200000.
• TIME_ONLY: czas w strefie czasowej UTC. Na przykład aby określić godzinę 12:00, użyj wartości 43200000 (lub 12 * 60 * 60 * 1000).

int32

Liczba reprezentująca przesunięcie strefy czasowej od czasu UTC (w minutach). Jeśli jest ustawiona, value_ms_epoch jest wyświetlany w określonej strefie czasowej. Jeśli nie jest skonfigurowana, przyjmuje się domyślne ustawienie strefy czasowej użytkownika.

Action

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

Validation

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

Icon

Wycofane na rzecz startIcon.

Icon

Ikona wyświetlana przed tekstem.

string

Tekst widoczny nad elementem text. Zawsze skraca.

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.

bool

Ustawienie zawijania tekstu. W przypadku true tekst zawija się i wyświetla w kilku wierszach. W przeciwnym razie tekst zostanie obcięty.

Dotyczy tylko funkcji text, a nie topLabel i bottomLabel.

string

Tekst, który wyświetla się pod text. Zawsze zawija.

OnClick

To działanie jest wywoływane, gdy użytkownicy klikną topLabel lub bottomLabel.

Button

Przycisk, który użytkownik może kliknąć, aby wykonać określone działanie.

SwitchControl

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

Icon

Ikona wyświetlana po tekście.

Obsługuje ikony wbudowane i niestandardowe.

string

Nazwa, pod którą widżet przełącznika jest identyfikowany w zdarzeniu wprowadzania danych w formularzu.

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

string

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

Szczegółowe informacje na temat pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych formularza.

bool

Gdy true, przełącznik jest wybrany.

Action

Działanie, które ma zostać wykonane po zmianie stanu przełącznika, np. jaka funkcja ma zostać uruchomiona.

ControlType

Jak przełącznik wygląda w interfejsie

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

string

Tekst wyświetlany w nagłówku siatki.

GridItem

Elementy wyświetlane w siatce.

BorderStyle

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

int32

Liczba kolumn wyświetlanych w siatce. Jeśli to pole nie jest określone, używana jest wartość domyślna. Zależy ona od tego, gdzie wyświetla się siatka (dialog czy reklama towarzysząca).

OnClick

To wywołanie zwrotne jest ponownie używane przez każdy element siatki, ale z identyfikatorem i indeksem elementu na liście elementów dodanymi do parametrów wywołania zwrotnego.

string

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

ImageComponent

Obraz wyświetlany w elemencie siatki.

string

Tytuł elementu siatki.

string

Podtytuł elementu siatki.

GridItemLayout

Układ, który ma być używany w elemencie siatki.

string

Opcjonalnie: Opis ikony używanej w ułatwieniach dostępu. Jeśli wartość nie została podana, zostanie użyta wartość domyślna Button. Zgodnie ze sprawdzoną metodą należy podać opis, który wyjaśnia, co przedstawia ikona, oraz, w stosownych przypadkach, co ona robi. 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, gdy użytkownik najedzie na przycisk, altText pojawi się jako tekst pomocniczy. Jeśli jednak przycisk ustawia też wartość text, ikona altText zostanie zignorowana.

ImageType

Styl przycinania zastosowany do obrazu. W niektórych przypadkach zastosowanie funkcji przycinania CIRCLE powoduje, że obraz jest wyświetlany większy niż wbudowana ikona.

string

Wyświetl jedną z wbudowanych ikon Google Workspace.

Aby na przykład wyświetlić ikonę samolotu, użyj wartości AIRPLANE. W przypadku autobusu wpisz BUS.

Pełną listę obsługiwanych ikon znajdziesz tutaj.

string

wyświetlać ikonę niestandardową 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

Wyświetl jedną z ikon Google Material.

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

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

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

string

Adres URL HTTPS, na którym hostowany jest obraz.

Na przykład:

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

OnClick

Gdy użytkownik kliknie obraz, kliknięcie spowoduje to działanie.

string

Tekst alternatywny obrazu, który służy do ułatwień dostępu.

string

Adres URL obrazu.

string

Etykieta ułatwień dostępu do obrazu.

ImageCropStyle

Styl przycinania, który zostanie zastosowany do obrazu.

BorderStyle

Styl obramowania, który ma zostać zastosowany do obrazu.

ImageCropType

Typ przycięcia.

double

Format obrazu, który ma być użyty, jeśli typ przycięcia to RECTANGLE_CUSTOM.

Oto przykład zastosowania formatu 16:9:

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

string

Nazwa ikony zdefiniowana w ikonie Google Material, na przykład check_box. Nieprawidłowe nazwy są pomijane i zastępowane pustym ciągiem, co powoduje, że ikona nie jest renderowana.

bool

Określa, czy ikona jest wypełniona. Wartość domyślna to false (fałsz).

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

int32

Grubość konturu ikony. Masz do wyboru opcje: {100, 200, 300, 400, 500, 600, 700}. Jeśli go nie podano, domyślną wartością jest 400. Jeśli podasz inną wartość, zostanie użyta wartość domyślna.

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

int32

Grubość linii symbolu zależy od wagi i grubości. Zmiany oceny są bardziej szczegółowe niż korekty wagi i mają niewielki wpływ na wielkość symbolu. Wybierz jedną z wartości {-25, 0, 200}. Jeśli go nie podano, domyślną wartością jest 0. Jeśli podasz inną wartość, zostanie użyta wartość domyślna.

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

Action

Jeśli określisz działanie, onClick będzie wyzwalać określone działanie.

OpenLink

Jeśli jest określony, onClick powoduje działanie otwarcia linku.

Action

Dodatek wyzwala to działanie, gdy wymagane jest otwarcie linku. Różni się to od open_link powyżej, ponieważ w tym przypadku musi ono komunikować się z serwerem, aby uzyskać link. Z tego względu klient internetowy musi wykonać pewne czynności przygotowawcze, zanim otrzyma odpowiedź działania związaną z otwartym linkiem.

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

Card

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

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach Google Chat.

OverflowMenu

Jeśli jest to określone, onClick otwiera menu przewijania. Dostępny w aplikacjach Google Chat i niedostępny w przypadku dodatków do Google Workspace.

string

Adres URL do otwarcia.

OpenAs

Jak otworzyć link.

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach Google Chat.

OnClose

Czy klient zapomina o linku po jego otwarciu, czy obserwuje go do czasu zamknięcia okna.

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach Google Chat.

OverflowMenuItem

Wymagane. Lista opcji menu.

Icon

Ikona wyświetlana przed tekstem.

string

Wymagane. Tekst, który identyfikuje lub opisuje produkt dla użytkowników.

OnClick

Wymagane. Działanie wywoływane po wybraniu opcji menu. Ten element OnClick nie może zawierać elementu OverflowMenu, więc wszystkie określone elementy OverflowMenu zostaną usunięte, a element menu zostanie wyłączony.

bool

Określa, czy opcja menu jest wyłączona. Wartość domyślna to fałsz.

string

Wymagane. Nazwa identyfikująca dane wejściowe w zdarzeniu danych wejściowych w formularzu.

Szczegółowe informacje na temat pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych formularza.

string

Tekst wyświetlany nad polem wyboru w interfejsie.

Podaj tekst, który pomoże użytkownikowi podać 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ć etykietę „Pilne”. lub „Wybierz pilność”.

SelectionType

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

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.

Action

Jeśli określisz formularz, zostanie on przesłany po zmianie wyboru. Jeśli nie określisz tego parametru, musisz podać oddzielny przycisk, który przesyła formularz.

Szczegółowe informacje na temat pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych formularza.

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ślna wartość to 3 elementy.

int32

W przypadku menu wielokrotnego wyboru liczba znaków, które użytkownik wpisze, zanim aplikacja wyśle zapytanie do użytkownika, jest uzupełniana automatycznie i wyświetla sugerowane elementy w menu.

Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość 0 w przypadku źródeł danych statycznych i 3 w przypadku źródeł danych zewnętrznych.

Validation

Weryfikacja tego pola wyboru w przypadku menu rozwijanych.

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

Action

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

PlatformDataSource

Źródło danych z Google Workspace.

CommonDataSource

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

HostAppDataSourceMarkup

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

To pole obsługuje biblioteki klienta interfejsów API Google, ale nie jest dostępne w bibliotekach klienta Cloud. Więcej informacji znajdziesz w sekcji Instalowanie bibliotek klienta.

string

Tekst, który identyfikuje lub opisuje produkt użytkownikom.

string

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

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

bool

Określa, czy element jest wybierany domyślnie. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków lub menu), ustaw to pole tylko dla 1 elementu.

string

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

string

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

SuggestionItem

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

string

Wartość sugerowanej wartości wejściowej w polu do wprowadzania tekstu. Jest to odpowiednik informacji wpisywanych przez użytkowników.

string

Nazwa, za pomocą której pole tekstowe jest identyfikowane w zdarzeniu wprowadzania danych w formularzu.

Szczegółowe informacje na temat pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych formularza.

string

Tekst wyświetlany nad polem tekstowym w interfejsie.

Podaj tekst, który pomoże użytkownikowi podać informacje wymagane przez aplikację. Jeśli na przykład chcesz zapytać kogoś o imię i nazwisko, wpisz surname zamiast name.

Wymagany, jeśli atrybut hintText nie jest określony. W przeciwnym razie jest to opcjonalne.

string

Tekst wyświetlany pod polem tekstowym, który ma pomóc użytkownikom w wpisaniu określonej wartości. Ten tekst jest zawsze widoczny.

Wymagany, jeśli atrybut label nie jest określony. W przeciwnym razie jest to opcjonalne.

string

Wartość wpisana przez użytkownika, zwracana w ramach zdarzenia wprowadzenia danych w formularzu.

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

Type

Jak pole tekstowe wygląda w interfejsie Na przykład czy pole jest jedno- czy wielowierszowe.

Action

Co zrobić, gdy nastąpi zmiana w polu do wprowadzania tekstu Może to być na przykład dodanie tekstu do pola lub jego usunięcie.

Przykłady działań to m.in. wykonanie funkcji niestandardowej lub otwarcie okna w Google Chat.

Suggestions

Sugerowane wartości, które użytkownicy mogą wpisać. Te wartości pojawiają się po kliknięciu przez użytkownika pola do wprowadzania tekstu. Gdy użytkownicy wpisują tekst, sugerowane wartości są dynamicznie filtrowane, aby pasowały do tego, co wpisują.

Na przykład pole tekstowe do wprowadzania języka programowania może sugerować Java, JavaScript, Python i C++. Gdy użytkownicy zaczną pisać Jav, lista sugestii zostanie odfiltrowana, aby wyświetlić tylko Java i JavaScript.

Sugerowane wartości pomagają zachęcać użytkowników do wpisywania wartości, które Twoja aplikacja może zrozumieć. W przypadku JavaScriptu niektórzy użytkownicy mogą wpisać javascript, a inne java script. Sugestia JavaScript może ustandaryzować sposób, w jaki użytkownicy korzystają z aplikacji.

Gdy jest to określone, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawione na MULTIPLE_LINE.

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

Action

Opcjonalnie: Określ, co ma się stać, gdy pole do wprowadzania tekstu będzie podpowiadać użytkownikom, którzy z niego korzystają.

Jeśli nie podasz sugestii, zostaną one ustawione przez initialSuggestions i przetworzone przez klienta.

Jeśli jest określony, aplikacja wykonuje tutaj określone działanie, np. wywołuje funkcję niestandardową.

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

Validation

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

string

Tekst, który pojawia się w polu tekstowym, gdy jest puste. Wpisz w nim wartość, korzystając z tego tekstu. Na przykład: Enter a number from 0 to 100.

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

string

Tekst wyświetlany w widżecie.

int32

Maksymalna liczba wierszy tekstu wyświetlanych w widżecie. Jeśli tekst przekracza maksymalną liczbę wierszy, nadmiarowe treści są ukryte za pomocą przycisku Pokaż więcej. Jeśli tekst jest równy lub krótszy niż określona maksymalna liczba wierszy, przycisk Pokaż więcej nie będzie widoczny.

Wartość domyślna to 0. W takim przypadku widoczny jest cały kontekst. Wartości ujemne są ignorowane. Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

int32

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

InputType

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

HorizontalAlignment

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

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 następujący kod JSON tworzy pogrubiony tekst:

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

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

Wyświetla ozdobiony element tekstowy.

Na przykład ten plik JSON tworzy widżet dekorowanego tekstu 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

Lista przycisków.

Na przykład ten plik JSON tworzy 2 przyciski. Pierwszy to niebieski przycisk tekstowy, a drugi to przycisk obrazu, który otwiera link:

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

TextInput

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

Na przykład ten kod JSON tworzy pole tekstowe na adres e-mail:

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

Innym przykładem jest ten plik JSON, który tworzy dane wejściowe tekstowe dla języka programowania z zaleceniami statycznymi:

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

SelectionInput

Wyświetla element sterujący, który pozwala użytkownikom wybierać elementy. Elementy sterujące wyborem to pola wyboru, przyciski opcji, przełączniki lub menu.

Na przykład ten plik 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

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

Na przykład ten plik JSON tworzy selektor daty i godziny w celu zaplanowania spotkania:

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

Divider

Wyświetla poziomą linię rozdzielającą widżety.

Na przykład ten kod JSON tworzy separator:

"divider": {
}

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órną granicę liczby elementów podzieloną przez liczbę kolumn. Siatka z 10 elementami i 2 kolumnami 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ę 2-kolumnową z jednym 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

Wyświetla maksymalnie 2 kolumny.

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

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

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

ChipList

Lista elementów.

Na przykład ten fragment kodu JSON tworzy 2 elementy. Pierwszy to element tekstowy, a drugi to element ikony, który umożliwia otwarcie linku:

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

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