Package google.apps.card.v1

Indeks

Działanie

Działanie opisujące zachowanie po przesłaniu formularza. Możesz na przykład wywołać skrypt Apps Script, aby obsłużyć formularz. Jeśli działanie zostanie uruchomione, wartości formularza zostaną wysłane na serwer.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
function

string

Niestandardowa funkcja, która zostanie wywołana po kliknięciu lub aktywowaniu elementu zawierającego.

Przykładowe zastosowanie znajdziesz w sekcji Czytanie danych z formularza.
parameters[]

ActionParameter

Lista parametrów działania.
loadIndicator

LoadIndicator

Określa wskaźnik ładowania wyświetlany podczas wywoływania działania.
persistValues

bool

Wskazuje, czy wartości w formularzu są zachowywane po wykonaniu działania. Wartością domyślną jest false.

Jeśli true, wartości w formularzu pozostają po wywołaniu działania. Aby umożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw parametr LoadIndicator na NONE. W przypadku wiadomości na karcie w aplikacjach do czatu musisz też ustawić ResponseType na UPDATE_MESSAGE i użyć tej samej wartości card_id z karty zawierającej działanie.

Jeśli false, wartości formularza są wyczyszczane po uruchomieniu działania. Aby uniemożliwić użytkownikowi wprowadzanie zmian podczas przetwarzania działania, ustaw wartość parametru LoadIndicator na SPINNER.
interaction

Interaction

Opcjonalnie: Wymagany podczas otwierania okna dialogowego.

Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.

Jeśli nie zostanie określony, aplikacja zareaguje, wykonując action (np. otwierając link lub wykonując funkcję) w zwykły sposób.

Po określeniu interaction aplikacja może reagować w specjalny sposób. Na przykład ustawienie interaction na OPEN_DIALOG może spowodować otwarcie okna. Jeśli jest określony, nie jest wyświetlany wskaźnik wczytywania. Jeśli jest to określone w przypadku dodatku, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.
requiredWidgets[]

string

Opcjonalnie: Wypełnij tę listę nazwami widżetów, których ta czynność wymaga do prawidłowego przesłania.

Jeśli podczas wywołania tego działania wymienione tu widżety nie mają wartości, przesłanie formularza zostanie przerwane.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
allWidgetsAreRequired

bool

Opcjonalnie: Jeśli ma wartość true (prawda), wszystkie widżety są wymagane do wykonania tego działania.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

ActionParameter

Lista parametrów ciągu znaków do podania podczas wywołania metody działania. Możesz na przykład umieścić 3 przyciski drzemki: drzemka teraz, drzemka za 1 dzień i drzemka w następnym tygodniu. Możesz użyć action method = snooze(), przekazując typ i czas drzemki na liście parametrów ciągu znaków.

Więcej informacji znajdziesz w artykule CommonEventObject.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
key

string

Nazwa parametru skryptu działania.
value

string

Wartość parametru.

Interakcja

Opcjonalnie: Wymagany podczas otwierania okna dialogowego.

Co zrobić w odpowiedzi na interakcję z użytkownikiem, np. kliknięcie przez niego przycisku w wiadomości na karcie.

Jeśli nie zostanie określony, aplikacja zareaguje, wykonując action (np. otwierając link lub wykonując funkcję) w zwykły sposób.

Po określeniu interaction aplikacja może reagować w specjalny sposób. Na przykład ustawienie interaction na OPEN_DIALOG może spowodować otwarcie okna.

Jeśli jest określony, nie jest wyświetlany wskaźnik wczytywania. Jeśli jest to określone w przypadku dodatku, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Wartości w polu enum
INTERACTION_UNSPECIFIED Wartość domyślna. Funkcja action działa normalnie.
OPEN_DIALOG

Otwiera okno – okno z interfejsem opartym na kartach, którego aplikacje na czacie używają do interakcji z użytkownikami.

Jest obsługiwana tylko w aplikacjach Google Chat w odpowiedzi na kliknięcie przycisku w wiadomościach na karcie. Jeśli jest to określone w przypadku dodatku, cała karta jest usuwana i nic nie jest wyświetlane w kliencie.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

LoadIndicator

Określa wskaźnik ładowania wyświetlany podczas wywoływania działania.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SPINNER Wyświetla ikonę ładowania, aby wskazać, że treści są wczytywane.
NONE nic nie jest wyświetlane.

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.

Pola
type

BorderType

Typ obramowania.
strokeColor

Color

Kolory, których należy używać, gdy typ ma wartość BORDER_TYPE_STROKE.

Aby ustawić kolor obrysu, podaj wartości pól red, green i blue. Wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 1 na podstawie wartości koloru RGB, gdzie 0 (0/255) oznacza brak koloru, a 1 (255/255) – maksymalną intensywność koloru.

Na przykład następujący kod spowoduje ustawienie koloru na czerwony o maksymalnej intensywności:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Pole alpha jest niedostępne w przypadku koloru obrysu. Jeśli jest określone, to pole jest ignorowane.
cornerRadius

int32

Promień zaokrąglenia rogów obramowania.

BorderType

Reprezentuje typy obramowania 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 Kontur.

Przycisk

Tekst, ikona lub przycisk z tekstem i ikoną, który użytkownicy mogą kliknąć. Przykład dodania przycisku w aplikacjach Google Chat znajdziesz w artykule Dodawanie przycisku.

Aby obraz był klikalnym przyciskiem, określ Image (a nie ImageComponent) i ustaw działanie onClick.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst wyświetlany wewnątrz przycisku.
icon

Icon

Ikona wyświetlana na przycisku. Jeśli ustawisz zarówno parametr icon, jak i parametr text, ikona pojawi się przed tekstem.
color

Color

Opcjonalnie: Kolor przycisku. Jeśli to pole jest zaznaczone, przycisk type ma ustawienie FILLED, a kolory pól text i icon są ustawione na kontrastowe, aby zwiększyć czytelność. Jeśli na przykład kolor przycisku jest ustawiony na niebieski, tekst lub ikony na przycisku są białe.

Aby ustawić kolor przycisku, podaj wartości w polach red, green i blue. Wartość musi być liczbą zmiennoprzecinkową z zakresu od 0 do 1 na podstawie wartości koloru RGB, gdzie 0 (0/255) oznacza brak koloru, a 1 (255/255) – maksymalną intensywność koloru.

Na przykład następujący kod spowoduje ustawienie koloru na czerwony o maksymalnej intensywności:

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

Pole alpha jest niedostępne w przypadku koloru przycisku. Jeśli jest określone, to pole jest ignorowane.
onClick

OnClick

Wymagany. Działanie, które ma zostać wykonane po kliknięciu przycisku przez użytkownika, np. otwarcie hiperlinku lub wykonanie funkcji niestandardowej.
disabled

bool

Jeśli true, przycisk jest wyświetlany w stanie nieaktywnym i nie reaguje na działania użytkownika.
altText

string

Tekst zastępczy używany do ułatwień dostępu.

Ustaw tekst opisowy, który informuje 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 programistów Google Chat na stronie https://developers.google.com/workspace/chat"”.
type

Type

Opcjonalnie: Typ przycisku. Jeśli nie określisz tego ustawienia, typ przycisku zostanie domyślnie ustawiony na OUTLINED. Jeśli pole color ma ustawioną wartość, typ przycisku jest ustawiany na FILLED, a wszelkie wartości ustawione w tym polu są ignorowane.

Typ

Opcjonalnie: Typ przycisku. Jeśli pole color jest ustawione, pole type ma wartość FILLED.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Wartości w polu enum
TYPE_UNSPECIFIED Nie używaj. Nie określono.
OUTLINED Przyciski z konturem to przyciski o średnim stopniu podkreślenia. Zwykle zawierają one działania, które są ważne, ale nie są głównym działaniem w aplikacji Google Chat ani dodatku.
FILLED Wypełniony przycisk ma pojemnik w jednolitym kolorze. Ma największy wpływ wizualny i jest zalecany do stosowania w przypadku ważnych i podstawowych działań w aplikacji do czatu lub dodatku.
FILLED_TONAL Wypełniony tonalny przycisk to kompromis między wypełnionymi a obrysowanymi przyciskami. Są one przydatne w kontekstach, w których przycisk o niższym priorytecie wymaga nieco większego podkreślenia niż przycisk obrysowany.
BORDERLESS Przycisk w domyślnym stanie nie ma niewidocznego kontenera. Jest on często używany do działań o najniższym priorytecie, zwłaszcza w przypadku wyświetlania wielu opcji.

