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ą rozdzielone linią.

cardActions[]

object (CardAction)

Działania tej karty.

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 podano zarówno tytuł, jak i podtytuł, każdy z nich zajmuje 1 wiersz. Jeśli podany jest tylko tytuł, zajmuje 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 kolekcję widżetów, które są renderowane (pionowo) w kolejności, w jakiej zostały określone. Na wszystkich platformach karty mają stałą, niewielką 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. Sformatowany tekst jest obsługiwany. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach do 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. Przyciski to również oneof data i tylko jedno z tych pól powinno być ustawione.

WidgetMarkup może zawierać tylko jeden z tych elementów. Możesz użyć wielu pól WidgetMarkup, aby wyświetlić więcej elementów. Poniżej znajduje się lista pól, które wzajemnie się 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 element klucz-wartość w tym widżecie.

Koniec pól wykluczających się wzajemnie.

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)

Działanie onclick.

aspectRatio

number

Format obrazu (szerokość i wysokość). To pole pozwala zarezerwować odpowiednią wysokość obrazu podczas oczekiwania na jego wczytanie. Nie ma on zastępować wbudowanego formatu obrazu. Jeśli nie jest ustawiony, serwer wypełnia go przez pobranie obrazu z wyprzedzeniem.

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 wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
action

object (FormAction)

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

Koniec pól wykluczających się wzajemnie.

FormAction

Działanie 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 identyfikacji części formularza, która spowodowała jego przesłanie. Te informacje są przekazywane z powrotem 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 zachowanie.

parameters[]

object (ActionParameter)

Lista parametrów działania.

ActionParameter

Lista parametrów ciągu znaków, które mają być podawane podczas wywoływania metody działania. Rozważmy na przykład 3 przyciski odkładania: odłóż teraz, odłóż na 1 dzień, odłóż na następny tydzień. Możesz użyć action method = snooze(), przekazując typ i czas drzemki na liście parametrów ciągu znaków.

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ć pewne działania, takie jak przycisk onclick.

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 górnej etykiety. Obsługiwany jest sformatowany tekst. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach do Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.

content

string

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

contentMultiline

boolean

Określa, czy treść powinna być wielowierszowa.

bottomLabel

string

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

onClick

object (OnClick)

Działanie onclick. Klikalne są tylko górna etykieta, dolna etykieta i obszar treści.

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

enum (Icon)

Wartość typu wyliczeniowego, 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ę wzajemnie.
Widżet sterujący. Możesz ustawić button lub switch_widget, ale nie obie te wartości. Poniżej znajduje się lista pól, które wzajemnie się 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ę wzajemnie.

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 przycisk z obrazem.

Zapis JSON
{

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

object (TextButton)

Przycisk z tekstem i działaniem onclick.

imageButton

object (ImageButton)

Przycisk z obrazem i działaniem onclick.

Koniec pól wykluczających się wzajemnie.

TextButton

Przycisk z tekstem i działaniem onclick.

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

string

Tekst na przycisku.

onClick

object (OnClick)

Działanie przycisku: onclick.

ImageButton

Przycisk obrazu z działaniem onclick.

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

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

object (OnClick)

Działanie onclick.

name

string

Nazwa tego elementu imageButton używana na potrzeby ułatwień dostępu. Jeśli nie podasz tej nazwy, zostanie użyta wartość domyślna.

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

enum (Icon)

Ikona określona przez enum, która wskazuje ikonę udostępnianą przez interfejs Chat API.

iconUrl

string

Ikona określona przez adres URL.

Koniec pól wykluczających się wzajemnie.

CardAction

Działanie karty to działanie powiązane z kartą. W przypadku karty faktury typowym działaniem jest: 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, która była wyświetlana w elemencie menu czynności.

onClick

object (OnClick)

Działanie onclick dla tego działania.