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 użycie znajdziesz w artykule Odczytywanie danych formularzy.

ActionParameter

Lista parametrów działań.

LoadIndicator

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

bool

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

Jeśli ustawiona jest wartość true, wartości formularza pozostają po wywołaniu działania. Aby umożliwić użytkownikowi wprowadzanie zmian w trakcie przetwarzania działania, ustaw LoadIndicator na NONE. W przypadku wiadomości z kartą w aplikacjach Google Chat musisz też ustawić ResponseType działania na UPDATE_MESSAGE i użyć tego samego card_id na karcie, która zawiera działanie.

Jeśli ustawiona jest wartość false, wartości formularza są czyszczone po wywołaniu 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 określono inaczej, aplikacja zareaguje, wykonując typową regułę action – np. otwierając link lub uruchamiając funkcję.

Jeśli określisz właściwość interaction, aplikacja będzie mogła odpowiadać na specjalne sposoby interaktywne. Jeśli na przykład ustawisz interaction na OPEN_DIALOG, aplikacja może otwierać okno. Jeśli ją określisz, wskaźnik wczytywania nie będzie się wyświetlał. Jeśli określisz dodatek w przypadku dodatku, cała karta będzie usunięta i nic nie będzie widoczne w kliencie.

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

string

Jeśli wymienione tu widżety nie mają wartości w momencie wywołania tego działania, przesyłanie formularza jest przerywane.

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 używane, gdy typ to BORDER_TYPE_STROKE.

Aby ustawić kolor kreski, 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ść.

W przykładzie poniżej pokazujemy, że kolor jest czerwony z maksymalną intensywnością:

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

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

int32

Promień narożnika obramowania.

string

Tekst wyświetlany na przycisku.

Icon

Ikona wyświetlana wewnątrz 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 na przykład kolor przycisku jest niebieski, wszystkie fragmenty tekstu i ikony na 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ść.

W przykładzie poniżej pokazujemy, że kolor jest 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 być wykonywane po kliknięciu przycisku przez użytkownika, na przykład otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.

bool

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

string

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

Ustaw opis, który poinformuje 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 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 jest skonfigurowane, typ przycisku jest wymagany na FILLED, a każda 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 są zawsze wyświetlane na górze karty.

Section

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

DividerStyle

Styl podziału między sekcjami.

CardAction

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

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

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

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

string

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

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

CardFixedFooter

Stała stopka widoczna u dołu tej karty.

Ustawienie fixedFooter bez określenia primaryButton lub secondaryButton powoduje błąd. W przypadku aplikacji do obsługi czatu możesz używać stałych stopek w oknach dialogowych, ale nie 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 elementu 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 pełni funkcję obiektu zastępczego, dzięki któremu użytkownik może przechodzić 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 czynności.

OnClick

Działanie onClick dla tego działania.

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ć przyciskiem tekstowym z ustawionym tekstem i kolorem. Jeśli ustawiono secondaryButton, 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 określono tylko tytuł, tekst zajmuje oba wiersze.

string

Podtytuł nagłówka karty. Jeśli jest określona, wyświetla się w osobnym wierszu pod nagłówkiem 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 widoczny u góry sekcji. Obsługuje prosty tekst w formacie HTML. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

Widget

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

bool

Wskazuje, czy 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 mają być ukryte, wybierz 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 ustawione są zarówno icon, jak i text, ikona pojawia 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

Określa, czy element jest aktywny i reaguje na działania użytkownika. Domyślna wartość to true. Rola wycofana. Użyj w zamian 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 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

Wyrównanie w poziomie przycisku rozwijania i zwijania.

Button

Opcjonalnie: Zdefiniuj przycisk konfigurowalny, aby rozwinąć sekcję. Należy ustawić wartości w polach „expandButton” 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.

Button

Opcjonalnie: Zdefiniuj przycisk konfigurowalny, który zwija sekcję. Należy ustawić wartości w polach „expandButton” 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 oknie dialogowym 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 prosi użytkowników o podanie 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 aby uwzględnić 1 stycznia 2023 r. o 12:00 czasu UTC, użyj pola 1672574400000.
• DATE_ONLY: dzień kalendarzowy o godzinie 00:00:00 czasu UTC. Na przykład do określenia daty 1 stycznia 2023 r. użyj 1672531200000.
• TIME_ONLY: czas w strefie czasowej UTC. Na przykład aby określić godzinę 12:00, użyj formatu 43200000 (lub 12 * 60 * 60 * 1000).

