Package google.apps.card.v1

string

Funkcja niestandardowa, która zostanie wywołana po kliknięciu lub aktywowaniu elementu zawierającego.

Przykładowe zastosowanie znajdziesz w sekcji Czytaj dane z formularza.

ActionParameter

Lista parametrów działania.

LoadIndicator

Określa wskaźnik ładowania wyświetlany podczas wykonywania wezwania do działania.

bool

Wskazuje, czy wartości w formularzu 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 umożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw parametr 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 podczas przetwarzania działania, ustaw wartość parametru LoadIndicator na SPINNER.

Interaction

Opcjonalnie: Wymagany podczas otwierania okna dialogowego.

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 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 jest to określone w przypadku dodatku, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

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

string

Opcjonalnie: Wypełnij tę listę nazwami widżetów, których ta czynność wymaga do prawidłowego przesłania.

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

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

bool

Opcjonalnie: Jeśli ta opcja jest zaznaczona, wszystkie widżety są wymagane do wykonania tego działania.

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órych należy używać, gdy typ ma wartość 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.

string

Tekst wyświetlany wewnątrz przycisku.

Icon

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

Color

Opcjonalnie: Kolor przycisku. Jeśli to pole jest zaznaczone, przycisk type ma ustawienie FILLED, a kolory pól text i icon są ustawione na kontrastowe, aby zwiększyć czytelność. Jeśli na przykład kolor przycisku jest ustawiony na niebieski, tekst lub ikony na przycisku są białe.

Aby ustawić kolor przycisku, podaj 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) – 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 przycisku. Jeśli jest określone, to pole 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 wyświetlany w stanie nieaktywnym 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 dla programistów Google Chat na stronie https://developers.google.com/workspace/chat"”.

Type

Opcjonalnie: Typ przycisku. Jeśli nie jest ustawiony, typ przycisku przyjmuje domyślnie wartość OUTLINED. Jeśli pole color ma ustawioną wartość, typ przycisku jest ustawiany 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 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 artykule Definiowanie sekcji karty.

DividerStyle

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

CardAction

Czynności związane z kartą. Do menu paska narzędzi karty są dodawane działania.

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:

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

string

Nazwa karty. Służy 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 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 na karcie.

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

Dostępne w przypadku dodatków Google Workspace i 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 przełączać się między kartami na stronie głównej a kartami kontekstowymi.

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

string

Etykieta wyświetlana jako element menu działania.

OnClick

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

Button

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

Button

Drugi przycisk w nieruchomym stopce. 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 podasz tytuł i podtytuł, każdy z nich zajmie jeden wiersz. 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ępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

string

Adres URL HTTPS obrazu w nagłówku karty.

string

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

TextParagraph

Widżet akapitu tekstowego.

ButtonList

Widżet listy przycisków.

Image

Widżet obrazu.

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

Sekcji można nie rozwijać, aby ukryć 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, podaj wartość uncollapsibleWidgetsCount.

int32

Liczba widżetów, których nie można zwinąć, które pozostają widoczne nawet wtedy, gdy sekcja jest zwinięta.

Jeśli na przykład sekcja zawiera 5 widżetów, a wartość parametru uncollapsibleWidgetsCount to 2, pierwsze 2 widżety są zawsze widoczne, a 3 ostatnie są domyślnie złożone. 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 uwzględnionych w karuzeli.

NestedWidget

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

NestedWidget

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

Icon

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

string

Tekst wyświetlany wewnątrz elementu.

OnClick

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

bool

Określa, 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 zastępczy używany do ułatwień dostępu.

Ustaw tekst opisowy, który informuje 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 dla programistów Google Chat 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 expandButton i collapseButton. Tylko 1 z nich nie zostanie zastosowany. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Button

Opcjonalnie: Zdefiniuj konfigurowalny przycisk, aby zwinąć sekcję. Należy ustawić pola expandButton i collapseButton. Tylko 1 z nich nie zostanie zastosowany. 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ą być wyrównane do góry, dołu czy ś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.

