Package google.apps.card.v1

string

Funkcja niestandardowa, która ma być wywoływana, gdy element zawierający zostanie kliknięty lub w inny sposób aktywowany.

Przykłady użycia znajdziesz w sekcji Odczytywanie danych z formularza.

ActionParameter

Lista parametrów działania.

LoadIndicator

Określa wskaźnik ładowania, który jest wyświetlany podczas wykonywania wywołania do działania.

bool

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

Jeśli true, wartości formularza pozostają po wywołaniu działania. Aby zezwolić użytkownikowi na wprowadzanie zmian podczas przetwarzania działania, ustaw wartość LoadIndicator na NONE. W przypadku wiadomości w formie kart w aplikacjach do obsługi czatu musisz też ustawić wartość ResponseType działania na UPDATE_MESSAGE i użyć tego samego parametru card_id z karty, która zawierała działanie.

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

Interaction

Opcjonalnie. Wymagany podczas otwierania okna.

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

Jeśli nie zostanie określony, aplikacja odpowie, wykonując action – np. otwierając link lub uruchamiając funkcję – w normalny sposób.

Dzięki określeniu interaction aplikacja może odpowiadać w specjalny interaktywny sposób. Na przykład ustawiając wartość interaction na OPEN_DIALOG, aplikacja może otworzyć okno. Jeśli ten parametr jest określony, wskaźnik wczytywania nie jest wyświetlany. Jeśli jest to określone w przypadku dodatku, cała karta jest usuwana i w aplikacji nie jest wyświetlane nic.

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

string

Opcjonalnie. Wypełnij tę listę nazwami widżetów, których to działanie potrzebuje do prawidłowego przesłania.

Jeśli widżety wymienione w tym miejscu nie mają wartości w momencie wywołania tej czynności, przesyłanie formularza zostanie przerwane.

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

bool

Opcjonalnie. Jeśli wartość to prawda, wszystkie widżety są uznawane za wymagane przez to działanie.

 Dostępne 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óre mają być używane, gdy typ to BORDER_TYPE_STROKE.

Aby ustawić kolor obrysu, określ wartość w polach 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) oznacza maksymalne natężenie koloru.

Na przykład poniższy kod ustawia kolor czerwony o maksymalnej intensywności:

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

Pole alpha jest niedostępne w przypadku koloru obrysu. Jeśli to pole zostanie podane, będzie ignorowane.

int32

Promień narożnika obramowania.

string

Tekst wyświetlany wewnątrz przycisku.

Icon

Ikona wyświetlana w przycisku. Jeśli ustawisz zarówno parametr icon, jak i text, ikona pojawi się przed tekstem.

Color

Opcjonalnie. Kolor przycisku. Jeśli jest ustawiony, przycisk type jest ustawiony na FILLED, a kolor pól text i icon jest ustawiony na kontrastowy, aby zwiększyć czytelność. Jeśli na przykład kolor przycisku jest ustawiony na niebieski, tekst lub ikony na przycisku będą białe.

Aby ustawić kolor przycisku, określ wartości w polach 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) oznacza maksymalne natężenie koloru.

Na przykład poniższy kod ustawia kolor czerwony o maksymalnej intensywności:

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

Pole alpha jest niedostępne w przypadku koloru przycisku. Jeśli to pole zostanie podane, będzie ignorowane.

OnClick

Wymagane. Działanie, które ma zostać wykonane, gdy użytkownik kliknie przycisk, np. otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.

bool

Jeśli true, przycisk jest wyświetlany w stanie nieaktywnym i nie reaguje na działania użytkownika.

string

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

Ustaw opisowy tekst, który informuje użytkowników o działaniu przycisku. Jeśli na przykład przycisk otwiera hiperlink, możesz napisać: „Otwiera nową kartę przeglądarki i przechodzi do dokumentacji dla programistów Google Chat na stronie https://developers.google.com/workspace/chat"”.

Type

Opcjonalnie. Typ przycisku. Jeśli nie jest ustawiony, domyślny typ przycisku to OUTLINED. Jeśli pole color jest ustawione, typ przycisku jest wymuszany na FILLED, a wszelkie wartości ustawione w tym polu są ignorowane.

Button

Tablica przycisków.

CardHeader

Nagłówek karty. Nagłówek zwykle zawiera obraz na początku i tytuł. Nagłówki zawsze pojawiają się u góry karty.

Section

