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ą separatora.

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

Należy określić tytuł. Nagłówek ma stałą wysokość: jeśli określono zarówno tytuł, jak i podtytuł, każdy z nich zajmuje 1 wiersz. Jeśli określisz tylko tytuł, zajmie on oba wiersze.

subtitle

string

Podtytuł karty.

imageStyle

enum (ImageStyle)

Typ obrazu (na przykład kwadratowe obramowanie lub okrągłe obramowanie).

imageUrl

string

Adres URL obrazu w nagłówku karty.

ImageStyle

Wartości w polu enum
IMAGE_STYLE_UNSPECIFIED
IMAGE Obramowanie kwadratowe.
AVATAR Obramowanie okrągłe.

Sekcja

Sekcja zawiera kolekcję widżetów, które są renderowane (w pionie) w określonej kolejności. Na wszystkich platformach karty mają stałą szerokość, więc obecnie nie trzeba określać właściwości układu (np. liczby zmiennoprzecinkowej).

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 jeden widżet.

WidgetMarkup

Widżet to element interfejsu prezentujący tekst i obrazy.

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

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
Pola
buttons[]

object (Button)

Lista przycisków. Przyciski również mają wartość oneof data i należy ustawić tylko jedno z tych pól.

Pole sumy data. Element WidgetMarkup może mieć tylko 1 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

object (TextParagraph)

Wyświetlaj akapit tekstu w tym widżecie.

image

object (Image)

Wyświetl obraz w tym widżecie.

keyValue

object (KeyValue)

Wyświetlaj element par klucz-wartość w tym widżecie.

TextParagraph

Akapit tekstu. Obsługiwany jest format tekstu. 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 i 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

Współczynnik proporcji tego obrazu (szerokość i wysokość). To pole umożliwia zarezerwowanie odpowiedniej wysokości obrazu podczas oczekiwania na jego wczytanie. Nie zastępują one wbudowanego współczynnika proporcji obrazu. Jeśli zasada jest nieskonfigurowana, serwer wypełnia ją przez pobieranie obrazu z wyprzedzeniem.

OnClick

Działanie onclick (np. otwarcie linku).

Zapis JSON
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
Pola

Pole sumy data.

data może mieć tylko jedną z tych wartości:

action

object (FormAction)

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

FormAction

Działanie dotyczące formularza opisuje zachowanie po jego przesłaniu. Możesz na przykład wywołać Apps Script do obsługi formularza.

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

string

Nazwa metody służy do określania, która część formularza spowodowała przesłanie formularza. Te informacje są odczytywane do aplikacji Google Chat jako część zdarzenia kliknięcia karty. Tej samej nazwy metody możesz używać dla kilku elementów wywołujących te same zachowania.

parameters[]

object (ActionParameter)

Lista parametrów działań.

ActionParameter

Lista parametrów ciągu znaków, które mają zostać dostarczone po wywołaniu metody działania. Rozważmy na przykład 3 przyciski drzemki: Drzemka teraz, Drzemka o jednym dniu, Drzemka w przyszłym tygodniu. Możesz użyć właściwości action method = snooze(), aby przekazywać typ drzemki i czas drzemki na liście parametrów w postaci 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 (etykieta) i wartość (treść). Ten element może też zawierać niektóre działania, np. przycisk onclick.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
Pola
topLabel

string

Tekst górnej etykiety. Obsługiwany jest format tekstu. 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. Sformatowany tekst jest obsługiwany i zawsze wymagany. 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 dolnej etykiety. Obsługiwany jest format tekstu. 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)

Działanie onclick. Można kliknąć tylko górną etykietę, dolną etykietę i region treści.

Pole sumy icons. Musisz zdefiniować co najmniej jedną z ikon top_label i bottom_label. icons może mieć tylko jedną z tych wartości:
icon

enum (Icon)

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

iconUrl

string

Ikona określona przez adres URL.

Pole sumy control. Widżet sterujący. Możesz ustawić wartość button lub switch_widget, ale nie obie te wartości. control może mieć tylko jedną z tych wartości:
button

object (Button)

Przycisk, który może wywoływać 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 type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
Pola

Pole sumy type.

type może mieć tylko jedną z tych wartości:

textButton

object (TextButton)

Przycisk z tekstem i działaniem onclick.

imageButton

object (ImageButton)

Przycisk z obrazem i działaniem onclick.

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 graficzny z działaniem onclick.

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

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
Pola
onClick

object (OnClick)

Działanie onclick.

name

string

Nazwa tego obiektu (imageButton) używana na potrzeby ułatwień dostępu. Jeśli ta nazwa nie została określona, podawana jest wartość domyślna.

Pole sumy icons. Ikonę można określić za pomocą właściwości Icon enum lub adresu URL. icons może mieć tylko jedną z tych wartości:
icon

enum (Icon)

Ikona określona przez obiekt enum, która wskazuje ikonę dostarczonej przez Google Chat API.

iconUrl

string

Ikona określona przez adres URL.

CardAction

Działanie karty to działanie powiązane z kartą. W przypadku karty faktury zazwyczaj działanie to: usunięcie faktury, wysłanie faktury e-mail lub otwarcie faktury 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 menu czynności.

onClick

object (OnClick)

Działanie „onClick” dla tego działania.