Lista przycisków

Widżet ButtonList wyświetla zestaw przycisków. Przycisk może zawierać tekst, ikonę lub tekst i ikonę.

Każdy element Button obsługuje działanie OnClick wywoływane po kliknięciu przycisku przez użytkownika. Na przykład:

  • Otwórz hiperlink w OpenLink, na przykład hiperlink do dokumentacji Google Chat dla deweloperów https://developers.google.com/chat.
  • Uruchom działanie, które uruchamia funkcję niestandardową, np. wywoływanie interfejsu API.

Aby uniemożliwić użytkownikom klikanie przycisku, ustaw właściwość "disabled": "true".

Na potrzeby ułatwień dostępu przyciski obsługują tekst alternatywny.

Przykłady

Poniżej znajdziesz kartę składającą się z widżetu ButtonList składającego się z 2 elementów Button. 1 przycisk otwiera dokumentację dla deweloperów Google Chat w nowej karcie. Drugi przycisk uruchamia funkcję niestandardową o nazwie goToView() i przekazuje jeden parametr: viewType="Bird Eye View".

Przykład 2: przycisk z kolorem niestandardowym i zdezaktywowany przycisk

Poniżej widać kartę składającą się z widżetu ButtonList składającego się z 2 elementów Button. Pole Color umożliwia dostosowanie koloru tła przycisku jednego przycisku. Drugi przycisk jest dezaktywowany polem Disabled, przez co użytkownik nie może go kliknąć i wykonać funkcji.

Przykład 3: przyciski z ikonami

Poniżej widać kartę składającą się z widżetu ButtonList oraz 2 widżetów Button. Jeden przycisk korzysta z pola knownIcon do wyświetlania ikony wbudowanej poczty e-mail w Google Chat. Drugi przycisk wykorzystuje pole iconUrl do wyświetlania niestandardowego widżetu ikon.

Przykład 4: przyciski z ikoną i tekstem

Poniżej widać kartę składającą się z widżetu ButtonList, który zachęca użytkownika do wysłania e-maila. Pierwszy przycisk ma ikonę e-maila, a drugi – tekst. Użytkownik może kliknąć ikonę lub przycisk tekstowy, by uruchomić funkcję sendEmail.

Reprezentacja i pola w formacie JSON

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

object (Button)

Tablica przycisków.

Przycisk

Zapis JSON
{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string
}
Pola
text

string

Tekst wyświetlany na przycisku.

icon

object (Icon)

Obraz ikony. Jeśli ustawiono zarówno icon, jak i text, ikona pojawi się przed tekstem.

color

object (Color)

Jeśli zasada jest skonfigurowana, przycisk ma jednolity kolor tła, a kolor czcionki zmienia się, aby zachować kontrast z tłem. Na przykład jeśli ustawisz niebieskie tło, prawdopodobnie uzyskasz biały tekst.

Jeśli nie jest skonfigurowana, tło obrazu jest białe, a czcionka jest niebieska.

W przypadku czerwonego, zielonego i niebieskiego pola wartością każdego pola jest liczba float, którą można wyrazić na 2 sposoby: jako liczbę od 0 do 255 podzieloną przez 255 (153/255) lub jako wartość z zakresu od 0 do 1 (0,6). 0 oznacza brak koloru, a 1 lub 255/255 oznacza pełną obecność tego koloru w skali RGB.

Opcjonalnie ustaw alpha, aby określić poziom przezroczystości, korzystając z tego równania:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

W przypadku alpha wartość 1 odpowiada jednolitego koloru, a wartość 0 – kolorowi całkowicie przezroczystemu.

Na przykład ten kolor oznacza półprzezroczystą czerwień:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
   "alpha": 0.5
}
onClick

object (OnClick)

To pole jest wymagane. Działanie, które ma zostać wykonane, gdy użytkownik kliknie przycisk, na przykład otwarcie hiperlinku lub uruchomienie funkcji niestandardowej.

disabled

boolean

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

altText

string

Tekst alternatywny używany jako ułatwienia dostępu.

Ustaw opis, aby użytkownicy wiedzieli, do czego służy przycisk. Jeśli na przykład przycisk otwiera hiperlink, możesz napisać: „Otwiera nową kartę przeglądarki i przechodzi do dokumentacji dla deweloperów Google Chat na https://developers.google.com/chat".