ButtonList

Lista przycisków ułożonych poziomo. Przykład dodania przycisku w aplikacjach Google Chat znajdziesz w artykule Dodawanie przycisku.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
buttons[]

Button

tablica przycisków.

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, takie jak przyciski, oraz multimedia, takie jak obrazy. Używaj kart, aby przedstawiać szczegółowe informacje, zbierać dane od użytkowników i zachęcać ich do wykonania kolejnego kroku.

Za pomocą Kreatora kart możesz projektować i wyświetlać podgląd kart.

Otwórz kreatora kart

Aby dowiedzieć się, jak tworzyć karty, zapoznaj się z tymi dokumentami:

Uwaga: na karcie możesz dodać maksymalnie 100 widżetów. Wszystkie widżety wykraczające poza ten limit są ignorowane. Ten limit dotyczy zarówno wiadomości na karcie, jak i dialogów w aplikacjach Google Chat, a także kart w dodatkach do Google Workspace.

Przykład: wiadomość na karcie w aplikacji Google Chat

Przykładowa wizytówka

Aby utworzyć wiadomość z przykładową kartą 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
Pola
header

CardHeader

Nagłówek karty. Nagłówek zwykle zawiera obraz i tytuł. Nagłówki zawsze wyświetlają się u góry karty.
sections[]

Section

Zawiera kolekcję widżetów. Każda sekcja ma swój opcjonalny nagłówek. Sekcje są wizualnie oddzielone linią. Przykład w przypadku aplikacji Google Chat znajdziesz w artykule Definiowanie sekcji karty.
sectionDividerStyle

DividerStyle

Styl separatora między nagłówkiem, sekcjami a stopką.
cardActions[]

CardAction

Czynności związane z kartą. Do menu paska narzędzi karty są dodawane działania.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Na przykład ten kod JSON tworzy menu akcji karty z opcjami Settings i Send Feedback:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

Nazwa karty. Służy jako identyfikator karty w nawigacji po kartach.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.
fixedFooter

CardFixedFooter

U dołu tej karty znajduje się stały stopka.

Ustawienie wartości fixedFooter bez określenia wartości primaryButton lub secondaryButton powoduje błąd. W przypadku aplikacji do obsługi czatu możesz używać stałych stopek w oknach, ale nie w wiadomościach na karcie.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
displayStyle

DisplayStyle

W dodatkach do Google Workspace ustawia właściwości wyświetlania peekCardHeader.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.
peekCardHeader

CardHeader

Podczas wyświetlania treści kontekstowych nagłówek karty podglądu działa jako element zastępczy, dzięki czemu użytkownik może przełączać się między kartami na stronie głównej a kartami kontekstowymi.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

CardAction

Działanie na karcie to działanie powiązane z kartą. Na karcie faktury mogą się na przykład znajdować opcje usuwania faktury, wysyłania faktury e-mailem lub otwierania faktury w przeglądarce.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Pola
actionLabel

string

Etykieta wyświetlana jako element menu działania.
onClick

OnClick

Działanie onClick dotyczące tego elementu czynności.

CardFixedFooter

stały (przyklejony) stopka, który pojawia się u dołu karty.

Ustawienie wartości fixedFooter bez określenia wartości primaryButton lub secondaryButton powoduje błąd.

W przypadku aplikacji do obsługi czatu możesz używać stałych stopek w oknach, ale nie w wiadomościach na karcie. Przykład w przypadku aplikacji Google Chat znajdziesz w artykule Dodawanie stałego stopki.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
primaryButton

Button

Główny przycisk stopki stałej. Przycisk musi być przyciskiem tekstowym z tekstem i kolorem.
secondaryButton

Button

Drugi przycisk w nieruchomym stopce. Przycisk musi być przyciskiem tekstowym z tekstem i kolorem. Jeśli parametr secondaryButton jest ustawiony, musisz też ustawić parametr primaryButton.

CardHeader

Reprezentuje nagłówek karty. Przykład w przypadku aplikacji Google Chat znajdziesz w artykule Dodawanie nagłówka.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
title

string

Wymagany. Tytuł nagłówka karty. Nagłówek ma stałą wysokość: jeśli podasz tytuł i podtytuł, każdy z nich zajmie jeden wiersz. Jeśli podany jest tylko tytuł, zajmuje on obie linie.
subtitle

string

Podtytuł nagłówka karty. Jeśli jest określony, pojawia się w osobnym wierszu pod title.
imageType

ImageType

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

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
imageUrl

string

Adres URL HTTPS obrazu w nagłówku karty.
imageAltText

string

Tekst alternatywny obrazu, który służy do ułatwień dostępu.

DisplayStyle

W dodatkach do Google Workspace określa sposób wyświetlania karty.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji 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, częściowo zakrywając aktualną górną kartę stosu. Kliknięcie nagłówka powoduje dodanie karty do grupy kart. Jeśli karta nie ma nagłówka, zamiast niego używany jest wygenerowany nagłówek.
REPLACE Wartość domyślna. Karta jest wyświetlana przez zastąpienie widoku karty na szczycie stosu kart.

DividerStyle

Styl separatora na karcie. Obecnie służy tylko do rozdzielników między sekcjami karty.

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. Wyrenderuj solidny przerywnik.
NO_DIVIDER Jeśli jest ustawiony, nie jest renderowany żaden separator. Ten styl całkowicie usuwa separator z projektu. Wynik jest równoznaczny z niedodaniem żadnego separatora.

NestedWidget

Lista widżetów, które mogą być wyświetlane w układzie zawierającym, np. CarouselCard. Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Pola

Pole unii data.

data może być tylko jednym z tych elementów:
textParagraph

TextParagraph

Widżet akapitu tekstowego.
buttonList

ButtonList

Widżet listy przycisków.
image

Image

Widżet z obrazem.

Sekcja

Sekcja zawiera kolekcję widżetów, które są renderowane w kolejności, w jakiej zostały określone.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
header

string

Tekst wyświetlany 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[]

Widget

Wszystkie widżety w sekcji. Musi zawierać co najmniej 1 widżet.
collapsible

bool

Wskazuje, czy tę sekcję można zwijać.

Sekcji można nie rozwijać, aby ukryć niektóre lub wszystkie widżety, ale 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, użyj parametru uncollapsibleWidgetsCount.
uncollapsibleWidgetsCount

int32

Liczba widżetów, których nie można zwinąć, które pozostają widoczne nawet wtedy, gdy sekcja jest zwinięta.

Jeśli na przykład sekcja zawiera 5 widżetów, a wartość parametru uncollapsibleWidgetsCount to 2, pierwsze 2 widżety są zawsze widoczne, a 3 ostatnie są domyślnie złożone. Wartość uncollapsibleWidgetsCount jest brana pod uwagę tylko wtedy, gdy wartość collapsible wynosi true.
collapseControl

CollapseControl

Opcjonalnie: Zdefiniuj przycisk rozwijania i zwijania sekcji. Ten przycisk będzie widoczny tylko wtedy, gdy sekcję można zwinąć. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Karuzela, zwana też suwakiem, wyświetla listę widżetów w formacie pokazu slajdów. Zawiera przyciski umożliwiające przejście do poprzedniego lub następnego widżetu.

Oto przykład reprezentacji JSON karuzeli zawierającej 3 widżety akapitu tekstowego.

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Pola
carouselCards[]

CarouselCard

Lista kart uwzględnionych w karuzeli.

CarouselCard

Karta, która może być wyświetlana jako element karuzeli. Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Pola
widgets[]

NestedWidget