Zawiera kolekcję widżetów. Każda sekcja ma własny, opcjonalny nagłówek. Sekcje są wizualnie oddzielone linią. Przykład w aplikacjach Google Chat znajdziesz w artykule Definiowanie sekcji karty.

DividerStyle

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

CardAction

Działania związane z kartą. Działania są dodawane do menu paska narzędzi karty.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

Na przykład poniższy kod JSON tworzy menu działań na karcie 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 do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

CardFixedFooter

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

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

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

DisplayStyle

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

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji 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 przechodzić między kartami na stronie głównej a kartami kontekstowymi.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

string

Etykieta, która wyświetla się jako element menu działania.

OnClick

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

Button

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

Button

Dodatkowy przycisk stałej stopki. Przycisk musi być przyciskiem tekstowym z ustawionym tekstem i kolorem. Jeśli ustawisz wartość secondaryButton, musisz też ustawić wartość 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 jeden wiersz. Jeśli podasz tylko tytuł, zajmie on oba wiersze.

string

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

ImageType

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

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

string

Adres URL HTTPS obrazu w nagłówku karty.

string

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

TextParagraph

Widżet akapitu tekstu.

ButtonList

Widżet listy przycisków.

Image

Widżet obrazu.

string

Tekst wyświetlany u góry sekcji. Obsługuje tekst sformatowany w prostym 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 zwinąć.

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

int32

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

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

CollapseControl

Opcjonalnie. Zdefiniuj przycisk rozwijania i zwijania sekcji. Ten przycisk będzie widoczny tylko wtedy, gdy sekcję można zwinąć. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

CarouselCard

Lista kart w karuzeli.

NestedWidget

Lista widżetów wyświetlanych na karcie karuzeli. Widżety są wyświetlane w kolejności, w jakiej zostały określone.

NestedWidget

Lista widżetów wyświetlana u dołu karty karuzeli. Widżety są wyświetlane w kolejności, w jakiej zostały określone.

Icon

Obraz ikony. Jeśli ustawisz zarówno parametr icon, jak i text, ikona pojawi się przed tekstem.

string

Tekst wyświetlany w kapsule.

OnClick

Opcjonalnie. Działanie, które ma zostać wykonane, gdy użytkownik kliknie element, np. otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.

bool

Określa, czy element jest aktywny i reaguje na działania użytkownika. Domyślna wartość to true. Rola wycofana. Zamiast niej używaj zasady disabled.

bool

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

string

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

Ustaw tekst opisowy, który informuje użytkowników o tym, do czego służy element. Jeśli na przykład kliknięcie elementu otwiera hiperlink, napisz: „Otwiera nową kartę przeglądarki i przekierowuje do dokumentacji dla programistów Google Chat na stronie https://developers.google.com/workspace/chat"”.

Layout

Określony układ listy elementów.

Chip

Tablica układów.

HorizontalAlignment

Poziome wyrównanie przycisku rozwijania i zwijania.

Button

Opcjonalnie. Zdefiniuj konfigurowalny przycisk, aby rozwinąć sekcję. Musisz ustawić zarówno pole expand_button, jak i collapse_button. Tylko 1 zestaw pól nie zostanie uwzględniony. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Button

Opcjonalnie. Zdefiniuj konfigurowalny przycisk, aby zwinąć sekcję. Musisz ustawić zarówno pole expand_button, jak i collapse_button. Tylko 1 zestaw pól nie zostanie uwzględniony. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Column

Tablica kolumn. Karta lub okno może zawierać 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 środka kolumny.

VerticalAlignment

Określa, czy widżety są wyrównane do góry, do dołu czy do środka kolumny.

Widgets

Tablica widżetów zawartych 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.

string

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

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z 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 umawiają się na spotkanie, użyj etykiety takiej jak Appointment date lub Appointment date and time.

DateTimePickerType

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

int64

Wartość domyślna wyświetlana w widżecie, w milisekundach od czasu epoki systemu Unix.

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

• DATE_AND_TIME: data i godzina w kalendarzu w formacie UTC. Aby na przykład zapisać 1 stycznia 2023 r., godz. 12:00 czasu UTC, użyj 1672574400000.
• DATE_ONLY: data kalendarzowa o godzinie 00:00:00 UTC. Aby na przykład przedstawić datę 1 stycznia 2023 r., użyj wartości 1672531200000.
• TIME_ONLY: czas w strefie UTC. Aby na przykład podać godzinę 12:00, użyj 43200000 (lub 12 * 60 * 60 * 1000).

int32