HostAppDataActionMarkup

Określa sposób aktualizowania danych Google Workspace.

string

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

Szczegółowe informacje o pracy z danymi 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 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 uniksowej.

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

• DATE_AND_TIME: data i godzina w formacie kalendarzowym w 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 wskazać godzinę 12:00, użyj wartości 43200000 (lub 12 * 60 * 60 * 1000).

int32

Liczba reprezentująca przesunięcie strefy czasowej względem UTC w minutach. Jeśli jest ustawiona, value_ms_epoch jest wyświetlana 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.

Icon

Wycofane na rzecz startIcon.

Icon

Ikona wyświetlana przed tekstem.

string

Tekst, który pojawia się nad ikoną 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. Jeśli zaznaczysz true, tekst zostanie przeniesiony i wyświetlony na kilku wierszach. W przeciwnym razie tekst jest obcinany.

Dotyczy tylko text, a nie topLabel i bottomLabel.

string

Tekst wyświetlany pod ikoną 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

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

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

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.

bool

Gdy true, przełącznik jest zaznaczony.

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ępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Action

W przypadku dodatków w Google Chat działanie, które zamyka okno dialogowe.

Suggestions

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w oznaczeniu znaczników na potrzeby sprawdzania składni.

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 wyświetlanych 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 jest wyświetlana siatka (w dialogu lub w usługach towarzyszących).

OnClick

Ten wywołanie zwrotne jest 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 onClick siatki nadrzędnej.

ImageComponent

Obraz wyświetlany w elemencie siatki.

string

Tytuł elementu siatki.

string

Podtytuł elementu siatki.

GridItemLayout

Układ do użycia w elemencie siatki.

string

Opcjonalnie: Opis ikony używanej w ramach ułatwień dostępu. Jeśli nie podasz wartości, 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 komponencie Button, gdy użytkownik najedzie na przycisk, pojawi się tekst pomocniczy altText. 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 podaj wartość BUS.

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

string

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

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

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

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków 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 dla 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

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

Adres URL linku, który spowoduje powrót do dodatku.

string

Tytuł linku do powrotu do dodatku.

Card

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

string

Tytuł wyświetlany w elemencie inteligentnym w podglądzie linku. Jeśli nie skonfigurujesz tej zasady, inteligentny element wyświetli nagłówek preview_card.

string

Tytuł wyświetlany w podglądzie linku. Jeśli nie zostanie ustawiony, podgląd linku będzie zawierać nagłówek preview_card.

string

Nazwa ikony zdefiniowana w ikonach Google Material, np. 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 Ikony czcionek Google i zmień ustawienia w sekcji Dostosuj.

int32

Grubość konturu ikony. Wybierz jedną z tych wartości: {100, 200, 300, 400, 500, 600, 700}. Jeśli nie zostanie podany, 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 zmień ustawienia w sekcji Dostosuj.

int32

Grubość linii symbolu zależy od grubości i rodzaju linii. 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 ma tej wartości, domyślnie jest to 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 zmień ustawienia w sekcji Dostosuj.

UpdateWidget

W przypadku dodatków w Google Chat aktualizuje widżet na karcie lub w oknie dialogowym.

SelectionInputWidgetSuggestions

W przypadku widżetów selectionInput tablica sugerowanych elementów w menu z wieloma opcjami. Gdy menu z wieloma opcjami używa zewnętrznego źródła danych do wypełniania elementów, widżet może dynamicznie wypełniać sugestie na podstawie tego, co użytkownik wpisze w menu. Więcej informacji znajdziesz w artykule Zbieranie informacji od użytkowników Google Chat.

SelectionItem

Tablica elementów do wyboru, które wyświetlają się użytkownikowi po wpisaniu przez niego tekstu w menu wielokrotnego wyboru.

bool