Lista widżetów wyświetlanych na karcie karuzeli. Widgety są wyświetlane w kolejności, w jakiej zostały określone.
footerWidgets[]

NestedWidget

Lista widżetów wyświetlana u dołu karty karuzeli. Widgety są wyświetlane w kolejności, w jakiej zostały określone.

Układ scalony

Tekst, ikona lub element tekstowo-ikonowy, który użytkownicy mogą kliknąć.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
icon

Icon

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

string

Tekst wyświetlany wewnątrz elementu.
onClick

OnClick

Opcjonalnie: Działanie, które ma zostać wykonane, gdy użytkownik kliknie element, np. otwarcie hiperlinku lub wykonanie funkcji niestandardowej.
enabled
(deprecated)

bool

Określa, czy element jest aktywny i reaguje na działania użytkownika. Domyślna wartość to true. Rola wycofana. Zamiast tego użyj kolumny disabled.
disabled

bool

Określa, czy element jest nieaktywny i ignoruje działania użytkownika. Domyślna wartość to false.
altText

string

Tekst zastępczy używany do ułatwień dostępu.

Ustaw tekst opisowy, który informuje użytkowników, do czego służy dany element. Jeśli na przykład element otwiera hiperlink, napisz: „Otwiera nową kartę przeglądarki i przechodzi do dokumentacji dla programistów Google Chat na stronie https://developers.google.com/workspace/chat".

ChipList

Lista elementów ułożonych poziomo, która może być przewijana poziomo lub przenoszona na następny wiersz.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
layout

Layout

Określony układ listy elementów.
chips[]

Chip

Tablica elementów.

Układ

Układ listy elementów.

Wartości w polu enum
LAYOUT_UNSPECIFIED Nie używaj. Nie określono.
WRAPPED Wartość domyślna. Jeśli nie ma wystarczająco dużo miejsca poziomego, lista elementów jest zawijana na kolejny wiersz.
HORIZONTAL_SCROLLABLE Jeśli nie mieszczą się w dostępnej przestrzeni, elementy można przewijać poziomo.

CollapseControl

Reprezentują element sterujący rozwijania i zwijania.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
horizontalAlignment

HorizontalAlignment

Ustawienie poziome przycisku rozwijania i zwijania.
expandButton

Button

Opcjonalnie: Zdefiniuj przycisk konfigurowalny, aby rozwinąć tę sekcję. Należy ustawić pola expandButton i collapseButton. Tylko 1 z nich nie zostanie zastosowany. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.
collapseButton

Button

Opcjonalnie: Zdefiniuj konfigurowalny przycisk, aby zwinąć sekcję. Należy ustawić pola expandButton i collapseButton. Tylko 1 z nich nie zostanie zastosowany. Jeśli to pole nie jest skonfigurowane, używany jest przycisk domyślny.

Kolumny

Widget Columns wyświetla maksymalnie 2 kolumny na karcie lub w oknie dialogowym. Do każdej kolumny możesz dodać widżety, które będą się wyświetlać w kolejności, w jakiej je ustawisz. Przykłady w przypadku aplikacji Google Chat: Wyświetlanie kart i dialogów w kolumnach.

Wysokość każdej kolumny jest określana przez wyższą kolumnę. Jeśli na przykład pierwsza kolumna jest wyższa niż druga, obie kolumny mają wysokość pierwszej kolumny. Każda kolumna może zawierać inną 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. Szerokość każdej kolumny możesz dostosować za pomocą pola HorizontalSizeStyle. Jeśli szerokość ekranu użytkownika jest zbyt mała, druga kolumna jest przenoszona pod pierwszą:

  • W wersji internetowej druga kolumna jest przenoszona, jeśli szerokość ekranu jest mniejsza lub równa 480 pikselom.
  • Na urządzeniach z iOS druga kolumna jest przenoszona, jeśli szerokość ekranu jest mniejsza lub równa 300 punktom.
  • Na urządzeniach z Androidem druga kolumna jest przenoszona, jeśli 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. Interfejsy dodatków, które obsługują kolumny:

  • Okno wyświetlane, gdy użytkownicy otwierają dodatek z poziomu szkicu e-maila.
  • Okno wyświetlane, gdy użytkownicy otwierają dodatek z menu Dodaj załącznik w wydarzeniu w Kalendarzu Google.
Pola
columnItems[]

Column

Tablica kolumn. Na karcie lub w dialogu możesz umieścić maksymalnie 2 kolumny.

Kolumna

Kolumna

Dodatki i aplikacje do czatu Google Workspace

Pola
horizontalSizeStyle

HorizontalSizeStyle

Określa, jak kolumna wypełnia szerokość karty.
horizontalAlignment

HorizontalAlignment

Określa, czy widżety mają być wyrównane do lewej, prawej czy do środka kolumny.
verticalAlignment

VerticalAlignment

Określa, czy widżety mają być wyrównane do góry, dołu czy środka kolumny.
widgets[]

Widgets

Tablica widżetów zawartych w kolumnie. Widżety są wyświetlane w kolejności, w jakiej zostały określone.

HorizontalSizeStyle

Określa, jak kolumna wypełnia szerokość karty. Szerokość każdej kolumny zależy od HorizontalSizeStyle oraz szerokości widżetów w kolumnie.

Dodatki i aplikacje do czatu Google Workspace

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 wypełnia 50% przestrzeni.
FILL_MINIMUM_SPACE Kolumna zajmuje jak najmniej miejsca i nie więcej niż 30% szerokości karty.

VerticalAlignment

Określa, czy widżety mają być wyrównane do góry, dołu czy środka kolumny.

Dodatki i aplikacje do czatu Google Workspace

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.

Dodatki i aplikacje do czatu Google Workspace

Pola

Pole unii data.

data może być tylko jednym z tych elementów:
textParagraph

TextParagraph

Widżet TextParagraph.
image

Image

Widżet Image.
decoratedText

DecoratedText

Widżet DecoratedText.
buttonList

ButtonList

Widżet ButtonList.
textInput

TextInput

Widżet TextInput.
selectionInput

SelectionInput

Widżet SelectionInput.
dateTimePicker

DateTimePicker

Widżet DateTimePicker.
chipList

ChipList

Widżet ChipList.

DataActions

Działanie dodatku, które aktualizuje dane Google Workspace.

Pola
hostAppDataAction

HostAppDataActionMarkup

Określa sposób aktualizowania danych Google Workspace.

DateTimePicker

Umożliwia użytkownikom wpisanie daty, godziny lub obu tych informacji. Obsługuje weryfikację przesłania formularza. Gdy parametr Action.all_widgets_are_required ma wartość true lub ten widżet jest określony w sekcji Action.required_widgets, działanie przesyłania jest blokowane, chyba że zostanie wybrana wartość. Przykład w przypadku aplikacji Google Chat: Zezwalanie użytkownikowi na wybór daty i godziny.

Użytkownicy mogą wpisywać tekst lub używać selektora do wybierania dat i godzin. Jeśli użytkownicy wpiszą nieprawidłową datę lub godzinę, selektor wyświetli błąd z prośbą o poprawne wpisanie informacji.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Nazwa, pod którą DateTimePicker jest identyfikowany w zdarzeniu wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
label

string

Tekst, który zachęca użytkowników do wpisania daty, godziny lub daty i godziny. Jeśli na przykład użytkownicy planują spotkanie, użyj etykiety takiej jak Appointment date lub Appointment date and time.
type

DateTimePickerType

Określa, czy widżet obsługuje wprowadzanie daty, godziny lub daty i godziny.
valueMsEpoch

int64

Wartość domyślna wyświetlana w widżecie w milisekundach od czasu epoki uniksowej.

Określ wartość na podstawie typu selektora (DateTimePickerType):

  • DATE_AND_TIME: data i godzina w formacie kalendarzowym w UTC. Na przykład 1 stycznia 2023 r., godz. 12:00 czasu UTC, zapisz w ten sposób: 1672574400000.
  • DATE_ONLY: data kalendarzowa o godzinie 00:00:00 UTC. Na przykład, aby wskazać 1 stycznia 2023 r., użyj wartości 1672531200000.
  • TIME_ONLY: czas w strefie czasowej UTC. Na przykład, aby wskazać godzinę 12:00, użyj wartości 43200000 (lub 12 * 60 * 60 * 1000).