int32

Liczba reprezentująca przesunięcie strefy czasowej w stosunku do czasu UTC (w minutach). Jeśli jest ustawiona, value_ms_epoch jest wyświetlany w określonej strefie czasowej. Jeśli zasada jest nieskonfigurowana, domyślnie przyjmuje się 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

Wycofano. Zastąpiona wartością jest 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żytkownik kliknie topLabel lub bottomLabel.

Button

Przycisk, który użytkownik może kliknąć, aby wywołać 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, według której widżet przełącznika 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

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. która funkcja ma zostać uruchomiona.

ControlType

Wygląd przełącznika w interfejsie.

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

Action

Działanie renderowania, które klient kończy przepływ okna.

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

Suggestions

string

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

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. Najlepiej jest ustawić przydatny opis zawartości ikony i – w odpowiednich przypadkach – do czego służy. na przykład A user's account portrait lub Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat.

Jeśli ikona jest ustawiona w elemencie Button, gdy użytkownik najedzie na przycisk, altText pojawi się jako tekst pomocniczy. Jeśli jednak dla przycisku ustawiono także wartość text, wartość altText ikony będzie ignorowana.

ImageType

Styl przycinania zastosowany do obrazu. W niektórych przypadkach przycięcie CIRCLE powoduje, że rysunek jest większy niż wbudowana ikona.

string

Wyświetl jedną z wbudowanych ikon dostępnych w Google Workspace.

Aby na przykład wyświetlać ikonę samolotu, wpisz 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 Design.

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

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

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

string

Adres URL HTTPS, który hostuje 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

Alternatywny tekst tego obrazu używany w ułatwieniach 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 zostanie zastosowany do obrazu.

ImageCropType

Typ przycięcia.

double

Format obrazu używany, gdy typ przycięcia to RECTANGLE_CUSTOM.

Na przykład w ten sposób możesz zastosować współczynnik proporcji 16:9:

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

string

Adres URL linku z powrotem do dodatku.

string

Tytuł linku umożliwiającego powrót do dodatku.

Card

Karta, która zawiera informacje o linku z usługi innej firmy.

string

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

string

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

string

Nazwa ikony zdefiniowana w ikonie Google Material, na przykład check_box. Wszelkie nieprawidłowe nazwy zostaną porzucone i zastąpione pustym ciągiem znaków, co spowoduje błąd renderowania ikony.

bool

Określa, czy ikona jest wyświetlana jako wypełniona. Wartość domyślna to false.

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

int32

Grubość kreski 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

