Cards v1

Karta

Karta to element interfejsu, który może zawierać widżety interfejsu, takie jak tekst i obrazy.

Zapis JSON
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
Pola
header

object (CardHeader)

Nagłówek karty. Nagłówek zwykle zawiera tytuł i obraz.

sections[]

object (Section)

Sekcje są oddzielone linią.

cardActions[]

object (CardAction)

Działania na tej karcie.

name

string

Nazwa karty.

CardHeader

Zapis JSON
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
Pola
title

string

Musisz podać tytuł. Nagłówek ma stałą wysokość: jeśli podasz zarówno tytuł, jak i podtytuł, każdy z nich zajmie jeden wiersz. Jeśli podasz tylko tytuł, zajmie on oba wiersze.

subtitle

string

Podtytuł nagłówka karty.

imageStyle

enum (ImageStyle)

Typ obrazu (np. kwadratowe lub okrągłe obramowanie).

imageUrl

string

Adres URL obrazu w nagłówku karty.

ImageStyle

Wartości w polu enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Kwadratowe obramowanie.
AVATAR Okrągłe obramowanie.

Sekcja

Sekcja zawiera zbiór widżetów, które są renderowane (pionowo) w kolejności, w jakiej zostały określone. Na wszystkich platformach karty mają wąską, stałą szerokość, więc obecnie nie ma potrzeby stosowania właściwości układu (np. float).

Zapis JSON
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
Pola
header

string

Nagłówek sekcji. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

widgets[]

object (WidgetMarkup)

Sekcja musi zawierać co najmniej 1 widżet.

WidgetMarkup

Widżet to element interfejsu, który wyświetla tekst i obrazy.

Zapis JSON
{
  "buttons": [
    {
      object (Button)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
Pola
buttons[]

object (Button)

Lista przycisków. Pole Buttons jest też oneof data i należy ustawić tylko jedno z tych pól.

A WidgetMarkup może zawierać tylko jeden z tych elementów. Możesz użyć wielu pól WidgetMarkup, aby wyświetlić więcej produktów. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
textParagraph

object (TextParagraph)

Wyświetl akapit tekstu w tym widżecie.

image

object (Image)

Wyświetl obraz w tym widżecie.

keyValue

object (KeyValue)

Wyświetl w tym widżecie element z kluczową wartością.

Koniec pól wykluczających się nawzajem.

TextParagraph

Akapit tekstu. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

Zapis JSON
{
  "text": string
}
Pola
text

string

Obraz

Obraz określony przez adres URL, który może mieć działanie onclick.

Zapis JSON
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
Pola
imageUrl

string

Adres URL obrazu.

onClick

object (OnClick)

onclick

aspectRatio

number

Format obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości obrazu podczas oczekiwania na jego załadowanie. Nie ma on zastępować wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go przez wstępne pobranie obrazu.

OnClick

działanie onclick (np. otwarcie linku).

Zapis JSON
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
Pola
Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
action

object (FormAction)

Działanie formularza jest aktywowane przez to działanie onclick, jeśli zostało określone.

Koniec pól wykluczających się nawzajem.

FormAction

Czynność formularza opisuje zachowanie po przesłaniu formularza. Możesz na przykład wywołać Apps Script, aby obsłużyć formularz.

Zapis JSON
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
Pola
actionMethodName

string

Nazwa metody służy do identyfikowania części formularza, która spowodowała przesłanie formularza. Te informacje są odsyłane do aplikacji Google Chat w ramach zdarzenia kliknięcia karty. Możesz użyć tej samej nazwy metody w przypadku kilku elementów, które wywołują wspólne działanie.

parameters[]

object (ActionParameter)

Lista parametrów działania.

ActionParameter

Lista parametrów ciągu znaków do podania podczas wywoływania metody działania. Na przykład możesz mieć 3 przyciski odkładania: odłóż teraz, odłóż o 1 dzień i odłóż o tydzień. Możesz użyć action method = snooze(), przekazując typ i czas odroczenia na liście parametrów tekstowych.

Zapis JSON
{
  "key": string,
  "value": string
}
Pola
key

string

Nazwa parametru skryptu działania.

value

string

Wartość parametru.

KeyValue

Element interfejsu zawiera klucz (etykietę) i wartość (treść). Ten element może też zawierać niektóre działania, np.onclickprzycisk.

Zapis JSON
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
Pola
topLabel

string

Tekst etykiety u góry. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

content

string

Tekst treści. Formatowanie tekstu jest obsługiwane i zawsze wymagane. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

contentMultiline

boolean

Czy treść powinna być wielowierszowa.

bottomLabel

string

Tekst etykiety u dołu. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

onClick

object (OnClick)

onclick Klikalne są tylko etykieta u góry, etykieta u dołu i region treści.

Musisz zdefiniować co najmniej jedną z tych właściwości: icons,top_labelbottom_label. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
icon

enum (Icon)

Wartość wyliczeniowa, która jest zastępowana przez interfejs Chat API odpowiednim obrazem ikony.

iconUrl

string

Ikona określona przez adres URL.

Koniec pól wykluczających się nawzajem.
widżet sterujący, Możesz ustawić wartość button lub switch_widget, ale nie obie jednocześnie. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
button

object (Button)

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

Koniec pól wykluczających się nawzajem.

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
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
Pola
Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
textButton

object (TextButton)

Przycisk z tekstem i onclickdziałaniem.

imageButton

object (ImageButton)

Przycisk z obrazem i onclickdziałaniem.

Koniec pól wykluczających się nawzajem.

TextButton

Przycisk z tekstem i onclickdziałaniem.

Zapis JSON
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
Pola
text

string

Tekst na przycisku.

onClick

object (OnClick)

onclick działanie przycisku.

ImageButton

Przycisk graficzny z  onclick działaniem.

Zapis JSON
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  "icon": enum (Icon),
  "iconUrl": string
}
Pola
onClick

object (OnClick)

onclick

name

string

Nazwa tego elementu imageButton, która jest używana na potrzeby ułatwień dostępu. Jeśli ta nazwa nie zostanie podana, zostanie użyta wartość domyślna.

Ikonę można określić za pomocą elementu Icon, enum lub adresu URL. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
icon

enum (Icon)

Ikona określona przez element enum, który odnosi się do ikony udostępnianej przez interfejs Chat API.

iconUrl

string

Ikona określona przez adres URL.

Koniec pól wykluczających się nawzajem.

CardAction

Działanie karty to działanie powiązane z kartą. W przypadku karty faktury typowe działania to: usuń fakturę, wyślij fakturę e-mailem lub otwórz fakturę w przeglądarce.

Nieobsługiwane przez aplikacje Google Chat.

Zapis JSON
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
Pola
actionLabel

string

Etykieta była wyświetlana w elemencie menu czynności.

onClick

object (OnClick)

Działanie po kliknięciu tego elementu działania.