Odłącza wszystkie karty oprócz karty głównej.

bool

Wyjmij jedną kartę.

string

Wyświetla wszystkie karty powyżej określonej karty z określoną nazwą karty.

Card

Przesuwa kartę na stos kart.

Wersja przedpremierowa dla programistów: w przypadku dialogów w Google Chat otwiera lub aktualizuje dialog.

Card

Zaktualizuje najlepszą kartę, zachowując wypełnione pola formularza. W przypadku nierównego pola wartość jest pomijana.

Wersja przedpremierowa dla programistów: w przypadku dialogów w Google Chat otwiera lub aktualizuje dialog.

EndNavigation

W przypadku dodatków w Google Chat zamyka okno.

string

Tekst do wyświetlenia w powiadomieniu bez tagów HTML.

Action

Jeśli jest określony, onClick uruchamia działanie.

OpenLink

Jeśli jest określony, ten parametr onClick powoduje działanie polegające na otwarciu linku.

Action

Dodatek uruchamia to działanie, gdy musi otworzyć link. Różni się to od open_link powyżej, ponieważ w tym przypadku musi ono komunikować się z serwerem, aby uzyskać link. Dlatego przed otrzymaniem odpowiedzi na działanie otwierania linku klient internetowy musi wykonać pewne czynności przygotowawcze.

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

Card

Po kliknięciu nowa karta jest dodawana do stosu kart (jeśli jest to określone).

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

OverflowMenu

Jeśli jest to określone, onClick otwiera menu rozszerzone.

string

Adres URL do otwarcia.

OpenAs

Jak otworzyć link.

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

OnClose

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

Dostępne w przypadku dodatków Google Workspace i 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 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

Czy opcja menu jest wyłączona. Wartość domyślna to fałsz.

Action

Działanie, które dodatki mogą wykonywać, aby aktualizować interfejs.

Wersja dla programistów: dodatki w Google Chat.

HostAppActionMarkup

Działania obsługiwane przez poszczególne aplikacje hosta.

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w oznaczeniu znaczników na potrzeby sprawdzania składni.

Navigation

Wyświetla, chowa lub aktualizuje kartę.

Wersja dla programistów: dodatki w Google Chat.

OpenLink

Otwiera link docelowy w nowej karcie lub wyskakującym oknie.

Notification

Wyświetla powiadomienie w aplikacji hosta Google Workspace, gdy użytkownik wejdzie w interakcję z kartą.

Podgląd dla deweloperów: w przypadku dodatków w Google Chat wyświetla powiadomienie, gdy użytkownicy prześlą i zamkną okno dialogowe.

LinkPreview

Dostępne w Dokumentach, Arkuszach i Prezentacjach Google. Wyświetla podgląd linków z elementami inteligentnymi i kartą. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linku za pomocą elementów inteligentnych.

Link

Dostępne w Dokumentach Google. Zwraca link z zasobu zewnętrznego i konwertuje go na element inteligentny w aplikacji hosta. W postaci tablicy obiektów zawierającej 1 element.

Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm w menu @.

ModifyCard

W przypadku dodatków w Google Chat aktualizuje kartę na podstawie interakcji użytkownika. Tablica może zawierać tylko 1 obiekt.

string

Wymagane. Nazwa identyfikująca dane wejściowe wyboru w zdarzeniu z danymi wejściowymi formularza.

Szczegółowe informacje o pracy z danymi 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 wymagane przez aplikację. Jeśli na przykład użytkownicy wybierają pilność zgłoszenia w menu, etykieta może brzmieć „Pilność” 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ć co najmniej jedno pole wyboru, ale w menu mogą wybrać tylko jedną wartość.

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 to możliwe, formularz zostanie przesłany, gdy zmieni się wybrana opcja. Jeśli nie określisz tego parametru, musisz podać oddzielny przycisk, który przesyła formularz.

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

int32