timezoneOffsetDate

int32

Liczba reprezentująca przesunięcie strefy czasowej względem UTC w minutach. Jeśli jest ustawiona, value_ms_epoch jest wyświetlana w określonej strefie czasowej. Jeśli nie jest skonfigurowana, przyjmuje się domyślne ustawienie strefy czasowej użytkownika.
onChangeAction

Action

Wywoływane, gdy użytkownik kliknie Zapisz lub Wyczyść w interfejsie DateTimePicker.

DateTimePickerType

Format daty i godziny w widżecie DateTimePicker. Określa, czy użytkownicy mogą wpisać datę, godzinę lub równocześnie 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 podają datę i godzinę.
DATE_ONLY Użytkownicy wpisują datę.
TIME_ONLY Użytkownicy podają czas.

DecoratedText

Element, który wyświetla tekst z opcjonalnymi ozdobnikami, takimi jak etykieta nad tekstem lub pod nim, ikona przed tekstem, element wyboru lub przycisk po tekście. Przykłady w aplikacji Google Chat znajdziesz w artykule Wyświetlanie tekstu z tekstem dekoracyjnym.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
icon
(deprecated)

Icon

Wycofane na rzecz startIcon.
startIcon

Icon

Ikona wyświetlana przed tekstem.
topLabel

string

Tekst, który pojawia się nad ikoną text. Zawsze skraca.
text

string

Wymagany. 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

bool

Ustawienie zawijania tekstu. Jeśli zaznaczysz true, tekst zostanie przeniesiony i wyświetlony w kilku wierszach. W przeciwnym razie tekst jest obcinany.

Dotyczy tylko text, a nie topLabel i bottomLabel.
bottomLabel

string

Tekst wyświetlany pod ikoną text. Zawsze zawija.
onClick

OnClick

To działanie jest wywoływane, gdy użytkownicy klikną topLabel lub bottomLabel.
Pole unii control. przycisk, przełącznik, pole wyboru lub obraz, które pojawiają się po prawej stronie tekstu w widżecie decoratedText; control może być tylko jednym z tych elementów:
button

Button

Przycisk, który użytkownik może kliknąć, aby wykonać określone działanie.
switchControl

SwitchControl

Element przełącznika, który użytkownik może kliknąć, aby zmienić jego stan i wywołać działanie.
endIcon

Icon

Ikona wyświetlana po tekście.

Obsługuje wbudowane i niestandardowe ikony.

SwitchControl

przełącznik 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.

Pola
name

string

Nazwa, pod którą widżet przełącznika jest identyfikowany w zdarzeniu wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
value

string

Wartość wpisana przez użytkownika, zwracana w ramach zdarzenia wprowadzenia danych w formularzu.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
selected

bool

Gdy true, przełącznik jest zaznaczony.
onChangeAction

Action

Działanie, które ma zostać wykonane po zmianie stanu przełącznika, np. jaka funkcja ma zostać uruchomiona.
controlType

ControlType

Jak przełącznik wygląda w interfejsie

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

ControlType

Jak przełącznik wygląda w interfejsie

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SWITCH Przełącznik typu „toggle”.
CHECKBOX Wycofane na rzecz CHECK_BOX.
CHECK_BOX Pole wyboru.

Separator

Ten typ nie ma pól.

Wyświetla separator między widżetami w postaci poziomej linii. Przykład w przypadku 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 ten fragment kodu JSON tworzy separator:

"divider": {}

EndNavigation

W przypadku dodatków w Google Chat zamyka okno.

Pola
action

Action

W przypadku dodatków w Google Chat – działanie, które zamyka okno dialogowe.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Działanie

W przypadku dodatków w Google Chat: działania dotyczące EndNavigation.

Wartości w polu enum
ACTION_UNSPECIFIED Nieokreślone działanie.
CLOSE_DIALOG Zamyka okno.
CLOSE_DIALOG_AND_EXECUTE Zamyka okno i odświeża kartę, która je otworzyła.

GetAutocompletionResponse

Odpowiedź na żądanie uzyskania kontenera autouzupełniania, który zawiera elementy niezbędne do wyświetlania elementów autouzupełniania w polu tekstowym.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat. Na przykład:

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
Pola
autoComplete

Suggestions
schema

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w oznaczeniu znaczników na potrzeby sprawdzania składni.

Siatka

Wyświetla siatkę z kolekcją elementów. Elementy mogą zawierać tylko tekst lub obrazy. W przypadku kolumn elastycznych lub do umieszczenia więcej niż tekstu lub obrazów użyj Columns. Przykład w przypadku aplikacji Google Chat znajdziesz w artykule Wyświetlanie siatki z kolekcją elementów.

Siatka obsługuje dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez elementy podzielone przez kolumny. Siatka z 10 elementami i 2 kolumnami 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ę 2-kolumnową z jednym 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"
    }
  }
}
Pola
title

string

Tekst wyświetlany w nagłówku siatki.
items[]

GridItem

Elementy do wyświetlenia w siatce.
borderStyle

BorderStyle

Styl obramowania, który ma być stosowany do każdego elementu siatki.
columnCount

int32

Liczba kolumn wyświetlanych w siatce. Jeśli to pole nie jest określone, używana jest wartość domyślna, która różni się w zależności od tego, gdzie jest wyświetlana siatka (w dialogu lub w usługach towarzyszących).
onClick

OnClick

Ten wywołanie zwrotne jest używane wielokrotnie przez 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 tekst i obraz.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
id

string

Określony przez użytkownika identyfikator tego elementu siatki. Ten identyfikator jest zwracany w parametrach wywołania onClick siatki nadrzędnej.
image

ImageComponent

Obraz wyświetlany w elemencie siatki.
title

string

Tytuł elementu siatki.
subtitle

string

Podtytuł elementu siatki.
layout

GridItemLayout

Układ do użycia w elemencie siatki.

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ą wyświetlane pod obrazem elementu siatki.
TEXT_ABOVE Tytuł i podtytuł są wyświetlane nad obrazem elementu siatki.

Ikona

Ikona wyświetlana w widżecie na karcie. Przykład dodania ikony w aplikacjach Google Chat znajdziesz w artykule Dodawanie ikony.

Obsługuje wbudowane i niestandardowe ikony.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
altText

string

Opcjonalnie: Opis ikony używanej w ramach ułatwień dostępu. Jeśli nie podasz wartości, zostanie użyta wartość domyślna Button. Zgodnie ze sprawdzoną metodą należy podać opis, który wyjaśnia, co przedstawia ikona, oraz, w stosownych przypadkach, co ona robi. 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/workspace/chat.

Jeśli ikona jest ustawiona w komponencie Button, gdy użytkownik najedzie na przycisk, pojawi się tekst pomocniczy altText. Jeśli jednak przycisk ustawia też wartość text, ikona altText zostanie zignorowana.
imageType

ImageType

Styl przycinania zastosowany do obrazu. W niektórych przypadkach zastosowanie funkcji przycinania CIRCLE powoduje, że obraz jest wyświetlany większy niż wbudowana ikona.
Pole unii icons. Ikona wyświetlana w widżecie na karcie. icons może być tylko jednym z tych elementów:
knownIcon

string

Wyświetl jedną z wbudowanych ikon Google Workspace.

Aby na przykład wyświetlić ikonę samolotu, użyj wartości AIRPLANE. W przypadku autobusu podaj wartość BUS.

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

string

Wyświetlanie niestandardowej ikony hostowanej pod adresem URL HTTPS.

Na przykład:

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

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

MaterialIcon

wyświetlić jedną z ikon Google Material.

Aby na przykład wyświetlić ikonę pola wyboru, użyj

"materialIcon": {
  "name": "check_box"
}

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Obraz

Obraz określony przez adres URL, który może zawierać działanie onClick. Przykład znajdziesz w sekcji Dodawanie obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
imageUrl

