Karta
Interfejs karty wyświetlany w wiadomości w Google Chat lub dodatku do Google Workspace.
Karty obsługują zdefiniowany układ, interaktywne elementy interfejsu (np. przyciski) i elementy multimedialne (np. obrazy). Za pomocą kart możesz prezentować szczegółowe informacje, zbierać informacje od użytkowników i pomagać im zrobić kolejny krok.
Projektuj karty i wyświetl ich podgląd w kreatorze kart.
Otwórz Kreator kart
Aby dowiedzieć się, jak tworzyć karty, zapoznaj się z tą dokumentacją:
- W przypadku aplikacji Google Chat przeczytaj artykuł o projektowaniu komponentów karty lub okna.
- Informacje o dodatkach do Google Workspace znajdziesz w artykule Interfejsy oparte na kartach.
Przykład: wiadomość na karcie do aplikacji Google Chat
Aby utworzyć przykładową wiadomość karty w Google Chat, użyj tego kodu JSON:
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
Zapis JSON |
---|
{ "header": { object ( |
Pola | |
---|---|
header
|
Nagłówek karty. Nagłówek zazwyczaj zawiera obraz i tytuł. Nagłówki są zawsze wyświetlane u góry karty. |
sections[]
|
Zawiera kolekcję widżetów. Każda sekcja ma własny, opcjonalny nagłówek. Sekcje są wizualnie oddzielone separatorem liniowym. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Definiowanie sekcji karty. |
sectionDividerStyle
|
Styl podziału między sekcjami. |
cardActions[]
|
Działania karty. Działania są dodawane do menu karty na pasku narzędzi. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
Na przykład ten kod JSON tworzy menu działań karty z opcjami
|
name
|
Nazwa karty. Używany jako identyfikator karty w nawigacji kart. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
fixedFooter
|
Stała stopka wyświetlana u dołu tej karty.
Ustawienie Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
displayStyle
|
W Dodatkach do Google Workspace ustawia właściwości wyświetlania Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
peekCardHeader
|
Podczas wyświetlania treści kontekstowych nagłówek karty podglądu działa jak obiekt zastępczy, aby użytkownik mógł przechodzić między kartami strony głównej i kartami kontekstowymi. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
CardHeader
Reprezentuje nagłówek karty. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie nagłówka.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"title": string,
"subtitle": string,
"imageType": enum (
|
Pola | |
---|---|
title
|
Wymagane. Tytuł nagłówka karty. 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
|
Podtytuł karty. Jeśli zostanie podany, pojawi się w osobnym wierszu pod |
imageType
|
Kształt użyty do przycięcia obrazu. Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
imageUrl
|
Adres URL HTTPS obrazu w nagłówku karty. |
imageAltText
|
Tekst alternatywny tego obrazu, który jest używany na potrzeby ułatwień dostępu. |
ImageType
Kształt użyty do przycięcia obrazu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
SQUARE
|
Wartość domyślna. Stosuje do obrazu kwadratową maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się na 3 x 3. |
CIRCLE
|
Stosuje do obrazu okrągłą maskę. Na przykład obraz o wymiarach 4 x 3 zmieni się w koło o średnicy 3. |
Sekcja
Sekcja zawiera zbiór widżetów, które są renderowane w pionie w określonej kolejności.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"header": string,
"widgets": [
{
object (
|
Pola | |
---|---|
header
|
Tekst widoczny u góry sekcji. Obsługuje prosty tekst w formacie HTML. 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[]
|
Wszystkie widżety w sekcji. Musi zawierać co najmniej jeden widżet. |
collapsible
|
Wskazuje, czy ta sekcja jest zwijana. Sekcje zwijane ukrywają niektóre lub wszystkie widżety. Użytkownicy mogą je rozwinąć, aby wyświetlić ukryte widżety, klikając Pokaż więcej. Użytkownicy mogą ponownie ukryć widżety, klikając Pokaż mniej.
Aby określić, które widżety są ukryte, wybierz |
uncollapsibleWidgetsCount
|
Liczba widżetów, których nie można zwijać, które pozostają widoczne nawet po zwinięciu sekcji.
Jeśli na przykład sekcja zawiera 5 widżetów, a |
Widżet
Każda karta składa się z widżetów.
Widżet to obiekt złożony, który może reprezentować jeden z tekstów, obrazów, przycisków i innych typów obiektów.
Zapis JSON |
---|
{ "horizontalAlignment": enum ( |
Pola | |
---|---|
horizontalAlignment
|
Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny. |
Pole sumy data . Widżet może zawierać tylko jeden z poniższych elementów. Aby wyświetlić więcej elementów, możesz użyć wielu pól widżetu.
data może mieć tylko jedną z tych wartości:
|
|
textParagraph
|
Wyświetla akapit tekstu. Obsługuje prosty tekst w formacie HTML. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. Na przykład ten kod JSON tworzy pogrubienie tekstu:
|
image
|
Wyświetla obraz. Na przykład ten kod JSON tworzy obraz z tekstem alternatywnym:
|
decoratedText
|
Wyświetla ozdobiony element tekstowy. Na przykład poniższy kod JSON tworzy ozdobny widżet tekstowy z adresem e-mail:
|
buttonList
|
Lista przycisków. Poniższy przykładowy kod JSON tworzy 2 przyciski. Pierwszy to niebieski przycisk tekstowy, a drugi to przycisk graficzny, którego kliknięcie otwiera link:
|
textInput
|
Wyświetla pole tekstowe, w którym użytkownicy mogą pisać. Na przykład ten kod JSON tworzy pole tekstowe do wpisania adresu e-mail:
W kolejnym przykładzie ten kod JSON tworzy dane wejściowe na potrzeby języka programowania ze statycznymi sugestiami:
|
selectionInput
|
Wyświetla element sterujący, który pozwala użytkownikom wybierać elementy. Elementami sterującymi mogą być pola wyboru, przyciski, przełączniki lub menu. Na przykład ten kod JSON tworzy menu, które pozwala użytkownikom wybrać rozmiar:
|
dateTimePicker
|
Wyświetla widżet, który umożliwia użytkownikom wpisywanie daty, godziny lub daty i godziny. Na przykład ten kod JSON tworzy selektor daty i godziny, aby zaplanować spotkanie:
|
divider
|
Wyświetla linię poziomą między widżetami. Na przykład następujący kod JSON tworzy separator:
|
grid
|
Wyświetla siatkę z kolekcją elementów. Siatka może zawierać dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez górne granice elementów, które są podzielone przez liczbę kolumn. Siatka zawierająca 10 elementów i 2 kolumny ma 5 wierszy. Siatka z 11 elementami i 2 kolumnami ma 6 wierszy. Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Na przykład ten kod JSON tworzy siatkę z 2 kolumnami z 1 elementem:
|
columns
|
Wyświetla do 2 kolumn.
Aby uwzględnić więcej niż 2 kolumny lub użyć wierszy, użyj widżetu Na przykład ten plik JSON tworzy 2 kolumny, z których każda zawiera akapity tekstu:
|
TextParagraph
Akapit tekstu, który obsługuje formatowanie. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Dodawanie akapitu tekstu sformatowanego w formacie. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "text": string } |
Pola | |
---|---|
text
|
Tekst widoczny w widżecie. |
Obraz
Obraz określony przez adres URL i który może mieć działanie onClick
. Przykład: Dodawanie obrazu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"imageUrl": string,
"onClick": {
object (
|
Pola | |
---|---|
imageUrl
|
Adres URL HTTPS hostujący obraz. Na przykład:
|
onClick
|
To działanie jest wywoływane, gdy użytkownik kliknie obraz. |
altText
|
Tekst alternatywny tego obrazu, który jest używany na potrzeby ułatwień dostępu. |
OnClick
Określa, jak odpowiedzieć, gdy użytkownik kliknie interaktywny element na karcie, np. przycisk.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
action
|
Jeśli określisz działanie, zostanie ono wyzwalane przez ten komponent |
openLink
|
Jeśli określisz ten parametr, |
openDynamicLinkAction
|
Dodatek uruchamia to działanie, gdy trzeba otworzyć link. Różni się to od metody Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
card
|
Nowa karta jest przekazywana do stosu kart po kliknięciu, jeśli została podana. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
Działanie
Działanie opisujące zachowanie po przesłaniu formularza. Możesz na przykład wywołać skrypt Apps Script do obsługi formularza. Jeśli to działanie zostanie wywołane, wartości formularza zostaną przesłane na serwer.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "function": string, "parameters": [ { object ( |
Pola | |
---|---|
function
|
Funkcja niestandardowa wywoływana po kliknięciu lub aktywowaniu elementu zawierającego element. Informacje o wykorzystaniu znajdziesz w artykule Odczytywanie danych formularzy. |
parameters[]
|
Lista parametrów działań. |
loadIndicator
|
Określa wskaźnik wczytywania, który wyświetla się podczas wywoływania wezwania do działania. |
persistValues
|
Wskazuje, czy wartości formularza są zachowywane po wykonaniu działania. Wartością domyślną jest
Jeśli
Jeśli wybierzesz |
interaction
|
Opcjonalnie. Wymagane przy otwieraniu okna. Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.
Jeśli nie określono inaczej, aplikacja odpowiada, wykonując w normalny sposób polecenie
Dzięki określeniu Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace. |
requiredWidgets[]
|
Opcjonalnie. Wpisz na liście nazwy widżetów, które są wymagane w ramach tej akcji do prawidłowego przesłania zgłoszenia.
Jeśli wymienione tu widżety nie mają wartości po wywołaniu tej akcji, przesyłanie formularza jest przerywane. Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
allWidgetsAreRequired
|
Opcjonalnie. Jeśli ta zasada ma wartość prawda, wszystkie widżety są uznawane za wymagane.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
ActionParameter
Lista parametrów ciągu znaków, które mają zostać dostarczone po wywołaniu metody działania. Rozważmy na przykład trzy przyciski drzemki: Drzemka teraz, Odłóż na jeden dzień i Drzemka w kolejnym 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.
Więcej informacji: CommonEventObject
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "key": string, "value": string } |
Pola | |
---|---|
key
|
Nazwa parametru skryptu działania. |
value
|
Wartość parametru. |
LoadIndicator
Określa wskaźnik wczytywania, który wyświetla się podczas wywoływania wezwania do działania.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
SPINNER
|
Wyświetla wskaźnik postępu ładowania treści. |
NONE
|
Nic nie jest wyświetlane. |
Interakcja
Opcjonalnie. Wymagane przy otwieraniu okna.
Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.
Jeśli nie określono inaczej, aplikacja odpowiada, wykonując w normalny sposób polecenie action
, np. otwierając link lub uruchamiając funkcję.
Dzięki określeniu interaction
aplikacja może reagować w specjalny, interaktywny sposób. Jeśli na przykład ustawisz interaction
na OPEN_DIALOG
, aplikacja może otwierać okno dialogowe.
Gdy podasz ten parametr, wskaźnik wczytywania nie będzie wyświetlany. Jeśli określisz konfigurację dla dodatku, cała karta zostanie usunięta i klient nie będzie wyświetlać żadnych danych.
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
INTERACTION_UNSPECIFIED
|
Wartość domyślna. action działa w normalny sposób.
|
OPEN_DIALOG
|
Otwiera okno, czyli okienny interfejs z kartami, za pomocą którego aplikacje Google Chat komunikują się z użytkownikami. Obsługiwane tylko przez aplikacje do obsługi czatu w odpowiedzi na kliknięcia przycisków w wiadomościach kart. Jeśli określisz konfigurację dla dodatku, cała karta zostanie usunięta i klient nie będzie wyświetlać żadnych danych. Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace. |
OpenLink
Reprezentuje zdarzenie onClick
, które otwiera hiperlink.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "url": string, "openAs": enum ( |
Pola | |
---|---|
url
|
Adres URL do otwarcia. |
openAs
|
Jak otworzyć link. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
onClose
|
Czy klient zapomina o linku po jego otwarciu czy obserwuje go, dopóki okno nie zostanie zamknięte. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
OpenAs
Gdy akcja OnClick
otwiera link, klient może otworzyć go jako okno pełnowymiarowe (jeśli jest to ramka używana przez klienta) lub jako nakładkę (np. wyskakujące okienko). Implementacja zależy od możliwości platformy klienta, a wybrana wartość może zostać ignorowana, jeśli klient jej nie obsługuje.
Usługa FULL_SIZE
jest obsługiwana przez wszystkie klienty.
Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
Wartości w polu enum | |
---|---|
FULL_SIZE
|
Link otwiera się jako okno pełnowymiarowe (jeśli jest to ramka używana przez klienta). |
OVERLAY
|
Link otwiera się jako nakładka, np. wyskakujące okienko. |
OnClose
Co robi klient, gdy link otwarty przez działanie OnClick
zostanie zamknięty.
Implementacja zależy od możliwości platformy klienta. Przeglądarka może na przykład otworzyć link w wyskakującym okienku z modułem obsługi OnClose
.
Jeśli ustawione są zarówno moduły obsługi OnOpen
, jak i OnClose
, a platforma kliencka nie obsługuje obu wartości, pierwszeństwo ma OnClose
.
Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
Wartości w polu enum | |
---|---|
NOTHING
|
Wartość domyślna. Karta nie jest doładowywana i nic się nie dzieje. |
RELOAD
|
Wczytuje ponownie kartę po zamknięciu okna podrzędnego.
W połączeniu z |
DecoratedText
Widżet wyświetlający tekst z opcjonalnymi dekoracjami, takimi jak etykieta nad lub pod tekstem, ikona przed tekstem, widżet wyboru czy przycisk za tekstem. Przykład w aplikacjach Google Chat znajdziesz w sekcji Wyświetlanie tekstu z tekstem dekoracyjnym.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "icon": { object ( |
Pola | |
---|---|
icon
|
Wycofano na rzecz: |
startIcon
|
Ikona wyświetlana przed tekstem. |
topLabel
|
Tekst, który wyświetla się nad polem |
text
|
Wymagane. Tekst główny. Obsługuje proste formatowanie. Więcej informacji o formatowaniu tekstu znajdziesz w artykułach Formatowanie tekstu w aplikacjach Google Chat i Formatowanie tekstu w dodatkach do Google Workspace. |
wrapText
|
Ustawienie zawijania tekstu. Jeśli ustawiona jest wartość
Dotyczy tylko |
bottomLabel
|
Tekst widoczny pod nagłówkiem |
onClick
|
To działanie jest wywoływane, gdy użytkownik kliknie |
Pole sumy control . Przycisk, przełącznik, pole wyboru lub obraz wyświetlane po prawej stronie tekstu w widżecie decoratedText .
control może mieć tylko jedną z tych wartości:
|
|
button
|
Przycisk, który użytkownik może kliknąć, aby wywołać działanie. |
switchControl
|
Widżet przełączania, który użytkownik może kliknąć, aby zmienić swój stan i wywołać działanie. |
endIcon
|
Ikona wyświetlana po tekście. Obsługuje ikony wbudowane i niestandardowe. |
Ikona
Ikona wyświetlana w widżecie na karcie. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie ikony.
Obsługuje ikony wbudowane i niestandardowe.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "altText": string, "imageType": enum ( |
Pola | |
---|---|
altText
|
Opcjonalnie. Opis ikony używanej na potrzeby ułatwień dostępu. Jeśli nie określono inaczej, podana jest wartość domyślna
Jeśli ikona jest ustawiona w |
imageType
|
Styl przycinania zastosowany do obrazu. W niektórych przypadkach przycięcie obrazu |
Pole sumy icons . Ikona wyświetlana w widżecie na karcie.
icons może mieć tylko jedną z tych wartości:
|
|
knownIcon
|
wyświetlać jedną z wbudowanych ikon dostępnych w Google Workspace;
Aby na przykład wyświetlić ikonę samolotu, podaj Pełną listę obsługiwanych ikon znajdziesz w opisie ikon wbudowanych. |
iconUrl
|
Wyświetlaj ikonę niestandardową hostowaną pod adresem URL HTTPS. Na przykład:
Obsługiwane typy plików to |
materialIcon
|
Wyświetlaj jedną z ikon materiałów Google. Aby na przykład wyświetlić ikonę pola wyboru, użyj
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace. |
MaterialIcon
Ikona Google Material, która zawiera ponad 2500 opcji.
Aby na przykład wyświetlić ikonę pola wyboru z niestandardową wagą i oceną, wpisz:
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Zapis JSON |
---|
{ "name": string, "fill": boolean, "weight": integer, "grade": integer } |
Pola | |
---|---|
name
|
Nazwa ikony zdefiniowana w ikonie Material Design, na przykład |
fill
|
Określa, czy ikona wyświetla się jako wypełniona. Wartość domyślna to false (fałsz). Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj. |
weight
|
Grubość konturu ikony. Do wyboru masz {100, 200, 300, 400, 500, 600, 700}. Jeśli go brak, wartość domyślna to 400. Jeśli zostanie określona jakakolwiek inna wartość, zostanie użyta wartość domyślna. Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj. |
grade
|
Na grubość symbolu wpływa waga i stopień. Zmiany oceny są bardziej szczegółowe niż zmiany wagi i mają niewielki wpływ na wielkość symbolu. Wybierz wartość spośród {-25, 0, 200}. Jeśli go brak, wartość domyślna to 0. Jeśli zostanie określona jakakolwiek inna wartość, zostanie użyta wartość domyślna. Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i dostosuj ustawienia w sekcji Dostosuj. |
Przycisk
Tekst, ikona lub tekst i przycisk ikony, które użytkownicy mogą kliknąć. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie przycisku.
Aby zmienić obraz w przycisk, który można kliknąć, określ właściwość
(nie Image
) i ustaw działanie ImageComponent
onClick
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "text": string, "icon": { object ( |
Pola | |
---|---|
text
|
Tekst wyświetlany na przycisku. |
icon
|
Obraz ikony. Jeśli ustawiono zarówno |
color
|
Jeśli zasada jest skonfigurowana, przycisk zostanie wypełniony jednolitym kolorem tła, a kolor czcionki zostanie zmieniony, aby zachować kontrast z tłem. Na przykład ustawienie niebieskiego tła powoduje prawdopodobnie utworzenie białego tekstu. Jeśli zasada jest nieskonfigurowana, tło obrazu jest białe, a czcionka jest niebieska.
W przypadku czerwonego, zielonego i niebieskiego wartość każdego pola jest liczbą
Opcjonalnie
W przypadku Na przykład ten kolor oznacza półprzezroczystą czerwień:
|
onClick
|
Wymagane. Działanie, które ma zostać wykonane po kliknięciu przycisku przez użytkownika, np. otwarcie hiperlinku lub uruchomienie funkcji niestandardowej. |
disabled
|
Jeśli |
altText
|
Tekst alternatywny używany na potrzeby ułatwień dostępu. Ustaw tekst opisu, który poinformuje użytkowników, 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 stronie https://developers.google.com/workspace/chat". |
Kolor
Reprezentuje kolor w przestrzeni kolorów RGBA. Ta reprezentacja została zaprojektowana z myślą o ułatwieniu konwersji wyświetlania i reprezentacji kolorów w różnych językach ze względu na złożoność. Pola tej reprezentacji można na przykład łatwo przekazać do konstruktora java.awt.Color
w języku Java, a także w prosty sposób udostępnić je w metodzie +colorWithRed:green:blue:alpha
interfejsu UIColor w iOS oraz za pomocą niewielkiej pracy można je łatwo sformatować w ciągu CSS rgba()
w JavaScript.
Na tej stronie referencyjnej nie ma informacji o bezwzględnej przestrzeni kolorów, która powinna być używana do interpretacji wartości RGB (np. sRGB, Adobe RGB, DCI-P3 i BT.2020). Domyślnie aplikacje powinny zakładać przestrzeń kolorów sRGB.
Gdy trzeba określić równość kolorów, implementacje (o ile nie udokumentowano inaczej), traktuj 2 kolory jako równe, jeśli wszystkie ich wartości czerwonego, zielonego, niebieskiego i alfa różnią się maksymalnie
1e-5
.
Przykład (Java):
import com.google.type.Color;
// ...
public static java.awt.Color fromProto(Color protocolor) {
float alpha = protocolor.hasAlpha()
? protocolor.getAlpha().getValue()
: 1.0;
return new java.awt.Color(
protocolor.getRed(),
protocolor.getGreen(),
protocolor.getBlue(),
alpha);
}
public static Color toProto(java.awt.Color color) {
float red = (float) color.getRed();
float green = (float) color.getGreen();
float blue = (float) color.getBlue();
float denominator = 255.0;
Color.Builder resultBuilder =
Color
.newBuilder()
.setRed(red / denominator)
.setGreen(green / denominator)
.setBlue(blue / denominator);
int alpha = color.getAlpha();
if (alpha != 255) {
result.setAlpha(
FloatValue
.newBuilder()
.setValue(((float) alpha) / denominator)
.build());
}
return resultBuilder.build();
}
// ...
Przykład (iOS / Obj-C):
// ...
static UIColor* fromProto(Color* protocolor) {
float red = [protocolor red];
float green = [protocolor green];
float blue = [protocolor blue];
FloatValue* alpha_wrapper = [protocolor alpha];
float alpha = 1.0;
if (alpha_wrapper != nil) {
alpha = [alpha_wrapper value];
}
return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
}
static Color* toProto(UIColor* color) {
CGFloat red, green, blue, alpha;
if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
return nil;
}
Color* result = [[Color alloc] init];
[result setRed:red];
[result setGreen:green];
[result setBlue:blue];
if (alpha <= 0.9999) {
[result setAlpha:floatWrapperWithValue(alpha)];
}
[result autorelease];
return result;
}
// ...
Przykład (JavaScript):
// ...
var protoToCssColor = function(rgb_color) {
var redFrac = rgb_color.red || 0.0;
var greenFrac = rgb_color.green || 0.0;
var blueFrac = rgb_color.blue || 0.0;
var red = Math.floor(redFrac * 255);
var green = Math.floor(greenFrac * 255);
var blue = Math.floor(blueFrac * 255);
if (!('alpha' in rgb_color)) {
return rgbToCssColor(red, green, blue);
}
var alphaFrac = rgb_color.alpha.value || 0.0;
var rgbParams = [red, green, blue].join(',');
return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};
var rgbToCssColor = function(red, green, blue) {
var rgbNumber = new Number((red << 16) | (green << 8) | blue);
var hexString = rgbNumber.toString(16);
var missingZeros = 6 - hexString.length;
var resultBuilder = ['#'];
for (var i = 0; i < missingZeros; i++) {
resultBuilder.push('0');
}
resultBuilder.push(hexString);
return resultBuilder.join('');
};
// ...
Zapis JSON |
---|
{ "red": number, "green": number, "blue": number, "alpha": number } |
Pola | |
---|---|
red
|
Ilość czerwieni w kolorze jako wartość przedziału [0, 1]. |
green
|
Ilość zieleni w kolorze jako wartość przedziału [0–1]. |
blue
|
Ilość koloru niebieskiego jako wartość przedziału [0, 1]. |
alpha
|
Odsetek tego koloru, jaki ma zostać zastosowany do piksela. Oznacza to, że ostateczny kolor w pikselach jest określany przez równanie:
Oznacza to, że wartość 1,0 odpowiada jednolitego koloru, a 0,0 – całkowicie przezroczystemu. Wykorzystuje komunikat otoki, a nie prostą wartość skalarną zmiennoprzecinkową, dzięki czemu można odróżnić wartość domyślną od wartości nieskonfigurowanej. Jeśli zostanie pominięty, obiekt koloru będzie renderowany jako jednolity kolor (tak jakby wartość alfa otrzymała jawną wartość 1,0). |
SwitchControl
Przełącznik stylu lub pole wyboru w widżecie decoratedText
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Obsługiwane tylko w widżecie decoratedText
.
Zapis JSON |
---|
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object ( |
Pola | |
---|---|
name
|
Nazwa, pod którą widżet przełączania jest identyfikowany w zdarzeniu danych wejściowych formularza. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
value
|
Wartość wpisana przez użytkownika, zwrócona w ramach zdarzenia wprowadzania danych w formularzu. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
selected
|
Gdy wybierzesz |
onChangeAction
|
Działanie, które ma zostać wykonane po zmianie stanu przełącznika, np. wybór funkcji, która ma zostać uruchomiona. |
controlType
|
Sposób wyświetlania przełącznika w interfejsie. Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
ControlType
Sposób wyświetlania przełącznika w interfejsie.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
SWITCH
|
Przełącznik typu przełącznik. |
CHECKBOX
|
Wycofano na rzecz: CHECK_BOX .
|
CHECK_BOX
|
Pole wyboru. |
ButtonList
Lista przycisków ułożonych poziomo. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie przycisku.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"buttons": [
{
object (
|
Pola | |
---|---|
buttons[]
|
Kilka przycisków. |
TextInput
Pole, w którym użytkownicy mogą wpisywać tekst. Obsługuje sugestie i działania związane ze zmianą. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Dodawanie pola, w którym użytkownik może wpisywać tekst.
Aplikacje do obsługi czatu odbierają i mogą przetwarzać wartość wpisanego tekstu podczas zdarzeń wprowadzania danych w formularzu. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy.
Jeśli chcesz zbierać niezdefiniowane lub abstrakcyjne dane o użytkownikach, używaj tekstu do wprowadzania danych. Aby zbierać zdefiniowane lub wyliczone dane od użytkowników, użyj widżetu SelectionInput
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum ( |
Pola | |
---|---|
name
|
Nazwa, pod którą wpisywane są dane w zdarzeniu do wprowadzania danych w formularzu. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
label
|
Tekst, który pojawia się nad polem wprowadzania tekstu w interfejsie.
Wpisz tekst, który pomoże użytkownikowi wpisać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład pytasz kogoś o imię, ale potrzebujesz imienia i nazwiska, wpisz
Wymagany, jeśli właściwość |
hintText
|
Tekst wyświetlany poniżej pola do wprowadzania tekstu, który ma pomóc użytkownikom przez prośbę o wpisanie określonej wartości. Ten tekst jest zawsze widoczny.
Wymagany, jeśli właściwość |
value
|
Wartość wpisana przez użytkownika, zwrócona w ramach zdarzenia wprowadzania danych w formularzu. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
type
|
Sposób wyświetlania pola do wprowadzania tekstu w interfejsie. np. czy pole jest jednowierszowe czy wielowierszowe. |
onChangeAction
|
Co zrobić, gdy zmiana wprowadzona w polu wprowadzania tekstu Na przykład użytkownik dodaje informacje do pola lub usuwa tekst. Możesz na przykład uruchomić funkcję niestandardową lub otworzyć okno dialogowe w Google Chat. |
initialSuggestions
|
Sugerowane wartości, które użytkownicy mogą wpisywać. Te wartości pojawiają się, gdy użytkownik kliknie wewnątrz pola do wprowadzania tekstu. Gdy użytkownik wpisuje tekst, sugerowane wartości są dynamicznie filtrowane na podstawie wpisywanego przez niego tekstu.
Na przykład w polu do wprowadzania tekstu w języku programowania możesz zobaczyć propozycje Javy, JavaScriptu, Pythona i C++. Gdy użytkownik zacznie pisać
Sugerowane wartości pomagają kierować użytkowników do wpisywania wartości, które są zrozumiałe dla aplikacji. W odniesieniu do języka JavaScript niektórzy użytkownicy mogą wpisywać wartości
Gdy została określona, Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
autoCompleteAction
|
Opcjonalnie. Określ działanie, które ma być wykonywane, gdy pole wprowadzania tekstu zawiera sugestie użytkownikom, którzy z niego korzystają.
Jeśli nie określono inaczej, sugestie są ustawiane przez Jeśli zostanie określone, aplikacja podejmuje określone tu działanie, na przykład uruchamia funkcję niestandardową. Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat. |
validation
|
Określ weryfikację niezbędną dla tego pola do wprowadzania tekstu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
placeholderText
|
Tekst, który pojawia się w polu do wprowadzania tekstu, gdy pole jest puste. Użyj tego tekstu, aby prosić użytkowników o wpisanie wartości. Przykład: Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace. |
Typ
Sposób wyświetlania pola do wprowadzania tekstu w interfejsie. np. jednowierszowe czy wielowierszowe. Jeśli określono initialSuggestions
, type
ma zawsze wartość SINGLE_LINE
, nawet jeśli jest ustawiona na MULTIPLE_LINE
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
SINGLE_LINE
|
Pole do wprowadzania tekstu ma stałą wysokość 1 wiersza. |
MULTIPLE_LINE
|
Pole do wprowadzania tekstu ma stałą wysokość wielu wierszy. |
RenderActions
Zestaw instrukcji renderowania, które informują kartę o wykonaniu działania lub informuje aplikację hostującą dodatek lub aplikację Google Chat o wykonanie działania związanego z aplikacją.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Pola | |
---|---|
action |
Działanie
Pola | |
---|---|
navigations[] |
Przekazywanie lub aktualizowanie wyświetlanych kart. |
Sugestie
Sugerowane wartości, które użytkownicy mogą wpisywać. Te wartości pojawiają się, gdy użytkownik kliknie wewnątrz pola do wprowadzania tekstu. Gdy użytkownik wpisuje tekst, sugerowane wartości są dynamicznie filtrowane na podstawie wpisywanego przez niego tekstu.
Na przykład w polu do wprowadzania tekstu w języku programowania możesz zobaczyć propozycje Javy, JavaScriptu, Pythona i C++. Gdy użytkownik zacznie pisać Jav
, pojawi się lista filtrów sugestii, które wyświetlą Java
i JavaScript
.
Sugerowane wartości pomagają kierować użytkowników do wpisywania wartości, które są zrozumiałe dla aplikacji. W odniesieniu do języka JavaScript niektórzy użytkownicy mogą wpisywać wartości javascript
, a inni java script
. Sugerowanie JavaScript
może ujednolicić sposób, w jaki użytkownicy korzystają z aplikacji.
Gdy została określona, TextInput.type
ma zawsze wartość SINGLE_LINE
, nawet jeśli jest ustawiona na MULTIPLE_LINE
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"items": [
{
object (
|
Pola | |
---|---|
items[]
|
Lista sugestii używanych do autouzupełniania rekomendacji w polach do wprowadzania tekstu. |
SuggestionItem
Jedna sugerowana wartość, którą użytkownicy mogą wpisać w polu do wprowadzania tekstu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
text
|
Wartość sugerowanej wartości wejściowej w polu do wprowadzania tekstu. Jest to odpowiednik strony wpisywanej przez użytkownika. |
Weryfikacja
Reprezentuje dane niezbędne do weryfikacji widżetu, do którego jest dołączony.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{
"characterLimit": integer,
"inputType": enum (
|
Pola | |
---|---|
characterLimit
|
Określ limit znaków dla widżetów wprowadzania tekstu. Pamiętaj, że służy tylko do wprowadzania tekstu i jest ignorowana w przypadku innych widżetów.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
inputType
|
Określ typ widżetów do wprowadzania danych.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
InputType
Typ widżetu do wprowadzania danych.
Wartości w polu enum | |
---|---|
INPUT_TYPE_UNSPECIFIED
|
Nieokreślony typ. Nie używać. |
TEXT
|
Zwykły tekst, który akceptuje wszystkie znaki. |
INTEGER
|
Liczba całkowita. |
FLOAT
|
Wartość zmiennoprzecinkowa. |
EMAIL
|
Adres e-mail. |
EMOJI_PICKER
|
Emotikon wybrany z selektora emotikonów dostarczonego przez system. |
SelectionInput
Widżet, który tworzy co najmniej 1 element interfejsu, który użytkownicy mogą wybrać. Może to być na przykład menu lub pola wyboru. Za pomocą tego widżetu możesz zbierać dane, które można prognozować lub wyliczać. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Dodawanie elementów interfejsu do wyboru.
Aplikacje do obsługi czatu mogą przetwarzać wartość elementów wybranych lub wprowadzonych przez użytkowników. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy.
Aby zbierać niezdefiniowane lub abstrakcyjne dane o użytkownikach, używaj widżetu TextInput
.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Pola | |
---|---|
name
|
Nazwa, która określa wybór w zdarzeniu wejścia formularza. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
label
|
Tekst, który pojawia się w interfejsie nad polem do wprowadzania wyboru. Wpisz tekst, który pomoże użytkownikowi wpisać informacje, których potrzebuje Twoja aplikacja. Jeśli na przykład użytkownicy wybierają z menu pilność zgłoszenia do pracy, etykieta może mieć wartość „Pilne” lub „Wybierz pilne”. |
type
|
Typ elementów wyświetlanych użytkownikom w widżecie |
items[]
|
Tablica elementów do wyboru. Może to być na przykład tablica przycisków opcji lub pól wyboru. Obsługuje do 100 elementów. |
onChangeAction
|
Jeśli określisz, formularz zostanie przesłany, gdy wybór ulegnie zmianie. Jeśli go nie podasz, musisz określić osobny przycisk służący do przesyłania formularza. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
multiSelectMaxSelectedItems
|
W przypadku menu wielokrotnego wyboru jest to maksymalna liczba elementów, które użytkownik może wybrać. Minimalna wartość to 1 element. Jeśli nie określono inaczej, domyślnie są to 3 elementy. |
multiSelectMinQueryLength
|
W przypadku menu wyboru wielokrotnego jest to liczba znaków tekstowych wpisanych przez użytkownika przed autouzupełnieniem zapytania aplikacji i wyświetlenie sugerowanych elementów w menu. Jeśli nie określono inaczej, domyślnie jest to 0 znaków w przypadku statycznych źródeł danych i 3 znaki w przypadku zewnętrznych źródeł danych. |
validation
|
W przypadku menu jest to weryfikacja tego pola do wprowadzania wyboru.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
Pole sumy
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
|
|
externalDataSource
|
Zewnętrzne źródło danych, np. relacyjna baza danych. |
platformDataSource
|
Źródło danych z Google Workspace. |
SelectionType
Format elementów, które użytkownicy mogą wybierać. Różne opcje obsługują różne typy interakcji. Na przykład użytkownicy mogą zaznaczyć wiele pól wyboru, ale tylko jeden element z menu.
Każde pole wyboru obsługuje 1 typ wyboru. Nie obsługuje na przykład mieszania pól wyboru i przełączników.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
CHECK_BOX
|
Zestaw pól wyboru. Użytkownicy mogą zaznaczyć jedno lub więcej pól wyboru. |
RADIO_BUTTON
|
Zestaw opcji. Użytkownicy mogą wybrać 1 przycisk. |
SWITCH
|
Zestaw przełączników. Użytkownicy mogą włączyć co najmniej 1 przełącznik. |
DROPDOWN
|
Menu. Użytkownicy mogą wybrać w menu 1 element. |
MULTI_SELECT
|
Menu wielokrotnego wyboru na potrzeby danych statycznych lub dynamicznych. Na pasku menu użytkownicy wybierają co najmniej 1 element. Użytkownicy mogą też wpisywać wartości, aby wypełnić dane dynamiczne. Użytkownicy mogą na przykład zacząć wpisywać nazwę pokoju w Google Chat, a widżet automatycznie zasugeruje pokój. Aby wypełnić elementy w menu wyboru wielokrotnego, możesz użyć jednego z tych typów źródeł danych:
Przykłady implementacji menu wyboru wielokrotnego znajdziesz w artykule Dodawanie menu wyboru wielokrotnego. Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Wybór wielokrotny dla dodatków do Google Workspace jest dostępny w wersji przedpremierowej dla programistów. |
SelectionItem
Element, który użytkownicy mogą wybrać w ramach zaznaczenia, np. pole wyboru lub przełącznik.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "text": string, "value": string, "selected": boolean, "startIconUri": string, "bottomText": string } |
Pola | |
---|---|
text
|
Tekst, który określa lub opisuje produkt użytkownikom. |
value
|
Wartość powiązana z tym elementem. Klient powinien użyć jej jako wartości wejściowej formularza. Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
selected
|
Określa, czy element jest wybrany domyślnie. Jeśli dane wejściowe wyboru akceptują tylko jedną wartość (np. dla przycisków lub menu), ustaw to pole tylko dla 1 elementu. |
startIconUri
|
W przypadku menu wyboru wielokrotnego jest to adres URL ikony wyświetlany obok pola |
bottomText
|
W przypadku menu wyboru wielokrotnego jest to opis tekstowy lub etykieta wyświetlana pod polem |
PlatformDataSource
W przypadku widżetu
, który używa menu wielokrotnego wyboru, jest to źródło danych z Google Workspace. Służy do wypełniania elementów w menu wielokrotnego wyboru.
SelectionInput
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy data_source . Źródło danych.
data_source może mieć tylko jedną z tych wartości:
|
|
commonDataSource
|
Źródło danych udostępniane przez wszystkie aplikacje Google Workspace, w tym przez użytkowników w organizacji Google Workspace. |
hostAppDataSource
|
Źródło danych unikalne dla aplikacji hosta Google Workspace, takiej jak pokoje w Google Chat. |
CommonDataSource
Źródło danych współdzielone przez wszystkie aplikacje Google Workspace.
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
UNKNOWN
|
Wartość domyślna. Nie używaj. |
USER
|
Użytkownicy Google Workspace. Użytkownik może tylko wyświetlać i wybierać użytkowników z organizacji Google Workspace. |
HostAppDataSourceMarkup
W przypadku widżetu
, który używa menu wielokrotnego wyboru, jest to źródło danych z aplikacji Google Workspace. Źródło danych wypełni elementy wyboru w menu wyboru wielokrotnego.
SelectionInput
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy data_source . Aplikacja Google Workspace, która wypełnia elementy w przypadku menu wielokrotnego wyboru.
data_source może mieć tylko jedną z tych wartości:
|
|
chatDataSource
|
Źródło danych z Google Chat. |
ChatClientDataSourceMarkup
W przypadku widżetu
, który korzysta z menu wielokrotnego wyboru, jest to źródło danych z Google Chat. Źródło danych wypełni elementy wyboru w menu wyboru wielokrotnego. Użytkownik może na przykład wybrać pokoje Google Chat, do których jest.
SelectionInput
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy source . Źródło danych Google Chat.
source może mieć tylko jedną z tych wartości:
|
|
spaceDataSource
|
Pokoje Google Chat, do których należy użytkownik. |
SpaceDataSource
Źródło danych, które wypełni pokoje Google Chat jako elementy menu wyboru wielokrotnego. Zapełnia tylko pokoje, do których należy użytkownik.
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Zapis JSON |
---|
{ "defaultToCurrentSpace": boolean } |
Pola | |
---|---|
defaultToCurrentSpace
|
Jeśli ma wartość |
DateTimePicker
Pozwala użytkownikom wpisać datę, godzinę lub zarówno datę, jak i godzinę. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Zezwalanie użytkownikowi na wybór daty i godziny.
Użytkownicy mogą wpisywać tekst lub wybierać daty i godziny za pomocą selektora. Jeśli użytkownicy wprowadzą nieprawidłową datę lub godzinę, w selektorze wyświetli się błąd i prośba o prawidłowe wpisanie informacji.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "name": string, "label": string, "type": enum ( |
Pola | |
---|---|
name
|
Nazwa, pod którą Więcej informacji o pracy z danymi formularzy znajdziesz w sekcji Odbieranie danych formularzy. |
label
|
Tekst, który prosi użytkownika o wpisanie daty, godziny lub daty i godziny. Jeśli na przykład użytkownicy planują spotkanie, użyj etykiety takiej jak |
type
|
Określa, czy widżet obsługuje wprowadzanie daty, godziny czy daty i godziny. |
valueMsEpoch
|
Wartość domyślna wyświetlana w widżecie (w milisekundach od czasu uniksowego).
Określ wartość na podstawie typu selektora (
|
timezoneOffsetDate
|
Liczba określająca przesunięcie strefy czasowej w stosunku do czasu UTC w minutach. Jeśli jest skonfigurowana, |
onChangeAction
|
Wywoływane, gdy użytkownik kliknie Zapisz lub Wyczyść w interfejsie |
validation
|
Opcjonalnie. Określ sprawdzanie poprawności wymaganej dla tego selektora datetimer.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. |
DateTimePickerType
Format daty i godziny w widżecie DateTimePicker
. Określa, czy użytkownicy mogą wpisywać datę, godzinę czy datę i godzinę.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
DATE_AND_TIME
|
Użytkownicy wpisują datę i godzinę. |
DATE_ONLY
|
Użytkownicy wpisują datę. |
TIME_ONLY
|
Użytkownicy podają godzinę. |
Separator
Ten typ nie ma żadnych pól.
Wyświetla linię między widżetami w postaci poziomej linii. Informacje o używaniu aplikacji Google Chat znajdziesz w artykule Dodawanie poziomego separatora między widżetami.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Na przykład następujący kod JSON tworzy separator:
"divider": {}
GRid
Wyświetla siatkę z kolekcją elementów. Elementy mogą zawierać tylko tekst lub obrazy. W przypadku kolumn elastycznych lub jeśli chcesz uwzględnić więcej niż tekst lub obrazy, użyj właściwości
. Informacje o używaniu aplikacji do obsługi Google Chat znajdziesz w artykule Wyświetlanie siatki z kolekcją elementów.
Columns
Siatka może zawierać dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez liczbę elementów podzieloną przez kolumny. Siatka zawierająca 10 elementów i 2 kolumny ma 5 wierszy. Siatka z 11 elementami i 2 kolumnami ma 6 wierszy.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Na przykład ten kod JSON tworzy siatkę z 2 kolumnami z 1 elementem:
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
Zapis JSON |
---|
{ "title": string, "items": [ { object ( |
Pola | |
---|---|
title
|
Tekst wyświetlany w nagłówku siatki. |
items[]
|
Elementy do wyświetlenia w siatce. |
borderStyle
|
Styl obramowania, który ma być stosowany do każdego elementu siatki. |
columnCount
|
Liczba kolumn wyświetlanych w siatce. Jeśli nie określisz wartości tego pola, zostanie użyta wartość domyślna, która będzie się różnić w zależności od miejsca wyświetlania siatki (w oknie dialogowym lub w aplikacji towarzyszącej). |
onClick
|
Tego wywołania zwrotnego używa każdy element siatki, ale z identyfikatorem i indeksem elementu na liście elementów dodanymi do parametrów wywołania zwrotnego. |
GridItem
Reprezentuje element w układzie siatki. Elementy mogą zawierać tekst, obraz lub zarówno tekst, jak i obraz.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "id": string, "image": { object ( |
Pola | |
---|---|
id
|
Określony przez użytkownika identyfikator tego elementu siatki. Ten identyfikator jest zwracany w parametrach wywołania zwrotnego |
image
|
Obraz wyświetlany w elemencie siatki. |
title
|
Tytuł elementu siatki. |
subtitle
|
Podtytuł elementu siatki. |
layout
|
Układ elementu siatki. |
ImageComponent
Reprezentuje obraz.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "imageUri": string, "altText": string, "cropStyle": { object ( |
Pola | |
---|---|
imageUri
|
Adres URL obrazu. |
altText
|
Etykieta ułatwień dostępu dla obrazu. |
cropStyle
|
Styl przycinania obrazu. |
borderStyle
|
Styl obramowania, który ma być stosowany do obrazu. |
ImageCropStyle
Reprezentuje styl przycinania zastosowany do obrazu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Aby na przykład zastosować format obrazu 16:9:
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
Zapis JSON |
---|
{
"type": enum (
|
Pola | |
---|---|
type
|
Typ przycinania. |
aspectRatio
|
Format obrazu używany przy typie przycinania to Aby na przykład zastosować format obrazu 16:9:
|
ImageCropType
Reprezentuje styl przycinania zastosowany do obrazu.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED
|
Nie używaj. Nie określono. |
SQUARE
|
Wartość domyślna. Przycina kwadratowe. |
CIRCLE
|
Powoduje przycięcie okrężne. |
RECTANGLE_CUSTOM
|
Powoduje zastosowanie prostokątnego przycięcia o niestandardowym współczynniku proporcji. Ustaw niestandardowy format obrazu za pomocą aspectRatio .
|
RECTANGLE_4_3
|
Zastosuje prostokątne przycięcie o współczynniku proporcji 4:3. |
BorderStyle
Opcje stylu obramowania karty lub widżetu, w tym typ i kolor obramowania.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type
|
Typ obramowania. |
strokeColor
|
Kolory, które mają być używane, gdy typ to |
cornerRadius
|
Promień narożnika obramowania. |
BorderType
Reprezentuje typy obramowań zastosowane do widżetów.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
BORDER_TYPE_UNSPECIFIED
|
Nie używaj. Nie określono. |
NO_BORDER
|
Wartość domyślna. Bez obramowania. |
STROKE
|
Outline. |
GridItemLayout
Reprezentuje różne opcje układu dostępne dla elementu siatki.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED
|
Nie używaj. Nie określono. |
TEXT_BELOW
|
Tytuł i podtytuł są widoczne pod obrazem siatki. |
TEXT_ABOVE
|
Tytuł i podtytuł są widoczne nad obrazem siatki. |
Kolumny
Widżet Columns
wyświetla maksymalnie 2 kolumny na karcie lub w oknie. Do każdej kolumny można dodać widżety. Widżety wyświetlają się w określonej kolejności. Informacje o aplikacjach Google Chat znajdziesz w artykule Wyświetlanie kart i okien w kolumnach.
Wysokość każdej kolumny jest określana na podstawie jej wyższej kolumny. Jeśli na przykład pierwsza kolumna jest wyższa od drugiej, obie kolumny mają wysokość pierwszej kolumny. Każda kolumna może zawierać różną liczbę widżetów, więc nie możesz definiować wierszy ani wyrównywać widżetów między kolumnami.
Kolumny są wyświetlane obok siebie. Możesz dostosować szerokość każdej kolumny za pomocą pola HorizontalSizeStyle
. Jeśli szerokość ekranu użytkownika jest zbyt mała, druga kolumna zawija się pod pierwszą:
- W witrynach na komputery druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 480 pikseli.
- Na urządzeniach z iOS druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 300 punktów.
- Na urządzeniach z Androidem druga kolumna zawija się, gdy szerokość ekranu jest mniejsza lub równa 320 dp.
Aby uwzględnić więcej niż 2 kolumny lub użyć wierszy, użyj widżetu
.
Grid
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.
Zapis JSON |
---|
{
"columnItems": [
{
object (
|
Pola | |
---|---|
columnItems[]
|
Tablica kolumn. Na karcie lub w oknie możesz umieścić maksymalnie 2 kolumny. |
Kolumna
Kolumna.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.
Zapis JSON |
---|
{ "horizontalSizeStyle": enum ( |
Pola | |
---|---|
horizontalSizeStyle
|
Określa, w jaki sposób kolumna wypełnia szerokość karty. |
horizontalAlignment
|
Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny. |
verticalAlignment
|
Określa, czy widżety mają być wyrównywane do góry, do dołu czy do środka kolumny. |
widgets[]
|
Tablica widżetów w kolumnie. Widżety wyświetlają się w określonej kolejności. |
HorizontalSizeStyle
Określa, w jaki sposób kolumna wypełnia szerokość karty. Szerokość każdej kolumny zależy zarówno od szerokości HorizontalSizeStyle
, jak i szerokości widżetów w kolumnie.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.
Wartości w polu enum | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED
|
Nie używaj. Nie określono. |
FILL_AVAILABLE_SPACE
|
Wartość domyślna. Kolumna wypełnia dostępną przestrzeń, do 70% szerokości karty. Jeśli obie kolumny mają wartość FILL_AVAILABLE_SPACE , każda z nich zajmuje 50% miejsca.
|
FILL_MINIMUM_SPACE
|
Kolumna zapełnia najmniejszą możliwą ilość miejsca i nie może przekraczać 30% szerokości karty. |
HorizontalAlignment
Określa, czy widżety mają być wyrównywane do lewej, do prawej czy do środka kolumny.
Dostępne w aplikacjach Google Chat i niedostępne w przypadku dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED
|
Nie używaj. Nie określono. |
START
|
Wartość domyślna. Wyrównuje widżety do pozycji początkowej kolumny. W przypadku układów od lewej do prawej wyrównuje do lewej. W przypadku układów od prawej do lewej wyrównuje się do prawej. |
CENTER
|
Wyrównuje widżety do środka kolumny. |
END
|
Wyrównuje widżety do pozycji końcowej kolumny. W przypadku układów od lewej do prawej wyrównuje widżety do prawej. W przypadku układów od prawej do lewej wyrównuje widżety do lewej strony. |
VerticalAlignment
Określa, czy widżety mają być wyrównywane do góry, do dołu czy do środka kolumny.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.
Wartości w polu enum | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED
|
Nie używaj. Nie określono. |
CENTER
|
Wartość domyślna. Wyrównuje widżety do środka kolumny. |
TOP
|
Wyrównuje widżety do góry kolumny. |
BOTTOM
|
Wyrównuje widżety do dołu kolumny. |
Widżety
Obsługiwane widżety, które możesz uwzględnić w kolumnie.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace. Kolumny dodatków do Google Workspace są dostępne w wersji przedpremierowej dla programistów.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy
|
|
textParagraph
|
Widżet |
image
|
Widżet |
decoratedText
|
Widżet |
buttonList
|
Widżet |
textInput
|
Widżet |
selectionInput
|
Widżet |
dateTimePicker
|
Widżet |
DividerStyle
Styl przerywnika karty. Obecnie ten typ jest używany tylko do rozdzielania sekcji kart.
Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
Wartości w polu enum | |
---|---|
DIVIDER_STYLE_UNSPECIFIED
|
Nie używaj. Nie określono. |
SOLID_DIVIDER
|
Opcja domyślna. Utwórz linię podziału między sekcjami. |
NO_DIVIDER
|
Jeśli zasada jest skonfigurowana, separatory między sekcjami nie są renderowane. |
CardAction
Działanie karty to działanie powiązane z kartą. Na przykład karta faktury może zawierać takie działania jak usunięcie faktury lub jej wysłanie e-mailem czy otwarcie faktury w przeglądarce.
Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
Zapis JSON |
---|
{
"actionLabel": string,
"onClick": {
object (
|
Pola | |
---|---|
actionLabel
|
Etykieta, która wyświetla się jako element menu czynności. |
onClick
|
Działanie |
DisplayStyle
W przypadku dodatków do Google Workspace określa sposób wyświetlania karty.
Dostępne w przypadku dodatków do Google Workspace i niedostępne w aplikacjach Google Chat.
Wartości w polu enum | |
---|---|
DISPLAY_STYLE_UNSPECIFIED
|
Nie używaj. Nie określono. |
PEEK
|
Nagłówek karty pojawia się u dołu paska bocznego i częściowo zasłania bieżącą górną kartę stosu. Kliknięcie nagłówka powoduje umieszczenie karty w stosie kart. Jeśli karta nie ma nagłówka, zamiast niego używany jest wygenerowany nagłówek. |
REPLACE
|
Wartość domyślna. Karta wyświetla się po zastąpieniu widoku górnej karty w grupie kart. |