Event

Zdarzenie interakcji z aplikacją Google Chat, które reprezentuje i zawiera dane o interakcji użytkownika z aplikacją Google Chat. Aby skonfigurować aplikację Google Chat tak, aby odbierała zdarzenia interakcji, zapoznaj się z artykułem Otrzymywanie i odpowiadanie na interakcje użytkowników.

Oprócz otrzymywania zdarzeń z interakcji użytkowników aplikacje do obsługi czatu mogą otrzymywać zdarzenia dotyczące zmian w pokojach, np. gdy do pokoju dodany zostanie nowy użytkownik. Więcej informacji o zdarzeniach w pokoju znajdziesz w artykule Praca z wydarzeniami z Google Chat.

Zapis JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Pola
type

enum (EventType)

Typ interakcji użytkownika z aplikacją Chat, np. MESSAGE lub ADDED_TO_SPACE.
eventTime

string (Timestamp format)

Znak czasowy wskazujący, kiedy wystąpiło zdarzenie interakcji.
token

string

Tajna wartość, której starsze wersje aplikacji Google Chat mogą używać do sprawdzania, czy żądanie pochodzi od Google. Google generuje token losowo, a jego wartość pozostaje statyczna. Token możesz uzyskać, cofnąć lub wygenerować ponownie na stronie konfiguracji interfejsu API Chata w konsoli Google Cloud.

Nowoczesne aplikacje do obsługi czatu nie używają tego pola. Nie jest ona dostępna w odpowiedziach interfejsu API ani na stronie konfiguracji interfejsu Chat API.
threadKey

string

Klucz zdefiniowany przez aplikację do obsługi czatu dla wątku powiązanego ze zdarzeniem interakcji. Więcej informacji znajdziesz w artykule spaces.messages.thread.threadKey.
message

object (Message)

W przypadku zdarzeń interakcji ADDED_TO_SPACE, CARD_CLICKED i MESSAGE – wiadomość, która wywołała zdarzenie interakcji (jeśli dotyczy).
user

object (User)

Użytkownik, który wszedł w interakcję z aplikacją Google Chat.
space

object (Space)

Pokój, w którym użytkownik wchodził w interakcję z aplikacją Google Chat.
action

object (FormAction)

W przypadku zdarzeń interakcji CARD_CLICKED dane akcji formularza powiązane z kliknięciem przez użytkownika karty lub okna dialogowego. Więcej informacji znajdziesz w artykule Czytanie danych wprowadzanych przez użytkowników na kartach.
configCompleteRedirectUrl

string

W przypadku zdarzeń interakcji MESSAGE – adres URL, do którego użytkownicy muszą zostać przekierowani po zakończeniu procesu autoryzacji lub konfiguracji poza Google Chat. Więcej informacji znajdziesz w artykule Łączenie aplikacji Google Chat z innymi usługami i narzędziami.
isDialogEvent

boolean

W przypadku zdarzeń interakcji CARD_CLICKED i MESSAGE określa, czy użytkownik wchodzi w interakcję z oknem dialogowym lub jest o to gotowy.
dialogEventType

enum (DialogEventType)

Typ otrzymanego zdarzenia interakcji dialogu.
common

object (CommonEventObject)

Reprezentuje informacje o kliencie użytkownika, takie jak lokalizacja, aplikacja hosta i platforma. W przypadku aplikacji do czatu CommonEventObject obejmuje informacje przesłane przez użytkowników w ramach dialogów, np. dane wprowadzone na karcie.
appCommandMetadata

object (AppCommandMetadata)

Wypełnione dla poleceń aplikacji, w tym poleceń po ukośniku i szybkich poleceń.

CommonEventObject

Reprezentuje informacje o kliencie użytkownika, takie jak lokalizacja, aplikacja hosta i platforma. W przypadku aplikacji do czatu CommonEventObject obejmuje dane przesłane przez użytkowników, którzy wchodzą w interakcję z kartami, np. dane wprowadzone w dialogach.

Zapis JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Pola
userLocale

string

Pełna wartość locale.displayName w formacie [kod języka ISO 639]-[kod kraju/regionu ISO 3166], np. „pl-PL”.
hostApp

enum (HostApp)

Wyliczenie hostApp, które wskazuje aplikację, z której wywoływany jest dodatek. Zawsze CHAT w przypadku aplikacji Google Chat.
platform

enum (Platform)

Wyliczenie platformy, które wskazuje platformę, z której pochodzi zdarzenie (WEB, IOS lub ANDROID). Nieobsługiwane przez aplikacje Google Chat.
timeZone

object (TimeZone)