string

Adres URL HTTPS, na którym hostowany jest obraz.

Na przykład:

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png
onClick

OnClick

Gdy użytkownik kliknie obraz, kliknięcie spowoduje to działanie.
altText

string

Tekst alternatywny obrazu, który służy do ułatwień dostępu.

ImageComponent

Reprezentuje obraz.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
imageUri

string

Adres URL obrazu.
altText

string

Etykieta ułatwień dostępu dla obrazu.
cropStyle

ImageCropStyle

Styl przycinania, który ma zostać zastosowany do obrazu.
borderStyle

BorderStyle

Styl obramowania, który ma zostać zastosowany do obrazu.

ImageCropStyle

Reprezentuje styl przycinania zastosowany do obrazu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Oto przykład zastosowania formatu 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}
Pola
type

ImageCropType

Typ przycięcia.
aspectRatio

double

Format obrazu, który ma być użyty, jeśli typ przycięcia to RECTANGLE_CUSTOM.

Oto przykład zastosowania formatu 16:9:

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 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. Stosuje przycięcie do kwadratu.
CIRCLE Stosuje przycięcie okrągłe.
RECTANGLE_CUSTOM Stosuje przycięcie prostokątne z niestandardowym formatem. Ustaw niestandardowy format obrazu za pomocą aspectRatio.
RECTANGLE_4_3 Stosuje przycięcie prostokątne w formacie 4:3.

LinkPreview

Działanie karty, które wyświetla podgląd linku do strony zewnętrznej, pokazując kartę i element inteligentny. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linków za pomocą elementów inteligentnych.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Na przykład ten fragment kodu JSON zwraca unikalny tytuł podglądu linku i jego elementu inteligentnego oraz kartę podglądu z nagłówkiem i opisem tekstowym:

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

Przykład zwraca taki podgląd linku:

Przykład podglądu linku

Pola
previewCard

Card

Karta zawierająca informacje o linku z usługi innej firmy.
title

string

Tytuł wyświetlany w elemencie inteligentnym w podglądzie linku. Jeśli nie jest ustawiony, inteligentny element wyświetla nagłówek elementu preview_card.
linkPreviewTitle

string

Tytuł wyświetlany w podglądzie linku. Jeśli nie zostanie ustawiony, podgląd linku będzie zawierać nagłówek preview_card.

MaterialIcon

Ikona w stylu Material Design, która obejmuje ponad 2500 opcji.

Aby na przykład wyświetlić ikonę pola wyboru z niestandardową wagą i stopniem, wpisz:

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Pola
name

string

Nazwa ikony zdefiniowana w ikonach Google Material, np. check_box. Nieprawidłowe nazwy są pomijane i zastępowane pustym ciągiem, co powoduje, że ikona nie jest renderowana.
fill

bool

Określa, czy ikona jest wypełniona. Wartość domyślna to false (fałsz).

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i zmień ustawienia w sekcji Dostosuj.
weight

int32

Grubość konturu ikony. Wybierz jedną z tych wartości: {100, 200, 300, 400, 500, 600, 700}. Jeśli nie jest obecny, jego domyślną wartością jest 400. Jeśli podasz inną wartość, zostanie użyta wartość domyślna.

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i zmień ustawienia w sekcji Dostosuj.
grade

int32

Grubość linii symbolu zależy od grubości i rodzaju linii. Korekty oceny są bardziej szczegółowe niż korekty wagi i mają niewielki wpływ na rozmiar symbolu. Wybierz z poziomów {-25, 0, 200}. Jeśli nie ma tej wartości, domyślnie jest to 0. Jeśli podasz inną wartość, zostanie użyta wartość domyślna.

Aby wyświetlić podgląd różnych ustawień ikon, otwórz Ikony czcionek Google i zmień ustawienia w sekcji Dostosuj.

ModifyCard

W przypadku dodatków w Google Chat aktualizuje kartę na podstawie interakcji użytkownika. Tablica może zawierać tylko 1 obiekt.

Pola

Pole unii operation.

operation może być tylko jednym z tych elementów:
updateWidget

UpdateWidget

W przypadku dodatków w Google Chat aktualizuje widżet na karcie lub w oknie dialogowym.

UpdateWidget

W przypadku dodatków w Google Chat aktualizuje widżet na karcie lub w oknie dialogowym.

Pola
Pole unii updated_widget. Aktualizacje widżetu. updated_widget może być tylko jednym z tych elementów:
selectionInputWidgetSuggestions

SelectionInputWidgetSuggestions

W przypadku widżetów selectionInput tablica sugerowanych elementów w menu z wieloma opcjami. Gdy menu z wieloma opcjami używa zewnętrznego źródła danych do wypełniania elementów, widżet może dynamicznie wypełniać sugestie na podstawie tego, co użytkownik wpisze w menu. Więcej informacji znajdziesz w artykule Zbieranie informacji od użytkowników Google Chat.

SelectionInputWidgetSuggestions

W przypadku widżetu selectionInput, który używa menu z wieloma opcjami, zwraca elementy wyboru z zewnętrznego źródła danych dynamicznych.

Pola
suggestions[]

SelectionItem

Tablica elementów do wyboru, które pojawiają się po wpisaniu przez użytkownika tekstu w menu wielokrotnego wyboru.

aktualizuje lub przełącza się między kartami w grupie kart.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Na przykład:

1) Zwrócić nową kartę (przejście do przodu).

 navigations : {
    pushCard : CARD
  }

2) Zaktualizuj kartę na szczycie stosu (zaktualizuj na miejscu).

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3) Wróć o 1 krok bez aktualizowania.

  navigations : {
    popCard : true,
  }

4) Wróć kilka kroków wstecz i zaktualizuj tę kartę.

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5) Wróć o kilka kroków do zdefiniowanego CARD_NAME.

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6) Wróć do karty głównej i zaktualizuj ją.

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7) Przejdź do określonej karty i wysuń ją.

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

8) Zastąp górną kartę nową kartą.

  navigations : {
    updateCard : CARD
  }
Pola

Pole unii navigate_action.

navigate_action może być tylko jednym z tych elementów:
popToRoot

bool

Odłącza wszystkie karty oprócz karty głównej.
pop

bool

Wyjmij jedną kartę.
popToCard

string

Wyświetla wszystkie karty powyżej określonej karty z określoną nazwą karty.
pushCard

Card

Przesuwa kartę na stos kart.

Wersja przedpremierowa dla programistów: w przypadku dialogów w Google Chat otwiera lub aktualizuje dialog.
updateCard

Card

Zaktualizuje najlepszą kartę, zachowując wypełnione pola formularza. W przypadku nierównego pola wartość jest pomijana.

Wersja przedpremierowa dla programistów: w przypadku dialogów w Google Chat otwiera lub aktualizuje dialog.
endNavigation

EndNavigation

W przypadku dodatków w Google Chat zamyka okno.

Powiadomienie

Działanie, które wyświetla powiadomienie w aplikacji hosta Google Workspace, gdy użytkownik wejdzie w interakcję z kartą.

Podgląd dla deweloperów: w przypadku dodatków w Google Chat wyświetla powiadomienie, gdy użytkownicy prześlą i zamkną okno dialogowe.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Pola
text

string

Tekst do wyświetlenia w powiadomieniu bez tagów HTML.

OnClick

Określa sposób działania, gdy użytkownicy klikną element interaktywny na karcie, np. przycisk.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola

Pole unii data.

data może być tylko jednym z tych elementów:
action

Action

Jeśli jest określony, onClick powoduje wykonanie działania.
openDynamicLinkAction

Action

Dodatek uruchamia to działanie, gdy musi otworzyć link. Różni się to od open_link powyżej, ponieważ w tym przypadku musi ono komunikować się z serwerem, aby uzyskać link. Dlatego przed otrzymaniem odpowiedzi na działanie otwierania linku klient internetowy musi wykonać pewne czynności przygotowawcze.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.
card

Card

Po kliknięciu nowa karta jest dodawana do stosu kart (jeśli jest to określone).

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.
overflowMenu

