Event

Zdarzenie interakcji w aplikacji Google Chat.

Informacje o zdarzeniach interakcji znajdziesz w artykule Odbieranie interakcji z aplikacją Google Chat i odpowiadanie na nie. Aby dowiedzieć się więcej o typach zdarzeń, takich jak ładunki zdarzeń w aplikacji Google Chat, przeczytaj artykuł Typy zdarzeń interakcji w aplikacji 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 Typy zdarzeń interakcji w aplikacji Google Chat.

eventTime

string (Timestamp format)

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

token

string

Tajna wartość, której starsze aplikacje do obsługi czatu 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 wygenerować ponownie na stronie konfiguracji interfejsu Chat API w Google Cloud Console.

Nowoczesne aplikacje Google Chat nie używają tego pola. Brakuje go w odpowiedziach interfejsu API i na stronie konfiguracji interfejsu Chat API.

threadKey

string

Zdefiniowany przez aplikację Google Chat klucz dotyczący wątku związanego ze zdarzeniem interakcji. Więcej informacji: spaces.messages.thread.threadKey.

message

object (Message)

Komunikat, który wywoł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 są to dane działania związane z formularzem, które pojawiają się, gdy użytkownik kliknie kartę lub okno. Więcej informacji znajdziesz w artykule Odczytywanie danych przekazywanych przez użytkowników na kartach.

configCompleteRedirectUrl

string

Adres URL, pod 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

Czy w przypadku zdarzeń interakcji z użytkownikiem CARD_CLICKED wchodził w interakcję z oknem.

dialogEventType

enum (DialogEventType)

Typ odebranego zdarzenia interakcji z oknem.

common

object (CommonEventObject)

Reprezentuje informacje o kliencie użytkownika, takie jak język, aplikacja hosta czy platforma. W przypadku aplikacji do obsługi czatu CommonEventObject uwzględnia informacje przesłane przez użytkowników korzystających z dialogów, takie jak dane wpisane na karcie.

CommonEventObject

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

hostApp

enum (HostApp)

Wartość wyliczająca hostApp wskazująca, z której aplikacji jest wywoływany dodatek. Zawsze CHAT w przypadku aplikacji do obsługi czatu.

platform

enum (Platform)

Wyliczenie platformy wskazujące platformę, z której pochodzi zdarzenie (WEB, IOS lub ANDROID). Nieobsługiwane przez aplikacje do obsługi czatu.

timeZone

object (TimeZone)

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

formInputs

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

Mapa z bieżącymi wartościami widżetów na karcie. Klucze map to identyfikatory ciągów znaków przypisane do poszczególnych widżetów, a wartości reprezentują dane wejściowe widżetu. W zależności od typu danych wejściowych, poszczególne obiekty reprezentują różne obiekty: w przypadku widżetów z jedną wartością StringInput. W przypadku widżetów z wieloma wartościami – tablica obiektów StringInput. W przypadku selektora daty i godziny DateTimeInput. W przypadku selektora daty po prostu DateInput. Selektor czasu: TimeInput. Odpowiada danem wpisanym przez użytkownika na karcie w oknie.

parameters

map (key: string, value: string)

Parametry niestandardowe przekazywane do wywoływanej funkcji. Zarówno klucze, jak i wartości muszą być ciągiem znaków.

invokedFunction

string

Nazwa wywołanej funkcji powiązanej z widżetem. Stosowane tylko w aplikacjach Google Chat.

TimeZone

Identyfikator strefy czasowej i przesunięcie względem czasu uniwersalnego (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 od czasu uniwersalnego czasu koordynowanego (UTC).

Dane wejściowe

Rodzaje danych, które użytkownicy mogą wpisywać na kartach lub w oknach. Aby dowiedzieć się, jak przetwarzać informacje od użytkowników, przeczytaj artykuł Odczytywanie danych przekazywanych przez użytkowników w formularzach na kartach.

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)

Parametr wejściowy dla zwykłych widżetów. W przypadku widżetów z 1 wartością jest to lista z 1 wartością. W przypadku widżetów wielowartościowych, takich jak pole wyboru, wszystkie wartości są wyświetlane.

dateTimeInput

object (DateTimeInput)

Wpisz daty i godziny.

dateInput

object (DateInput)

Wpisz daty.

timeInput

object (TimeInput)

Wpisz wartości czasowe.

Ciągi znaków

Parametr wejściowy dla zwykłych widżetów. W przypadku widżetów z 1 wartością jest to lista z 1 wartością. W przypadku widżetów wielowartościowych, takich jak pole wyboru, wszystkie wartości są wyświetlane.

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

string

Tablica ciągów wprowadzonych przez użytkownika.

Data i godzina

Wpisz 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 mają datę kalendarzową.

hasTime

boolean

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

Data wprowadzenia

Wpisz daty.

Zapis JSON
{
  "msSinceEpoch": string
}
Pola
msSinceEpoch

string (int64 format)

Czas od początku epoki, w milisekundach.

Dane wejściowe czasu

Wpisz wartości czasowe.

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.