Identyfikator strefy czasowej i przesunięcie względem uniwersalnego czasu koordynowanego (UTC). Obsługiwane tylko w przypadku typów zdarzeń CARD_CLICKED i SUBMIT_DIALOG.
formInputs

map (key: string, value: object (Inputs))

Mapa zawierająca wartości, które użytkownik wpisuje w widżecie na karcie lub w dialogu. Klucze mapy to identyfikatory ciągu znaków przypisane do poszczególnych widżetów, a wartości to dane wejściowe widżetów.

Szczegółowe informacje znajdziesz w artykule Przetwarzanie informacji wprowadzanych przez użytkowników.
parameters

map (key: string, value: string)

niestandardowe parametry przekazane do wywoływanej funkcji; Klucze i wartości muszą być ciągami znaków.
invokedFunction

string

Nazwa wywoływanej funkcji powiązanej z widżetem. Ustawiane tylko w przypadku aplikacji Google Chat.

TimeZone

Identyfikator strefy czasowej i przesunięcie względem uniwersalnego czasu koordynowanego (UTC). Obsługiwane tylko w przypadku typów zdarzeń CARD_CLICKED i SUBMIT_DIALOG.

Zapis JSON 
{
  "id": string,
  "offset": integer
}
Pola
id

string

Kod bazy danych stref czasowych IANA TZ, np. „America/Toronto”.
offset

integer

Odchylenie strefy czasowej użytkownika od uniwersalnego czasu koordynowanego (UTC) w milisekundach.

Dane wejściowe

Typy danych, które użytkownicy mogą wprowadzać na kartach lub w dialogach. Typ danych wejściowych zależy od typu wartości akceptowanych przez widget.

Zapis JSON 
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
Pola

Pole unii inputs.

inputs może być tylko jednym z tych elementów:
stringInputs

object (StringInputs)

Lista ciągów tekstowych, które reprezentują wartości wprowadzane przez użytkownika w widżecie.

Jeśli widżet akceptuje tylko jedną wartość, np. widżet TextInput, lista zawiera jeden obiekt ciągu znaków. Jeśli widżet akceptuje wiele wartości, np. widżet SelectionInput z polami wyboru, lista zawiera obiekt ciągu znaków dla każdej wartości, którą użytkownik wprowadzi lub wybierze.
dateTimeInput

object (DateTimeInput)

wartości danych wejściowych daty i godziny z widżetu DateTimePicker, który akceptuje zarówno datę, jak i godzinę;
dateInput

object (DateInput)

wartości danych daty z widżetu DateTimePicker, który przyjmuje tylko wartości daty;
timeInput

object (TimeInput)

wartości wejściowe czasu z widżetu DateTimePicker, który akceptuje tylko wartości czasu;

StringInputs

Parametr wejściowy dla zwykłych widżetów. W przypadku widżetów o pojedynczej wartości jest to lista o jednej wartości. W przypadku widżetów z wieloma wartościami, np. pola wyboru, wyświetlane są wszystkie wartości.

Zapis JSON 
{
  "value": [
    string
  ]
}
Pola
value[]

string

Lista ciągów znaków wpisanych przez użytkownika.

DateTimeInput

wartości danych wejściowych daty i godziny;

Zapis JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Pola
msSinceEpoch

string (int64 format)

Czas od początku epoki w milisekundach.
hasDate

boolean

Określa, czy dane wejściowe datetime zawierają datę kalendarzową.
hasTime

boolean

Określa, czy dane wejściowe datetime zawierają sygnaturę czasową.

DateInput

Wartości danych wejściowych daty.

Zapis JSON 
{
  "msSinceEpoch": string
}
Pola
msSinceEpoch

string (int64 format)

Czas od początku epoki w milisekundach.

TimeInput

Wartości wejściowe czasu.

Zapis JSON 
{
  "hours": integer,
  "minutes": integer
}
Pola
hours

integer

Godzina na zegarze 24-godzinnym.
minutes

integer

Liczba minut po godzinie. Prawidłowe wartości to od 0 do 59.

AppCommandMetadata

Metadane powiązane z poleceniami aplikacji. Polecenia aplikacji to sposób, w jaki użytkownicy mogą wywoływać aplikację Google Chat i wchodzić z nią w interakcję. Mogą to być polecenia z ukośnikiem wpisywane w polu tworzenia lub elementy wybrane bezpośrednio z menu integracji.

Zapis JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Pola
appCommandId

integer

Identyfikator polecenia dla danej interakcji z aplikacją.
appCommandType

enum (AppCommandType)

Typ polecenia aplikacji.