Liczba reprezentująca przesunięcie strefy czasowej względem czasu UTC w minutach. Jeśli ta opcja jest ustawiona, value_ms_epoch jest wyświetlana w określonej strefie czasowej. Jeśli nie jest ustawiona, domyślnie przyjmuje się ustawienie strefy czasowej użytkownika.

Action

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

Icon

Wycofane na rzecz startIcon.

Icon

Ikona wyświetlana przed tekstem.

VerticalAlignment

Opcjonalnie. Wyrównanie pionowe ikony startu. Jeśli nie zostanie ustawiona, ikona będzie wyśrodkowana w pionie.

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

string

Tekst, który pojawia się nad symbolem text. Zawsze obcina.

TextParagraph

TextParagraph odpowiednik top_label. Zawsze obcina. Umożliwia bardziej złożone formatowanie niż top_label.

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

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.

TextParagraph

TextParagraph odpowiednik text. Umożliwia bardziej złożone formatowanie niż text.

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

bool

Ustawienie zawijania tekstu. Jeśli true, tekst jest zawijany i wyświetlany w kilku wierszach. W przeciwnym razie tekst zostanie obcięty.

Dotyczy tylko text, a nie topLabel i bottomLabel.

string

Tekst wyświetlany pod ikoną text. Zawsze zawija.

TextParagraph

TextParagraph odpowiednik bottom_label. Zawsze zawija. Umożliwia bardziej złożone formatowanie niż bottom_label.

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

OnClick

Ta czynność jest wywoływana, gdy użytkownicy klikną topLabel lub bottomLabel.

Button

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

SwitchControl

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

Icon

Ikona wyświetlana po tekście.

Obsługuje wbudowane i niestandardowe ikony.

string

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

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

string

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

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

bool

Gdy przełącznik jest włączony, wyświetla się ikona true.

Action

Czynność do wykonania po zmianie stanu przełącznika, np. funkcja do uruchomienia.

ControlType

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

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

string

Tekst wyświetlany w nagłówku siatki.

GridItem

Elementy do wyświetlenia w siatce.

BorderStyle

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

int32

Liczba kolumn do wyświetlenia w siatce. Jeśli to pole nie jest określone, używana jest wartość domyślna, która różni się w zależności od tego, gdzie wyświetlana jest siatka (w oknie czy w reklamie towarzyszącej).

OnClick

Ten wywołanie zwrotne jest używane ponownie przez każdy element siatki, ale do jego parametrów dodawane są identyfikator elementu i jego indeks na liście elementów.

string

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

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 przypadku elementu siatki.

string

Opcjonalnie. Opis ikony używanej na potrzeby ułatwień dostępu. Jeśli nie podasz żadnej opcji, domyślną wartością będzie Button. Zgodnie ze sprawdzonymi metodami warto dodać przydatny opis tego, co wyświetla ikona, a w stosownych przypadkach – co 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 Button, po najechaniu kursorem na przycisk jako tekst pomocniczy pojawi się altText. Jeśli jednak przycisk ustawia też wartość text, wartość altText ikony jest ignorowana.

ImageType

Styl przycinania zastosowany do obrazu. W niektórych przypadkach zastosowanie przycięcia CIRCLE powoduje, że obraz jest rysowany w większym rozmiarze niż wbudowana ikona.

string

Wyświetl jedną z wbudowanych ikon udostępnianych przez Google Workspace.

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

Pełną listę obsługiwanych ikon znajdziesz w sekcji wbudowane ikony.

string

Wyświetlanie ikony niestandardowej hostowanej 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 Material Design od Google.

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

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

Dostępne w aplikacjach Google Chat, ale niedostępne w dodatkach 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 wywoła to działanie.

string

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

string

Adres URL obrazu.

string

Etykieta ułatwień dostępu do obrazu.

ImageCropStyle

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

BorderStyle

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

ImageCropType

Typ przycięcia.

double

Współczynnik proporcji, który ma być używany, jeśli typ przycięcia to RECTANGLE_CUSTOM.

Oto przykład zastosowania współczynnika proporcji 16:9:

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

string

Nazwa ikony zdefiniowana w Google Material Icon, np. check_box. Nieprawidłowe nazwy są odrzucane i zastępowane pustym ciągiem znaków, co powoduje, że ikona nie jest renderowana.

bool

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

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

int32

Grubość konturu ikony. Wybierz jedną z wartości: {100, 200, 300, 400, 500, 600, 700}. Jeśli nie występuje, wartością domyślną jest 400. Jeśli podasz inną 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.