Ikona

Ikona wyświetlana w widżecie na karcie. Przykład dotyczący aplikacji Google Chat znajdziesz w sekcji Ikona.

Obsługuje ikony wbudowane i niestandardowe.

Zapis JSON
{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string
  // End of list of possible types for union field icons.
}
Pola
altText

string

Opcjonalnie. Opis ikony używanej na potrzeby ułatwień dostępu. Jeśli nie określono inaczej, podana jest wartość domyślna Button. Warto dodać przydatny opis zawartości ikony i – w razie potrzeby – jej funkcji. 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/chat.

Jeśli ikona jest ustawiona w interfejsie Button, altText wyświetla się jako tekst pomocniczy, gdy użytkownik najedzie kursorem na przycisk. Jeśli jednak przycisk ustawia też atrybut text, altText ikony jest ignorowana.

imageType

enum (ImageType)

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

Pole sumy icons. Ikona wyświetlana w widżecie na karcie. icons może mieć tylko jeden z tych parametrów:
knownIcon

string

Wyświetlaj jedną z wbudowanych ikon Google Workspace.

Aby na przykład wyświetlić ikonę samolotu, wpisz AIRPLANE. W przypadku autobusu wpisz BUS.

Pełną listę obsługiwanych ikon znajdziesz w sekcji Ikony wbudowane.

iconUrl

string

Może wyświetlać ikonę niestandardową hostowaną pod adresem URL HTTPS.

Na przykład:

"iconUrl":
"https://developers.google.com/chat/images/quickstart-app-avatar.png"

Obsługiwane typy plików to .png i .jpg.

ImageType

Kształt użyty do przycięcia obrazu.

Wartości w polu enum
SQUARE Wartość domyślna. Dodaje do obrazu kwadratową maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się na 3 x 3.
CIRCLE Dodaje do obrazu okrągłą maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się w koło o średnicy 3.

Kolor

Zapis JSON
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Pola
red

number

Ilość czerwieni w kolorze jako wartość w przedziale [0, 1].

green

number

Ilość koloru zielonego w kolorze jako wartość przedziału [0, 1].

blue

number

Ilość koloru niebieskiego jako wartość w przedziale [0, 1].

alpha

number

Odsetek tego koloru, jaki ma zostać zastosowany do piksela. Ostateczny kolor w pikselach jest określany przez równanie:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Oznacza to, że wartość 1,0 odpowiada jednolitego koloru, a wartość 0,0 odpowiada kolorowi całkowicie przezroczystemu. Korzysta ono z komunikatu opakowania, a nie prostego skalarnego zmiennoprzecinkowego, co pozwala odróżnić wartość domyślną od nieskonfigurowanej wartości. Jeśli go pominiesz, ten obiekt koloru będzie miał jednolity kolor (tak jakby wartość alfa otrzymała wyraźnie wartość 1,0).

OnClick

Określa, jak zareagować, gdy użytkownik kliknie interaktywny element na karcie, np. przycisk.

Zapis JSON
{

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

Pole sumy data.

data może mieć tylko jeden z tych parametrów:

action

object (Action)

Jeśli określisz działanie, działanie jest aktywowane przez: onClick.

card

object (Card)

Po kliknięciu (jeśli została określona) nowa karta jest przekazywana do stosu kart.

Są obsługiwane przez dodatki do Google Workspace, ale nie przez aplikacje Google Chat.

Rozwiązywanie problemów

Gdy aplikacja lub karta Google Chat zwróci błąd, w interfejsie czatu pojawi się komunikat „Coś poszło nie tak” lub „Nie udało się przetworzyć Twojego żądania”. Czasami w interfejsie Google Chat nie pojawia się żaden komunikat o błędzie, ale aplikacja lub karta Google Chat mogą dać nieoczekiwany wynik, na przykład komunikat na karcie.

Mimo że komunikat o błędzie może nie wyświetlić się w interfejsie Google Chat, dostępne są opisowe komunikaty o błędach i dane dziennika, które pomogą Ci naprawić błędy występujące po włączeniu rejestrowania błędów w aplikacjach do obsługi czatu. Więcej informacji o wyświetlaniu, debugowaniu i naprawianiu błędów znajdziesz w artykule Rozwiązywanie problemów z Google Chat i rozwiązywanie problemów.