Karta
Karta to element interfejsu, który może zawierać widżety interfejsu takie jak tekst, obrazy.
Zapis JSON |
---|
{ "header": { object ( |
Pola | |
---|---|
header
|
Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz. |
sections[]
|
Sekcje są rozdzielone linię podziału. |
cardActions[]
|
Działania tej karty. |
name
|
Nazwa karty. |
KartaNagłówek
Zapis JSON |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
Pola | |
---|---|
title
|
Musisz podać tytuł. Nagłówek ma stałą wysokość. Jeśli podajesz zarówno tytuł, jak i podtytuł, każdy z nich będzie zajmować 1 wiersz. Jeśli określony jest tylko tytuł, będzie on używany w obu wierszach. |
subtitle
|
Podtytuł nagłówka karty. |
imageStyle
|
Typ obrazu (np. kwadratowe lub okrągłe obramowanie). |
imageUrl
|
Adres URL obrazu w nagłówku karty. |
Styl obrazu
Wartości w polu enum | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
Obramowanie kwadratowe. |
AVATAR
|
Obramowanie kołowe. |
Sekcja
Sekcja zawiera zbiór widżetów renderowanych (pionowo) w określonej kolejności. Na wszystkich platformach karty mają wąską szerokość, więc obecnie nie trzeba zmieniać właściwości układu (np. liczby zmiennoprzecinkowej).
Zapis JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Pola | |
---|---|
header
|
Nagłówek sekcji z obsługiwanym tekstem. |
widgets[]
|
Sekcja musi zawierać co najmniej 1 widżet. |
Znacznik widżetu
Widżet to element interfejsu, który wyświetla tekst, obrazy itp.
Zapis JSON |
---|
{ "buttons": [ { object ( |
Pola | |
---|---|
buttons[]
|
Lista przycisków. Przyciski również mogą służyć do danych i należy ustawić tylko jedno z tych pól. |
Pole sumy
data
. Element WidgetMarkup może mieć tylko jeden z tych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól WidgetMarkup.
data
może mieć tylko jedną z tych wartości:
|
|
textParagraph
|
Wyświetlaj akapit tekstu w tym widżecie. |
image
|
Wyświetl obraz w tym widżecie. |
keyValue
|
Wyświetlaj element pary klucz-wartość w tym widżecie. |
Akapit tekstowy
Akapit z tekstem. Formatowanie jest obsługiwane.
Zapis JSON |
---|
{ "text": string } |
Pola | |
---|---|
text
|
|
Obraz
Obraz określony za pomocą adresu URL, który może zawierać działanie „onclick”.
Zapis JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Pola | |
---|---|
imageUrl
|
Adres URL obrazu. |
onClick
|
Działanie „onclick”. |
aspectRatio
|
Współczynnik proporcji tego obrazu (szerokość/wysokość). To pole umożliwia klientom zarezerwowanie odpowiedniej wysokości dla obrazu podczas oczekiwania na jego załadowanie. Nie zastępują one natywnego współczynnika proporcji obrazu. Jeśli jej nie skonfigurujesz, serwer napełni ją, wstępnie pobierając obraz. |
OnClick
Działanie onclick (np. otwarcie linku).
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
action
|
Jeśli określisz, aktywuje to działanie formularza. |
openLink
|
Jeśli określisz to ustawienie, aktywuje to działanie dotyczące linku otwartego. |
Czynność
Działanie formularza opisuje zachowanie po przesłaniu formularza. Na przykład można wywołać skrypt Apps Script, aby obsłużyć formularz.
Zapis JSON |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
Pola | |
---|---|
actionMethodName
|
Nazwa metody służy do określenia, która część formularza spowodowała przesłanie formularza. Informacje te są odczytywane z powrotem do aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Tej samej nazwy metody można użyć w przypadku kilku elementów, które w razie potrzeby mogą uruchamiać często używane zachowanie. |
parameters[]
|
Lista parametrów działań. |
Parametr działania
Lista parametrów ciągu znaków do podania podczas wywoływania metody działania. Weźmy na przykład 3 przyciski drzemki: drzemka teraz, drzemka 1 dzień, drzemka w przyszłym tygodniu. Możesz użyć metody działania = drzemka(), która przekazuje typ drzemki i czas drzemki na liście parametrów ciągu znaków.
Zapis JSON |
---|
{ "key": string, "value": string } |
Pola | |
---|---|
key
|
Nazwa parametru skryptu działań. |
value
|
Wartość parametru. |
OpenLink
Link otwierający nowe okno.
Zapis JSON |
---|
{ "url": string } |
Pola | |
---|---|
url
|
URL do otwarcia. |
Para klucz-wartość
Element interfejsu zawiera klucz (etykietę) i wartość (treść). Poza tym ten element może też zawierać niektóre czynności, np. przycisk „onclick”.
Zapis JSON |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
Pola | |
---|---|
topLabel
|
Tekst etykiety głównej. Formatowanie jest obsługiwane. |
content
|
Tekst treści. Sformatowany tekst jest obsługiwany i zawsze wymagany. |
contentMultiline
|
Treść powinna być wielowierszowa. |
bottomLabel
|
Tekst dolnej etykiety. Formatowanie jest obsługiwane. |
onClick
|
Działanie „onclick”. Można kliknąć tylko etykietę górną, dolną i region treści. |
Pole sumy
icons
. Musisz określić co najmniej jedną z tych ikon: górna i dolna etykieta.
icons
może mieć tylko jedną z tych wartości:
|
|
icon
|
Wartość wyliczenia, która zostanie zastąpiona przez Chat Chat odpowiednim obrazem ikony. |
iconUrl
|
Ikona określona przez adres URL. |
Pole sumy
control
. Widżet sterujący. Można ustawić przycisk lub Switch_Widget, ale nie oba te elementy.
control
może mieć tylko jedną z tych wartości:
|
|
button
|
Przycisk, który można kliknąć, aby wywołać działanie. |
Ikona
Zestaw obsługiwanych ikon.
Wartości w polu enum | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
Przycisk
Przycisk. Może to być przycisk tekstowy lub graficzny.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
textButton
|
Przycisk z tekstem i działaniem onclick. |
imageButton
|
Przycisk z obrazem i działaniem onclick. |
Przycisk tekstowy
Przycisk z tekstem i działaniem onclick.
Zapis JSON |
---|
{
"text": string,
"onClick": {
object (
|
Pola | |
---|---|
text
|
Tekst na przycisku. |
onClick
|
Działanie „onclick” przycisku. |
Przycisk Obraz
Przycisk obrazu z działaniem onclick.
Zapis JSON |
---|
{ "onClick": { object ( |
Pola | |
---|---|
onClick
|
Działanie „onclick”. |
name
|
Nazwa tego przycisku graficznego, który będzie używany na potrzeby ułatwień dostępu. Jeśli deweloperzy tego nie określą, zostanie podana wartość domyślna. |
Pole sumy
icons
. Ikona może być określona przez wyliczenie ikony lub adres URL.
icons
może mieć tylko jedną z tych wartości:
|
|
icon
|
Ikona określona przez wyliczenie, która wskazuje ikonę udostępnioną przez interfejs Chat API. |
iconUrl
|
Ikona określona przez adres URL. |
Działanie karty
Działanie karty to działanie powiązane z kartą. W przypadku karty faktury typowym działaniem jest usunięcie faktury lub e-maila z fakturą albo otwarcie faktury w przeglądarce.
Nieobsługiwane przez aplikacje Google Chat.
Zapis JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Pola | |
---|---|
actionLabel
|
Etykieta, która była wyświetlana w pozycji menu czynności. |
onClick
|
Działanie „onclick” tego działania. |