int32

Waga i stopień wpływają na grubość symbolu. Korekty oceny są bardziej szczegółowe niż korekty wagi i mają niewielki wpływ na rozmiar symbolu. Wybierz jedną z wartości: {-25, 0, 200}. Jeśli nie podasz wartości, domyślnie przyjęta zostanie wartość 0. Jeśli podasz inną 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.

Action

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

OpenLink

Jeśli jest określony, ten onClick wywołuje działanie otwierania linku.

Action

Dodatek wywołuje to działanie, gdy musi otworzyć link. Różni się to od open_link powyżej, ponieważ w tym przypadku trzeba się połączyć z serwerem, aby uzyskać link. Dlatego klient internetowy musi wykonać pewne czynności przygotowawcze, zanim otrzyma odpowiedź na działanie otwierania linku.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

Card

Po kliknięciu nowa karta jest przenoszona do stosu kart, jeśli tak określono.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

OverflowMenu

Jeśli jest określony, ten element onClick otwiera rozszerzone menu.

string

Adres URL do otwarcia.

OpenAs

Jak otworzyć link.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

OnClose

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

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

OverflowMenuItem

Wymagane. Lista opcji menu.

Icon

Ikona wyświetlana przed tekstem.

string

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

OnClick

Wymagane. Działanie wywoływane po wybraniu opcji menu. Ten OnClick nie może zawierać OverflowMenu. Każdy określony OverflowMenu jest usuwany, a element menu jest wyłączany.

bool

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

string

Wymagane. Nazwa, która identyfikuje dane wejściowe wyboru w zdarzeniu wprowadzania danych w formularzu.

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

string

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

Określ tekst, który pomoże użytkownikowi wpisać informacje potrzebne aplikacji. Jeśli na przykład użytkownicy wybierają pilność zgłoszenia z menu, etykieta może brzmieć „Pilność” lub „Wybierz pilność”.

SelectionType

Rodzaj elementów wyświetlanych użytkownikom w widżecie SelectionInput. Typy zaznaczeń obsługują różne rodzaje interakcji. Użytkownicy mogą na przykład zaznaczyć co najmniej jedno pole wyboru, ale w menu mogą wybrać tylko jedną wartość.

SelectionItem

Tablica elementów do wyboru. Na przykład tablica przycisków opcji lub pól wyboru. Obsługuje do 100 elementów.

Action

Jeśli ta opcja jest określona, formularz jest przesyłany po zmianie wyboru. Jeśli nie określisz tego parametru, musisz podać osobny przycisk, który przesyła formularz.

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

int32

W przypadku menu wielokrotnego wyboru liczba znaków tekstowych, które użytkownik wpisuje, zanim menu zwróci sugerowane elementy wyboru.

Jeśli nie jest skonfigurowane, menu wielokrotnego wyboru używa tych wartości domyślnych:

• Jeśli menu używa statycznej tablicy elementów SelectionInput, domyślnie ma 0 znaków i natychmiast wypełnia elementy z tablicy.
• Jeśli menu korzysta z dynamicznego źródła danych (multi_select_data_source), domyślnie przed wysłaniem zapytania do źródła danych w celu zwrócenia sugerowanych elementów używane są 3 znaki.

int32

W przypadku menu wielokrotnego wyboru jest to maksymalna liczba elementów, które może wybrać użytkownik. Minimalna wartość to 1 produkt. Jeśli nie podasz tu żadnej wartości, zostaną użyte domyślne 3 elementy.

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, które jest unikalne dla aplikacji hostującej Google Workspace, np. 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 produktem. Klient powinien użyć tej wartości jako wartości wejściowej formularza.

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

bool

Czy element jest domyślnie wybrany. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu.

string

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

string

SuggestionItem

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

string

Wartość sugerowanego wpisu w polu tekstowym. Jest to odpowiednik informacji wprowadzanych przez użytkowników.

string

Nazwa, pod którą wprowadzony tekst jest identyfikowany w zdarzeniu wprowadzania danych w formularzu.

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

string

Tekst wyświetlany nad polem wprowadzania tekstu w interfejsie.

Określ tekst, który pomoże użytkownikowi wpisać informacje potrzebne aplikacji. Jeśli na przykład pytasz o imię i nazwisko, ale potrzebujesz tylko nazwiska, wpisz surname zamiast name.

Wymagany, jeśli nie określono parametru hintText. W przeciwnym razie jest opcjonalne.

string