W przypadku menu z wieloma opcjami maksymalna liczba elementów, które użytkownik może wybrać. Minimalna wartość to 1 element. Jeśli nie podasz tej wartości, zostanie użyta domyślna liczba 3.

int32

W przypadku menu z wielokrotnie wybieranymi opcjami liczba znaków tekstowych, które użytkownik wprowadził przed wyświetleniem menu z proponowanymi opcjami.

Jeśli nie ustawisz tej opcji, menu wyboru wielokrotnego będzie używać tych wartości domyślnych:

• Jeśli menu używa stałego tablicę elementów SelectionInput, domyślnie zawiera 0 znaków i natychmiast wypełnia elementy z tablicy.
• Jeśli menu korzysta z dynamicznego źródła danych (multi_select_data_source), przed wysłaniem zapytania do źródła danych, aby zwrócić sugerowane elementy, przyjmuje domyślnie 3 znaki.

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żytkowników w organizacji Google Workspace.

HostAppDataSourceMarkup

Źródło danych, które jest unikalne dla aplikacji hosta Google Workspace, takiej 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 artykule Instalowanie bibliotek klientów.

string

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

string

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

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych 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 w przypadku jednego elementu.

string

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

string

W przypadku menu z wieloma opcjami tekstowy opis lub etykieta wyświetlane pod polem text elementu.

RenderActions

Zestaw instrukcji renderowania, który instruuje kartę, aby wykonała działanie lub poprosił aplikację hosta dodatku o wykonanie działania związanego z tą aplikacją.

bool

czy stan kart się zmienił i czy dane na dotychczasowych kartach są nieaktualne.

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w znacznikach w celu sprawdzenia składni.

SuggestionItem

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

string

Wartość sugerowanego tekstu w polu tekstowym. Jest to równoznaczne z tym, co użytkownicy wpisują samodzielnie.

string

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

Szczegółowe informacje o pracy z danymi 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 prosisz o nazwisko, a nie imię, wpisz surname zamiast name.

Wymagane, jeśli nie określono właściwości hintText. W przeciwnym razie nie jest to wymagane.

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.

Wymagane, jeśli nie określono właściwości label. W przeciwnym razie nie jest to wymagane.

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 tekstowym. 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ę, gdy użytkownicy klikają w polu tekstowym. 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ą użytkownikom wpisywać wartości, które Twoja aplikacja może zinterpretować. W przypadku JavaScript niektórzy użytkownicy mogą wpisać javascript, a inni java script. Sugerowanie JavaScript może ujednolicić sposób interakcji użytkowników z Twoją aplikacją.

Gdy jest określony, parametr TextInput.type ma zawsze 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 tekstowe wyświetla sugestie użytkownikom, którzy z niego korzystają.

Jeśli nie podasz żadnych 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

Określ format sprawdzania poprawności danych wymagany w tym polu tekstowym.

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. Użyj tego tekstu, aby poprosić użytkowników o wpisanie wartości. Na przykład: Enter a number from 0 to 100.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków 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, nadmiar treści jest ukryty za przyciskiem pokaż więcej. Jeśli tekst jest 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.

int32

Określ limit znaków dla widżetów wprowadzania tekstu. Pamiętaj, że ta opcja jest używana tylko do 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 widgetów danych 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 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 ten ciąg JSON tworzy tekst pogrubiony:

"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 kod JSON tworzy ozdobiony 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

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 na adres e-mail:

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

Na przykład poniższy kod JSON 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 kod JSON tworzy menu, w którym użytkownicy mogą 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 kod JSON tworzy selektor daty i godziny do planowania 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 fragment kodu 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 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 kolumn 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

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

Carousel

Karuzela zawiera kolekcję zagnieżdżonych widżetów. Oto przykład reprezentacji karuzeli w formacie JSON, która zawiera 2 akapity tekstu.

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

ChipList

Lista elementów.

Na przykład ten fragment kodu 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"
        }
      }
    }
  ]
}