Waga i stopień wpływają na grubość symbolu. Zmiany oceny są bardziej szczegółowe niż korekty wagi i mają niewielki wpływ na wielkość symbolu. Masz do wyboru {-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.

bool

Stos kart odbija wszystkie karty oprócz karty głównej.

bool

Stos kart wysuwa jedną z kart.

string

Stos kart wyświetla wszystkie karty nad określoną kartą o danej nazwie.

Card

Stos kart przesuwa kartę na stos kart.

Card

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

EndNavigation

Działanie zakończenia nawigacji w oknie przepływu w oknie. Więcej informacji znajdziesz w artykule Tworzenie strony głównej aplikacji Google Chat.

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

string

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

Action

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

OpenLink

Jeśli zostanie określony, onClick wywoła działanie otwartego linku.

Action

Dodatek wyzwala to działanie, gdy wymagane jest otwarcie linku. Różni się od open_link powyżej tym, że w celu uzyskania linku wymagane jest połączenie z serwerem. Z tego względu klient internetowy musi wykonać pewne działania przygotowawcze, zanim otrzyma odpowiedź działania związaną z otwartym linkiem.

Dostępne w dodatkach do Google Workspace, ale niedostępne w aplikacjach 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 określony, onClick otwiera rozszerzone menu. 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 po otwarciu linku klient zapomni o otwartym linku czy obserwuje go do momentu 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 użytkownikom.

OnClick

Wymagane. Działanie jest wywoływane po wybraniu opcji menu. Pole OnClick nie może zawierać ciągu OverflowMenu, określony element OverflowMenu został pominięty, a opcja menu jest wyłączona.

bool

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

Action

HostAppActionMarkup

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

string

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

Navigation

Karty możesz wrzucać, zmieniać i aktualizować.

OpenLink

Natychmiast otwórz link docelowy w nowej karcie lub wyskakującym okienku.

Notification

Wyświetl powiadomienie użytkownikowi.

LinkPreview

Wyświetl podgląd linku użytkownikowi.

Link

Link do zasobu innej firmy utworzonego z poziomu aplikacji Google Workspace. Sformatowana jako tablica obiektów z jednym elementem. Więcej informacji znajdziesz w artykule Tworzenie zasobów innych firm za pomocą menu @.

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 w interfejsie nad polem wyboru do wprowadzania danych.

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ć np. 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 go nie podasz, musisz dodać osobny przycisk do przesyłania formularza.

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 określono inaczej, domyślna wartość to 0 znaków w przypadku statycznych źródeł danych i 3 znaki w przypadku zewnętrznych źródeł danych.

Validation

Weryfikacja tego pola wyboru w przypadku menu rozwijanych.

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

Action

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

PlatformDataSource

Źródło danych z Google Workspace.

CommonDataSource

Źródło danych współdzielone przez wszystkie aplikacje Google Workspace, takie jak 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 na temat pracy z danymi wejściowymi 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.

RenderActions

Zestaw instrukcji renderowania, które informują kartę, że ma wykonać działanie, lub informuje aplikację hosta dodatku, aby wykonała konkretną czynność.

bool

Wskazuje, czy stan kart uległ zmianie, a dane na istniejących kartach są nieaktualne.

string

Jest to pole schematu no-opera, które może znajdować się w znacznikach na potrzeby sprawdzania składni.

SuggestionItem

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

string

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

string

Nazwa, pod którą wpisany tekst jest rozpoznawany w zdarzeniu wprowadzania tekstu.

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

string

Tekst wyświetlany nad polem do wprowadzania tekstu w interfejsie.

Podaj tekst, który pomoże użytkownikowi podać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład pytasz czyjegoś imienia, a konkretnie nazwiska, 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 do wprowadzania tekstu, który ma ułatwić użytkownikom wpisanie 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, 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.

Type

Sposób wyświetlania pola do wprowadzania tekstu w interfejsie. na przykład czy to 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 do pola lub usunięcie tekstu.

Może to być na przykład uruchomienie 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. W miarę pisania przez użytkowników sugerowane wartości są dynamicznie filtrowane zgodnie z tym, co wpisali użytkownicy.

Na przykład pole tekstowe do wprowadzania danych w języku programowania może sugerować Java, JavaScript, Python i C++. Gdy użytkownicy zaczną pisać Jav, na liście filtrów sugestii wyświetlą się 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 określona, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli ustawiona jest wartość MULTIPLE_LINE.

Dostępny 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 określono inaczej, sugestie są ustawiane przez initialSuggestions i przetwarzane przez klienta.

Jeśli określisz działanie, aplikacja wykona określone tutaj działanie, np. uruchomi funkcję niestandardową.

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

Validation

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

string

Tekst, który pojawia się w polu do wprowadzania tekstu, gdy pole 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ępny w aplikacjach Google Chat i niedostępny w przypadku dodatków do 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ą pisać.

Na przykład ten plik JSON tworzy pole tekstowe adresu e-mail:

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

Kolejny przykład to przykładowy kod JSON, który tworzy pole tekstowe 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 element sterujący, który umożliwia użytkownikom wybieranie elementów. Elementy sterujące zaznaczaniem mogą być polami wyboru, opcjami, przełącznikami i 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ę między widżetami.

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órne granice liczby elementów podzielone przez liczbę kolumn. Siatka z 10 elementami i 2 kolumnami ma 5 wierszy. Siatka z 11 elementami i 2 kolumnami ma 6 wierszy.

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

Na przykład ten plik JSON tworzy siatkę z 2 kolumnami 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 plik JSON tworzy 2 kolumny, z których każda zawiera akapity:

"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 plik 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ępny w aplikacjach Google Chat i niedostępny w przypadku dodatków do Google Workspace.