Tekst wyświetlany pod polem wprowadzania tekstu, który ma pomóc użytkownikom, zachęcając ich do wpisania określonej wartości. Ten tekst jest zawsze widoczny.

Wymagany, jeśli nie określono parametru label. W przeciwnym razie jest opcjonalne.

string

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

Więcej informacji o pracy z danymi wejściowymi formularza znajdziesz w artykule Odbieranie danych z formularza.

Type

Sposób wyświetlania pola wprowadzania tekstu w interfejsie. Na przykład czy pole jest jedno- czy wielowierszowe.

Action

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

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

Suggestions

Sugerowane wartości, które użytkownicy mogą wpisać. Te wartości pojawiają się, gdy użytkownicy klikną pole wprowadzania tekstu. W miarę wpisywania przez użytkowników sugerowane wartości są dynamicznie filtrowane, aby pasowały do wpisanego tekstu.

Na przykład pole tekstowe do wpisywania języka programowania może sugerować Java, JavaScript, Python i C++. Gdy użytkownicy zaczną pisać Jav, lista sugestii zostanie przefiltrowana i będą na niej widoczne tylko Java i JavaScript.

Sugerowane wartości pomagają użytkownikom wprowadzać wartości, które Twoja aplikacja może interpretować. 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 jest określony, parametr TextInput.type zawsze ma wartość SINGLE_LINE, nawet jeśli jest ustawiony na MULTIPLE_LINE.

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

Action

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

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

Jeśli jest określone, aplikacja wykonuje działanie podane w tym miejscu, np. uruchamia funkcję niestandardową.

Dostępne w przypadku dodatków do Google Workspace, ale niedostępne w przypadku aplikacji Google Chat.

Validation

Określ sprawdzanie poprawności formatu danych wejściowych wymagane w przypadku tego pola tekstowego.

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

string

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

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

string

Tekst wyświetlany w widżecie.

int32

Maksymalna liczba wierszy tekstu wyświetlanych w widżecie. Jeśli tekst przekracza określoną maksymalną liczbę wierszy, nadmiarowa treść jest ukryta za przyciskiem pokaż więcej. Jeśli tekst jest równy lub krótszy niż określona maksymalna liczba wierszy, przycisk Pokaż więcej nie jest wyświetlany.

Wartość domyślna to 0, co oznacza, że wyświetlany jest cały kontekst. Wartości ujemne są ignorowane.

TextSyntax

Składnia tekstu. Jeśli nie jest ustawiony, tekst jest renderowany jako HTML.

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

int32

Określ limit znaków w przypadku widżetów do wpisywania tekstu. Pamiętaj, że ta opcja jest używana tylko w przypadku wprowadzania tekstu i jest ignorowana w przypadku innych widżetów.

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

InputType

Określ typ widżetów wejściowych.

 Dostępne 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 środka kolumny.

TextParagraph

Wyświetla akapit tekstu. Obsługuje tekst sformatowany w prostym 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 tekst pogrubiony:

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

Image

Wyświetla obraz.

Na przykład poniższy 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 element tekstowy z dekoracją.

Na przykład ten kod JSON tworzy widżet z tekstem dekoracyjnym, który wyświetla adres 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 kod JSON tworzy 2 przyciski. Pierwszy to niebieski przycisk tekstowy, a drugi to przycisk z obrazem, 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 do wpisywania adresu e-mail:

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

Inny przykład: poniższy kod JSON tworzy pole wprowadzania tekstu dla 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

Wyświetla kontrolkę wyboru, która umożliwia użytkownikom wybieranie elementów. Elementy sterujące wyborem mogą być polami wyboru, przyciskami opcji, przełącznikami lub menu.

Na przykład poniższy kod JSON tworzy menu, które umożliwia użytkownikom wybór rozmiaru:

"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 wprowadzanie daty, godziny lub daty i godziny.

Na przykład ten kod JSON tworzy selektor daty i godziny do planowania spotkań:

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

Divider

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

Na przykład ten kod JSON tworzy separator:

"divider": {
}

Grid

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

Siatka obsługuje dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez górną granicę liczby produktó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ę z 2 kolumnami i 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

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

Carousel

Karuzela zawiera zbiór zagnieżdżonych widżetów. Oto na przykład reprezentacja JSON karuzeli zawierającej 2 akapi tekstowe.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

ChipList

Lista ikon.

Na przykład ten kod JSON tworzy 2 elementy. Pierwszy to element tekstowy, a drugi to element z ikoną, który otwiera link:

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