Event

Zdarzenie interakcji z aplikacją Google Chat.

Więcej informacji o zdarzeniach interakcji znajdziesz w artykule Odbieranie interakcji z aplikacją Google Chat i reagowanie na nie. Więcej informacji o typach zdarzeń i przykładowych ładunkach zdarzeń znajdziesz w artykule Rodzaje zdarzeń interakcji z aplikacją Google Chat.

Oprócz otrzymywania zdarzeń pochodzących z interakcji użytkowników aplikacje Google Chat mogą otrzymywać informacje o zmianach w pokojach, na przykład o dodaniu do pokoju nowego użytkownika. Więcej informacji o wydarzeniach 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)
  }
}
Pola
type

enum (EventType)

Typ zdarzenia interakcji. Więcej informacji znajdziesz w artykule Rodzaje zdarzeń interakcji z aplikacją Google Chat.

eventTime

string (Timestamp format)

Sygnatura czasowa wskazująca, kiedy wystąpiło zdarzenie interakcji.

token

string

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

Współczesne aplikacje do obsługi czatu nie używają tego pola. Nie występuje on 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: spaces.messages.thread.threadKey.

message

object (Message)

Wiadomość, która wywołała zdarzenie interakcji (w stosownych przypadkach).

user

object (User)

Użytkownik, który wywołał zdarzenie interakcji.

space

object (Space)

Pokój, w którym wystąpiło zdarzenie interakcji.

action

object (FormAction)

W przypadku zdarzeń interakcji CARD_CLICKED dane działania z formularza powiązane, gdy użytkownik kliknie kartę lub okno. Więcej informacji znajdziesz w artykule Odczytywanie danych formularzy wprowadzanych przez użytkowników na kartach.

configCompleteRedirectUrl

string

Adres URL, na który aplikacja Google Chat powinna przekierowywać użytkownika 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 – czy użytkownik wszedł w interakcję z oknem dialogowym.

dialogEventType

enum (DialogEventType)

Typ odebranego zdarzenia interakcji okno.

common

object (CommonEventObject)

Przedstawia informacje o kliencie użytkownika, takie jak język, aplikacja hosta i platforma. W przypadku aplikacji do obsługi czatu CommonEventObject zawiera informacje przesłane przez użytkowników, którzy korzystają z okna dialogowego, np. dane wpisane na karcie.

CommonEventObject

Przedstawia informacje o kliencie użytkownika, takie jak język, aplikacja hosta i platforma. W przypadku aplikacji do obsługi czatu CommonEventObject uwzględnia dane przesłane przez użytkowników korzystających z kart, np. dane wpisywane 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łna wartość locale.displayName w formacie [kod języka w formacie ISO 639]–[kod kraju/regionu w formacie ISO 3166], np. „pl-PL”.

hostApp

enum (HostApp)

Lista hostApp, która wskazuje aplikację, z której jest wywoływany dodatek. W przypadku aplikacji do obsługi czatu zawsze CHAT.

platform

enum (Platform)

Lista platform, która wskazuje platformę, z której pochodzi zdarzenie (WEB, IOS lub ANDROID). Nie jest obsługiwana w aplikacjach do obsługi czatu.

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 wpisane przez użytkownika w widżecie z karty lub okna. Klucze mapy to identyfikatory ciągu przypisane do każdego widżetu. Wartości reprezentują dane wejściowe widżetu.

Więcej informacji znajdziesz w artykule Informacje o procesie podawane przez użytkowników.

parameters

map (key: string, value: string)

Niestandardowe parametry przekazywane do wywoływanej funkcji. Zarówno klucze, jak i wartości muszą być ciągami tekstowymi.

invokedFunction

string

Nazwa wywołanej funkcji powiązanej z widżetem. Ustawiona tylko dla 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 strefy czasowej IANA TZ, np. „Ameryka/Toronto”.

offset

integer

Przesunięcie strefy czasowej użytkownika w milisekundach względem uniwersalnego czasu koordynowanego (UTC).

Dane wejściowe

Rodzaje danych, które użytkownicy mogą podawać na kartach lub w oknach dialogowych. 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 być tylko jedną z tych wartości:

stringInputs

object (StringInputs)

Lista ciągów znaków reprezentujących wartości wpisywane przez użytkownika w widżecie.

Jeśli widżet akceptuje tylko jedną wartość, na przykład widżet TextInput, na liście znajduje się 1 obiekt tekstowy. Jeśli widżet akceptuje wiele wartości, na przykład widżet pól wyboru SelectionInput, lista zawiera obiekt tekstowy dla każdej wartości wprowadzonej lub wybranej przez użytkownika.

dateTimeInput

object (DateTimeInput)

Wartości wejściowe daty i godziny 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 daty.

timeInput

object (TimeInput)

Wartości czasowe z widżetu DateTimePicker, który akceptuje tylko wartości czasowe.

StringInputs

Parametr wejściowy dla zwykłych widżetów. W przypadku widżetów jednowartościowych jest to lista wartości. W przypadku widżetów o wielu wartościach, np. pól wyboru, przedstawiane są wszystkie wartości.

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

string

Lista ciągów tekstowych wprowadzonych przez użytkownika.

DateTimeInput

Wartości wejściowe 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 pole datetime zawiera datę kalendarzową.

hasTime

boolean

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

DateInput

Wartości wejściowe 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.