Event

Zdarzenie interakcji z aplikacją Google Chat, które reprezentuje interakcję użytkownika z aplikacją do obsługi czatu i zawiera dane na jej temat. Jeśli chcesz skonfigurować aplikację Google Chat do odbierania zdarzeń interakcji, przeczytaj artykuł Odbieranie interakcji z użytkownikiem i reagowanie na nie.

Oprócz otrzymywania zdarzeń z interakcji użytkowników aplikacje do obsługi czatu mogą też otrzymywać zdarzenia dotyczące zmian w pokojach, na przykład informacje o dodaniu do pokoju nowego użytkownika. Więcej informacji o zdarzeniach w pokoju znajdziesz w artykule Praca ze zdarzeniami w 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)
  }
}
Pola
type

enum (EventType)

Typ interakcji użytkownika z aplikacją Google Chat, na przykład 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 Chat mogą używać do sprawdzania, czy żądanie pochodzi od Google. Google losowo generuje token, a jego wartość pozostaje statyczna. Token możesz uzyskać, unieważnić lub ponownie wygenerować na stronie konfiguracji interfejsu Chat API w Google Cloud Console.

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ę w Google Chat dla wątku zwią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 jest to wiadomość, która wywołała zdarzenie interakcji (w odpowiednich przypadkach).
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 z funkcją MESSAGE jest to adres URL, na który użytkownicy muszą zostać przekierowani po zakończeniu procesu autoryzacji lub konfiguracji poza Google Chat. Więcej informacji znajdziesz w artykule Łączenie aplikacji Czat 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 odebranego zdarzenia interakcji w oknie.
common

object (CommonEventObject)

Reprezentuje informacje o kliencie użytkownika, takie jak lokalizacja, aplikacja hosta i platforma. W przypadku aplikacji do obsługi czatu CommonEventObject zawiera informacje przesłane przez użytkowników, którzy wchodzą w interakcje z oknami dialogowymi, np. dane wpisane na karcie.

CommonEventObject

Zawiera informacje o kliencie użytkownika, np. język, aplikację hostującą i platformę. W przypadku aplikacji do obsługi czatu CommonEventObject obejmuje dane przesłane przez użytkowników, którzy korzystają z kart, np. dane wpisane w oknach dialogowych.

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łny kod locale.displayName w formacie [kod języka ISO 639]-[kod kraju/regionu w formacie ISO 3166], na przykład „pl-PL”.
hostApp

enum (HostApp)

Wyliczenie hostApp wskazujące aplikację, z której jest wywoływany 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 odsunię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 sekcji Informacje o procesach wprowadzane przez użytkowników.
parameters

map (key: string, value: string)

Parametry niestandardowe przekazywane do wywołanej funkcji. Klucze i wartości muszą być ciągami znaków.
invokedFunction

string

Nazwa wywołanej 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 widżet.

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 będzie zawierać 1 obiekt z ciągiem znaków. Jeśli widżet akceptuje wiele wartości, np. widżet SelectionInput z polami wyboru, lista zawiera obiekt w postaci ciągu znaków dla każdej wartości wpisywanej lub wybranej przez użytkownika.
dateTimeInput

object (DateTimeInput)

Data i godzina pochodzą 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 do wprowadzania zwykłych widżetów. W przypadku widżetów jednowartościowych jest to jedna lista 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

Dane wejściowe czasu.

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

integer

Godzina na zegarze 24-godzinnym.
minutes

integer

Liczba minut w ciągu ostatniej godziny. Prawidłowe wartości to od 0 do 59.