OverflowMenu

Jeśli jest to określone, onClick otwiera menu przewijania.

OnClose

Co robi klient, gdy link otwarty przez działanie OnClick zostanie zamknięty.

Implementacja zależy od możliwości platformy klienta. Na przykład przeglądarka może otworzyć link w wyskakującym okienku za pomocą modułu obsługi OnClose.

Jeśli masz ustawione zarówno metody obsługi OnOpen, jak i OnClose, a platforma klienta nie obsługuje obu wartości, pierwszeństwo ma metoda OnClose.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Wartości w polu enum
NOTHING Wartość domyślna. Karta się nie wczytuje, nic się nie dzieje.
RELOAD

Odświeża kartę po zamknięciu okna podrzędnego.

Jeśli jest używane w połączeniu z OpenAs.OVERLAY, okno podrzędne działa jak okno modalne, a karta nadrzędna jest zablokowana, dopóki okno podrzędne nie zostanie zamknięte.

OpenAs

Gdy działanie OnClick powoduje otwarcie linku, klient może otworzyć go jako okno w pełnej wielkości (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ć zignorowana, jeśli klient jej nie obsługuje. FULL_SIZE jest obsługiwany przez wszystkich klientów.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Wartości w polu enum
FULL_SIZE Link otworzy się w oknie pełnoekranowym (jeśli jest to ramka używana przez klienta).
OVERLAY Link otwiera się jako nakładka, np. wyskakujące okienko.

OverflowMenu

Widżet, który wyświetla wyskakujące menu z co najmniej jednym działaniem, które użytkownicy mogą wykonać. Na przykład wyświetlanie na karcie działań innych niż główne. Możesz użyć tego widżetu, gdy działania nie mieszczą się w dostępnej przestrzeni. Aby go użyć, określ ten widżet w działaniu OnClick widżetów, które go obsługują. Na przykład w Button.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
items[]

OverflowMenuItem

Wymagany. Lista opcji menu.

OverflowMenuItem

Opcja, którą użytkownicy mogą wywołać w rozszerzonym menu.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
startIcon

Icon

Ikona wyświetlana przed tekstem.
text

string

Wymagany. Tekst, który identyfikuje lub opisuje produkt dla użytkowników.
onClick

OnClick

Wymagany. Działanie wywoływane po wybraniu opcji menu. Ten element OnClick nie może zawierać elementu OverflowMenu, więc wszystkie określone elementy OverflowMenu zostaną usunięte, a element menu wyłączony.
disabled

bool

Czy opcja menu jest wyłączona. Wartość domyślna to fałsz.

RenderActions

Zestaw instrukcji renderowania, który mówi dodatkowi, aby wykonał działanie na karcie lub w aplikacji hosta.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Pola
action

Action

Działanie, które dodatki mogą wykonywać, aby aktualizować interfejs.

Wersja przedpremierowa dla programistów: dodatki w Google Chat.
hostAppAction

HostAppActionMarkup

Działania obsługiwane przez poszczególne aplikacje hosta.
schema

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w oznaczeniu znaczników na potrzeby sprawdzania składni.

Działanie

Działania, których wtyczki mogą używać w kartach lub aplikacji hosta.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.

Pola
navigations[]

Navigation

Wyświetla, chowa lub aktualizuje kartę.

Wersja przedpremierowa dla programistów: dodatki w Google Chat.
notification

Notification

Wyświetla powiadomienie w aplikacji hosta Google Workspace, gdy użytkownik wejdzie w interakcję z kartą.

Podgląd dla deweloperów: w przypadku dodatków w Google Chat wyświetla powiadomienie, gdy użytkownicy prześlą i zamkną okno dialogowe.
linkPreview

LinkPreview

Dostępne w Dokumentach, Arkuszach i Prezentacjach Google. Wyświetla podgląd linków z elementami inteligentnymi i kartą. Więcej informacji znajdziesz w artykule Wyświetlanie podgląd linku za pomocą elementów inteligentnych.
modifyOperations[]

ModifyCard

W przypadku dodatków w Google Chat aktualizuje kartę na podstawie interakcji użytkownika. Tablica może zawierać tylko 1 obiekt.

SelectionInput

Widżet, który tworzy co najmniej 1 element interfejsu, który użytkownicy mogą wybrać. Obsługuje sprawdzanie poprawności przesłania formularza tylko w przypadku menu dropdown i multiselect. Gdy parametr Action.all_widgets_are_required ma wartość true lub ten widżet jest określony w sekcji Action.required_widgets, działanie przesyłania jest blokowane, chyba że zostanie wybrana wartość. Może to być na przykład menu lub pola wyboru. Za pomocą tego widżetu możesz zbierać dane, które można przewidywać lub wymieniać. Przykłady w przypadku aplikacji Google Chat znajdziesz w artykule Dodawanie elementów interfejsu do wyboru.

Komunikatory mogą przetwarzać wartości elementów wybranych lub wpisanych przez użytkowników. Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.

Aby zbierać nieokreślone lub abstrakcyjne dane od użytkowników, użyj widżetu TextInput.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Wymagany. Nazwa identyfikująca dane wejściowe wyboru w zdarzeniu z danymi wejściowymi formularza.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
label

string

Tekst wyświetlany nad polem wyboru w interfejsie.

Podaj tekst, który pomoże użytkownikowi podać informacje wymagane przez aplikację. Jeśli na przykład użytkownicy wybierają pilność zgłoszenia w menu, etykieta może brzmieć „Pilność” lub „Wybierz pilność”.
type

SelectionType

Typ elementów wyświetlanych użytkownikom w widżecie SelectionInput. Typy wyboru obsługują różne typy interakcji. Użytkownicy mogą na przykład zaznaczyć co najmniej jedno pole wyboru, ale w menu mogą wybrać tylko jedną wartość.
items[]

SelectionItem

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

Action

Jeśli to możliwe, formularz zostanie przesłany, gdy zmieni się wybrana opcja. Jeśli nie określisz tego parametru, musisz podać oddzielny przycisk, który przesyła formularz.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
multiSelectMaxSelectedItems

int32

W przypadku menu z wieloma opcjami maksymalna liczba elementów, które użytkownik może wybrać. Minimalna wartość to 1 element. Jeśli nie podasz tej wartości, zostanie użyta domyślna liczba 3.
multiSelectMinQueryLength

int32

W przypadku menu z wielokrotnie wybieranymi opcjami liczba znaków tekstowych wprowadzonych przez użytkownika przed zwróceniem przez menu sugerowanych opcji.

Jeśli nie skonfigurujesz menu wyboru wielokrotnego, zostaną użyte te wartości domyślne:

  • Jeśli menu używa stałego tablicę elementów SelectionInput, domyślnie zawiera 0 znaków i natychmiast wypełnia elementy z tablicy.
  • Jeśli menu korzysta z dynamicznego źródła danych (multi_select_data_source), przed wysłaniem zapytania do źródła danych, aby zwrócić sugerowane elementy, przyjmuje domyślnie 3 znaki.

Pole unii multi_select_data_source. W przypadku menu z wieloma opcjami źródło danych, które dynamicznie wypełnia elementy wyboru.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace. multi_select_data_source może być tylko jednym z tych elementów:
externalDataSource

Action

zewnętrzne źródło danych, np. relacyjna baza danych;
platformDataSource

PlatformDataSource

Źródło danych z Google Workspace.

PlatformDataSource

W przypadku widżetu SelectionInput, który korzysta z menu wielokrotnego wyboru, źródło danych z Google Workspace. Służy do wypełniania elementów w menu z wieloznacznikiem.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Pola
Pole unii data_source. Źródło danych. data_source może być tylko jednym z tych elementów:
commonDataSource

CommonDataSource

Źródło danych udostępniane przez wszystkie aplikacje Google Workspace, np. użytkowników w organizacji Google Workspace.
hostAppDataSource

HostAppDataSourceMarkup

Źródło danych, które jest unikalne dla aplikacji hosta Google Workspace, takiej jak pokoje w Google Chat.

To pole obsługuje biblioteki klienta interfejsów API Google, ale nie jest dostępne w bibliotekach klienta Cloud. Więcej informacji znajdziesz w artykule Instalowanie bibliotek klientów.

CommonDataSource

Źródło danych udostępniane przez wszystkie aplikacje Google Workspace.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Wartości w polu enum
UNKNOWN Wartość domyślna. Nie używaj.
USER Użytkownicy Google Workspace. Użytkownik może wyświetlać i wybierać tylko użytkowników z organizacji Google Workspace.

SelectionItem

Element, który użytkownicy mogą wybrać w polu wyboru, np. pole wyboru lub przełącznik. Obsługuje do 100 elementów.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst, który identyfikuje lub opisuje produkt dla użytkowników.
value

string

Wartość powiązana z tym elementem. Klient powinien użyć tego jako wartości wejściowej formularza.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
selected

bool

Czy element jest domyślnie zaznaczony. Jeśli pole wyboru akceptuje tylko jedną wartość (np. w przypadku przycisków opcji lub menu), ustaw to pole tylko dla jednego elementu.
startIconUri

string

W przypadku menu z wieloma opcjami do wyboru adres URL ikony wyświetlanej obok pola text elementu. Obsługuje pliki PNG i JPEG. Musi to być adres URL HTTPS. Na przykład: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png.
bottomText

string

W przypadku menu z wieloma opcjami tekstowy opis lub etykieta wyświetlane pod polem text elementu.

SelectionType

Format elementów, które użytkownicy mogą wybrać. Różne opcje obsługują różne typy interakcji. Użytkownicy mogą na przykład zaznaczyć wiele pól wyboru, ale w menu mogą wybrać tylko jeden element.

Każdy element danych wejściowych obsługuje jeden typ wyboru. Nie można na przykład łączyć 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ć co najmniej 1 pole wyboru.
RADIO_BUTTON Zestaw opcji. Użytkownik może zaznaczyć tylko 1 przycisk opcji.
SWITCH Zestaw przełączników. Użytkownicy mogą włączyć co najmniej 1 przełącznik.
DROPDOWN menu Użytkownicy mogą wybrać jeden element z menu.
MULTI_SELECT

Menu z polem tekstowym. Użytkownicy mogą wpisywać i wybierać co najmniej 1 element. W przypadku dodatków do Google Workspace musisz wypełnić elementy za pomocą stałego tablicowego ciągu obiektów SelectionItem.

W przypadku aplikacji Google Chat możesz też wypełniać elementy za pomocą dynamicznego źródła danych i automatycznie sugerować elementy, gdy użytkownicy wpisują tekst w menu. Użytkownicy mogą np. zacząć wpisywać nazwę pokoju Google Chat, a widget automatycznie zaproponuje ten pokój. Aby dynamicznie wypełniać elementy menu z wieloma opcjami, użyj jednego z tych typów źródeł danych:

  • Dane Google Workspace: elementy są wypełniane za pomocą danych z Google Workspace, takich jak użytkownicy Google Workspace czy pokoje Google Chat.
  • Dane zewnętrzne: elementy są wypełniane z zewnętrznego źródła danych spoza Google Workspace.

Przykłady implementowania menu z wieloma zaznaczeniami w aplikacjach Google Chat znajdziesz w artykule Dodawanie menu z wieloma zaznaczeniami.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

SubmitFormResponse

odpowiedź na przesłanie formularza inną niż uzyskanie kontenera autouzupełniania, który zawiera działania, które karta lub aplikacja hostująca dodatek powinna wykonać, oraz informacje o tym, czy stan karty się zmienił.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat. Na przykład:

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}
Pola
renderActions

