Event

Zdarzenie interakcji z aplikacją Google Chat, które reprezentuje i zawiera dane o interakcji użytkownika z aplikacją Google Chat. Informacje o tym, jak skonfigurować aplikację Google Chat do odbierania zdarzeń interakcji, znajdziesz w artykule Odbieranie interakcji z użytkownikami i reagowanie na nie.

Aplikacje do obsługi czatu nie tylko odbierają zdarzenia z interakcji użytkowników, ale mogą też otrzymywać informacje o zmianach w pokojach, na przykład o dodaniu do pokoju nowego użytkownika. Więcej informacji o wydarzeniach dotyczących pokoju znajdziesz w artykule Praca z wydarzeniami 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)

Sygnatura czasowa określająca, kiedy wystąpiło zdarzenie interakcji.
token

string

Wartość obiektu tajnego, której starsze aplikacje do obsługi czatu mogą używać do weryfikacji, czy prośba pochodzi od Google. Google generuje token losowo, a jego wartość pozostaje statyczna. Token możesz uzyskać, unieważnić lub ponownie wygenerować na stronie konfiguracji interfejsu Chat API w Google Cloud Console.

Współczesne aplikacje Google Chat nie używają tego pola. Nie ma go 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: 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 korzystał z aplikacji Google Chat.
action

object (FormAction)

W przypadku zdarzeń interakcji CARD_CLICKED są to dane dotyczące działań w formularzu powiązane, gdy użytkownik kliknie kartę lub okno. Więcej informacji znajdziesz w artykule Odczytywanie danych formularzy wprowadzonych 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 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 lub ma z nim wejść w interakcję.
dialogEventType

enum (DialogEventType)

Typ odebranego zdarzenia interakcji w oknie.
common

object (CommonEventObject)

Zawiera informacje o kliencie użytkownika, np. język, aplikację hostującą i platformę. 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 komunikatorów.
platform

enum (Platform)

Wyliczenie platformy wskazujące platformę, na której zainicjowano zdarzenie (WEB, IOS lub ANDROID). Nie są obsługiwane przez aplikacje do obsługi czatu.
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 z karty lub okna. Klucze mapy to identyfikatory w postaci ciągu przypisane do poszczególnych widżetów, a wartości reprezentują dane wejściowe widżetu.

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. Ustawienie tylko dla komunikatorów.

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.

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

string

Kod bazy danych strefy czasowej IANA TZ, na przykład „America/Toronto”.
offset

integer

Przesunięcie strefy czasowej użytkownika (w milisekundach) według uniwersalnego czasu koordynowanego (UTC).

Dane wejściowe

Rodzaje danych, które użytkownicy mogą wprowadzać na kartach lub w oknach. 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 sumy inputs.

inputs może mieć tylko jedną z tych wartości:
stringInputs

object (StringInputs)

Lista ciągów znaków reprezentujących wartości, które użytkownik wpisuje 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 wejściowe daty z widżetu DateTimePicker, który akceptuje tylko wartości związane z datą.
timeInput

object (TimeInput)

Dane wejściowe czasu z widżetu DateTimePicker, który akceptuje tylko wartości oznaczające czas.

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 wielowartościowych, np. pól wyboru, przedstawione są wszystkie wartości.

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

string

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

DateTimeInput

Data i godzina.

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 pole datetime zawiera datę kalendarzową.
hasTime

boolean

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

DateInput

Wpisz wartości 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.