RenderActions

Zestaw instrukcji renderowania, który instruuje kartę, aby wykonała działanie lub poprosił aplikację hosta dodatku o wykonanie działania związanego z tą aplikacją.
stateChanged

bool

czy stan kart się zmienił i czy dane na dotychczasowych kartach są nieaktualne.
schema

string

To pole schematu nie wykonuje żadnej operacji, ale może być obecne w znacznikach w celu sprawdzenia składni.

Sugestie

Sugerowane wartości, które użytkownicy mogą wpisać. Te wartości pojawiają się, gdy użytkownicy klikają w polu tekstowym. Gdy użytkownicy wpisują tekst, sugerowane wartości są dynamicznie filtrowane, aby pasowały do tego, co wpisują.

Na przykład pole tekstowe do wpisywania kodu w języku programowania może sugerować Java, JavaScript, Python i C++. Gdy użytkownicy zaczną pisać Jav, lista sugestii zostanie przefiltrowana, aby wyświetlić Java i JavaScript.

Sugerowane wartości pomagają użytkownikom wpisywać wartości, które Twoja aplikacja może zinterpretować. W przypadku JavaScript niektórzy użytkownicy mogą wpisać javascript, a inni java script. Sugerowanie JavaScript może ujednolicić sposób interakcji użytkowników z Twoją aplikacją.

Gdy jest to określone, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawione na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
items[]

SuggestionItem

Lista sugestii używanych do rekomendacji autouzupełniania w polach tekstowych.

SuggestionItem

Jedna sugerowana wartość, którą użytkownicy mogą wpisać w polu tekstowym.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola

Pole unii content.

content może być tylko jednym z tych elementów:
text

string

Wartość sugerowanego tekstu w polu tekstowym. Jest to równoznaczne z tym, co użytkownicy wpisują samodzielnie.

TextInput

Pole, w którym użytkownicy mogą wpisywać tekst. Obsługuje sugestie i działania po zmianie. Obsługuje weryfikację przesłania formularza. Gdy parametr Action.all_widgets_are_required ma wartość true lub ten widżet jest określony w Action.required_widgets, działanie przesyłania jest blokowane, chyba że zostanie podana wartość. Przykład dodawania pola, w którym użytkownik może wpisać tekst, znajdziesz w aplikacji Google Chat w artykule Dodaj pole, w którym użytkownik może wpisać tekst.

Aplikacje do czatu otrzymują i mogą przetwarzać wartość wpisanego tekstu podczas zdarzeń wprowadzania danych w formularzu. Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.

Jeśli chcesz zbierać nieokreślone lub abstrakcyjne dane od użytkowników, użyj pola tekstowego. Aby zbierać zdefiniowane lub wyszczególnione dane od użytkowników, użyj widżetu SelectionInput.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
name

string

Nazwa, za pomocą której pole tekstowe jest identyfikowane w zdarzeniu wprowadzania danych w formularzu.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
label

string

Tekst wyświetlany nad polem tekstowym w interfejsie.

Podaj tekst, który pomoże użytkownikowi podać informacje wymagane przez aplikację. Jeśli na przykład chcesz zapytać o nazwisko, zamiast name wpisz surname.

Wymagane, jeśli nie określono właściwości hintText. W przeciwnym razie nie jest to wymagane.
hintText

string

Tekst wyświetlany pod polem tekstowym, który ma pomóc użytkownikom w wpisaniu określonej wartości. Ten tekst jest zawsze widoczny.

Wymagane, jeśli nie określono właściwości label. W przeciwnym razie nie jest to wymagane.
value

string

Wartość wpisana przez użytkownika, zwracana w ramach zdarzenia wprowadzenia danych w formularzu.

Szczegółowe informacje o pracy z danymi formularza znajdziesz w artykule Odbieranie danych formularza.
type

Type

Jak pole tekstowe wygląda w interfejsie Na przykład czy pole jest jedno- czy wielowierszowe.
onChangeAction

Action

Co zrobić, gdy nastąpi zmiana w polu tekstowym. Może to być na przykład dodanie tekstu do pola lub jego usunięcie.

Przykłady działań to m.in. wykonanie funkcji niestandardowej lub otwarcie okna w Google Chat.
initialSuggestions

Suggestions

Sugerowane wartości, które użytkownicy mogą wpisać. Te wartości pojawiają się, gdy użytkownicy klikają w polu tekstowym. Gdy użytkownicy wpisują tekst, sugerowane wartości są dynamicznie filtrowane, aby pasowały do tego, co wpisują.

Na przykład pole tekstowe do wprowadzania języka programowania może sugerować Java, JavaScript, Python i C++. Gdy użytkownicy zaczną pisać Jav, lista sugestii zostanie przefiltrowana, aby wyświetlić tylko Java i JavaScript.

Sugerowane wartości pomagają użytkownikom wpisywać wartości, które Twoja aplikacja może zinterpretować. W przypadku JavaScript niektórzy użytkownicy mogą wpisać javascript, a inni java script. Sugerowanie JavaScript może ujednolicić sposób interakcji użytkowników z Twoją aplikacją.

Gdy jest to określone, TextInput.type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawione na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
autoCompleteAction

Action

Opcjonalnie: Określ, jakie działanie ma być wykonywane, gdy pole tekstowe wyświetla sugestie użytkownikom, którzy z niego korzystają.

Jeśli nie są określone, sugestie są ustawiane przez initialSuggestions i przetwarzane przez klienta.

Jeśli jest określony, aplikacja wykonuje tutaj określone działanie, np. wywołuje funkcję niestandardową.

Dostępne w przypadku dodatków Google Workspace i niedostępne w przypadku aplikacji Google Chat.
validation

Validation

Określ format danych wejściowych, który musi być sprawdzony w przypadku tego pola tekstowego.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.
placeholderText

string

Tekst, który pojawia się w polu tekstowym, gdy jest puste. Użyj tego tekstu, aby poprosić użytkowników o wpisanie wartości. Na przykład: Enter a number from 0 to 100.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Typ

Jak pole tekstowe wygląda w interfejsie Na przykład czy jest to pole tekstowe jednowierszowe czy wielowierszowe. Jeśli określono wartość initialSuggestions, parametr type ma zawsze wartość SINGLE_LINE, nawet jeśli jest ustawiony na MULTIPLE_LINE.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Wartości w polu enum
SINGLE_LINE Pole tekstowe ma stałą wysokość równą 1 wierszowi.
MULTIPLE_LINE Pole tekstowe ma stałą wysokość obejmującą kilka wierszy.

TextParagraph

Akapit tekstu, który obsługuje formatowanie. Przykład w przypadku aplikacji Google Chat znajdziesz w artykule Dodawanie akapitu sformatowanego 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.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
text

string

Tekst wyświetlany w widżecie.
maxLines

int32

Maksymalna liczba wierszy tekstu wyświetlanych w widżecie. Jeśli tekst przekracza maksymalną liczbę wierszy, nadmiar treści jest ukryty za przyciskiem pokaż więcej. Jeśli tekst jest krótszy niż określona maksymalna liczba wierszy, przycisk pokaż więcej nie jest wyświetlany.

Wartość domyślna to 0, co oznacza, że wyświetlany jest cały kontekst. Wartości ujemne są ignorowane.

Weryfikacja

Reprezentuje dane potrzebne do zweryfikowania widżetu, do którego jest dołączony.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

Pola
characterLimit

int32

Określ limit znaków dla widżetów wprowadzania tekstu. Pamiętaj, że ta funkcja jest używana 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

InputType

Określ typ widgetów danych wejściowych.

Dostępne w przypadku aplikacji Google Chat i dodatków do Google Workspace.

InputType

Typ widżetu danych wejściowych.

Wartości w polu enum
INPUT_TYPE_UNSPECIFIED Nieokreślony typ. Nie używać.
TEXT Tekst zwykły, który akceptuje wszystkie znaki.
INTEGER Wartość całkowita.
FLOAT Wartość zmiennoprzecinkowa.
EMAIL adres e-mail,
EMOJI_PICKER emotikon wybrany w selektorze emotikonów,

Widżet

Każda karta składa się z widżetów.

Widżet to obiekt złożony, który może reprezentować tekst, obrazy, przyciski i inne typy obiektów.

Pola
horizontalAlignment

HorizontalAlignment

Określa, czy widżety mają być wyrównane do lewej, prawej czy do środka kolumny.
Pole unii data. Widget może zawierać tylko jeden z tych elementów. Aby wyświetlać więcej elementów, możesz użyć kilku pól widgeta. data może być tylko jednym z tych elementów:
textParagraph

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 ciąg JSON tworzy tekst pogrubiony:

"textParagraph": {
  "text": "  <b>bold text</b>"
}
image

Image

Wyświetla obraz.

Na przykład ten kod JSON tworzy obraz z tekstem alternatywnym:

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}
decoratedText

DecoratedText

Wyświetla ozdobiony element tekstowy.

Na przykład ten kod JSON tworzy ozdobiony widżet tekstowy z adresem e-mail:

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}
buttonList

ButtonList

Lista przycisków.

Na przykład ten kod JSON tworzy 2 przyciski. Pierwszy to niebieski przycisk tekstowy, a drugi to przycisk z obrazem, który otwiera link:

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}
textInput

TextInput

Wyświetla pole tekstowe, w którym użytkownicy mogą wpisywać tekst.

Na przykład ten kod JSON tworzy pole tekstowe na adres e-mail:

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

Na przykład poniższy kod JSON tworzy dane wejściowe tekstowe dla języka programowania z zaleceniami statycznymi:

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
selectionInput

SelectionInput

Wyświetla element sterujący, który pozwala użytkownikom wybierać elementy. Elementy sterujące wyborem mogą być polami wyboru, przyciskami opcji, przełącznikami lub menu.

Na przykład ten kod JSON tworzy menu, w którym użytkownicy mogą wybrać rozmiar:

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}
dateTimePicker

DateTimePicker

Wyświetla widżet, który umożliwia użytkownikom wpisanie daty, godziny lub daty i godziny.

Na przykład ten kod JSON tworzy selektor daty i godziny, aby zaplanować spotkanie:

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}
divider

Divider

Wyświetla poziomą linię rozdzielającą widżety.

Na przykład ten fragment kodu JSON tworzy separator:

"divider": {
}
grid

Grid

Wyświetla siatkę z kolekcją elementów.

Siatka obsługuje dowolną liczbę kolumn i elementów. Liczba wierszy jest określana przez górną granicę liczby elementów podzieloną przez liczbę kolumn. Siatka z 10 elementami i 2 kolumnami 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ę 2-kolumnową z jednym 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"
    }
  }
}
columns

Columns

Wyświetla maksymalnie 2 kolumny.

Aby uwzględnić więcej niż 2 kolumny lub użyć wierszy, użyj widżetu Grid.

Na przykład następujący kod JSON tworzy 2 kolumny, z których każda zawiera akapity tekstowe:

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}
carousel

Carousel

Karuzela zawiera kolekcję zagnieżdżonych widżetów. Oto przykład reprezentacji karuzeli w formacie JSON, która zawiera 2 akapity tekstu.

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}
chipList

ChipList

Lista elementów.

Na przykład ten fragment kodu JSON tworzy 2 elementy. Pierwszy to element tekstowy, a drugi to element z ikoną, który otwiera link:

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

Określa, czy widżety mają być wyrównane do lewej, prawej czy do środka kolumny.

Dostępne w przypadku aplikacji Google Chat i niedostępne w przypadku dodatków Google Workspace.

Wartości w polu enum
HORIZONTAL_ALIGNMENT_UNSPECIFIED Nie używaj. Nie określono.
START Wartość domyślna. Dopasowuje widżety do pozycji początkowej kolumny. W przypadku układów od lewej do prawej wyrównanie do lewej. W przypadku układów od prawej do lewej wyrównanie jest ustawiane na prawo.
CENTER Wyrównuje widżety do środka kolumny.
END Dopasowuje widżety do pozycji końcowej kolumny. W przypadku układów od lewej do prawej wyrównanie widżetów jest ustawione na prawo. W przypadku układów od prawej do lewej wyrównuje widżety do lewej.

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 kwadratową maskę do obrazu. Na przykład obraz 4 x 3 staje się 3 x 3.
CIRCLE Stosuje okrągłą maskę do obrazu. Na przykład obraz 4 x 3 staje się kołem o średnicy 3.