Event

Bir kullanıcının Chat uygulamasıyla etkileşimi hakkında verileri temsil eden ve içeren bir Google Chat uygulaması etkileşim etkinliği. Chat uygulamanızı etkileşim etkinlikleri alacak şekilde yapılandırmak için Kullanıcı etkileşimlerini alma ve yanıtlama başlıklı makaleyi inceleyin.

Chat uygulamaları, kullanıcı etkileşimlerinden gelen etkinliklere ek olarak, alanlarda yapılan değişikliklerle ilgili etkinlikler de alabilir (ör. bir alana yeni üye eklendiğinde). Alan etkinlikleri hakkında bilgi edinmek için Google Chat'teki etkinliklerle çalışma başlıklı makaleyi inceleyin.

JSON gösterimi
{
  "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)
  }
}
Alanlar
type

enum (EventType)

Kullanıcının Chat uygulamasıyla etkileşiminin türü (ör. MESSAGE veya ADDED_TO_SPACE).

eventTime

string (Timestamp format)

Etkileşim etkinliğinin ne zaman gerçekleştiğini gösteren zaman damgası.

token

string

Eski Chat uygulamalarının, bir isteğin Google'dan gelip gelmediğini doğrulamak için kullanabileceği gizli bir değer. Google, jetonu rastgele oluşturur ve jetonun değeri sabit kalır. Jetonu Google Cloud Console'daki Chat API yapılandırma sayfasından alabilir, iptal edebilir veya yeniden oluşturabilirsiniz.

Modern Chat uygulamaları bu alanı kullanmaz. API yanıtlarında ve Chat API yapılandırma sayfasında bulunmaz.

threadKey

string

Etkileşim etkinliğiyle ilgili ileti dizisi için Chat uygulaması tarafından tanımlanan anahtar. Daha fazla bilgi için spaces.messages.thread.threadKey sayfasına bakın.

message

object (Message)

ADDED_TO_SPACE, CARD_CLICKED ve MESSAGE etkileşim etkinlikleri için, varsa etkileşim etkinliğini tetikleyen mesaj.

user

object (User)

Chat uygulamasıyla etkileşimde bulunan kullanıcı.

space

object (Space)

Kullanıcının Chat uygulamasıyla etkileşimde bulunduğu alan.

action

object (FormAction)

CARD_CLICKED etkileşim etkinlikleri için, kullanıcı bir kartı veya iletişim kutusunu tıkladığında ilişkilendirilen form işlemi verileri. Daha fazla bilgi edinmek için Kartlarda kullanıcılar tarafından girilen form verilerini okuma başlıklı makaleyi inceleyin.

configCompleteRedirectUrl

string

MESSAGE etkileşim etkinlikleri için, kullanıcıların Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra yönlendirilmeleri gereken URL. Daha fazla bilgi için Chat uygulamasını diğer hizmet ve araçlara bağlama başlıklı makaleyi inceleyin.

isDialogEvent

boolean

CARD_CLICKED ve MESSAGE etkileşim etkinlikleri için kullanıcının bir iletişim kutusuyla etkileşimde bulunup bulunmadığını veya etkileşimde bulunmak üzere olup olmadığını belirtir.

dialogEventType

enum (DialogEventType)

Alınan iletişim kutusu etkileşim etkinliğinin türü.

common

object (CommonEventObject)

Kullanıcının istemcisiyle ilgili yerel ayar, barındıran uygulama ve platform gibi bilgileri temsil eder. Chat uygulamaları için CommonEventObject, bir karta girilen veriler gibi iletişim kutularıyla etkileşime geçen kullanıcılar tarafından gönderilen bilgileri içerir.

appCommandMetadata

object (AppCommandMetadata)

Eğik çizgi komutları ve hızlı komutlar dahil olmak üzere uygulama komutları için doldurulur.

CommonEventObject

Kullanıcının istemcisiyle ilgili yerel ayar, barındıran uygulama ve platform gibi bilgileri temsil eder. Chat uygulamaları için CommonEventObject, kartlarla etkileşime geçen kullanıcılar tarafından gönderilen verileri (ör. ileti dizilerine girilen veriler) içerir.

JSON gösterimi
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Alanlar
userLocale

string

[ISO 639 dil kodu]-[ISO 3166 ülke/bölge kodu] biçiminde tam locale.displayName (ör. "en-US").

hostApp

enum (HostApp)

Eklentinin çağrıldığı uygulamayı belirten hostApp enum değeri. Chat uygulamaları için her zaman CHAT.

platform

enum (Platform)

Etkinliğin kaynağı olan platformu belirten platform enum değeri (WEB, IOS veya ANDROID). Chat uygulamaları tarafından desteklenmez.

timeZone

object (TimeZone)

Saat dilimi kimliği ve Eşgüdümlü Evrensel Zaman (UTC) ile saat farkı. Yalnızca CARD_CLICKED ve SUBMIT_DIALOG etkinlik türleri için desteklenir.

formInputs

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

Kullanıcının bir karttan veya iletişim kutusundan widget'a girdiği değerleri içeren bir harita. Harita anahtarları, her widget'a atanan dize kimlikleridir ve değerler, widget'a yapılan girişleri temsil eder.

Ayrıntılı bilgi için Kullanıcılar tarafından girilen bilgileri işleme başlıklı makaleyi inceleyin.

parameters

map (key: string, value: string)

Çağrılan işleve iletilen özel parametreler. Hem anahtarlar hem de değerler dize olmalıdır.

invokedFunction

string

Widget'la ilişkili çağrılan işlevin adı. Yalnızca Chat uygulamaları için ayarlanır.

TimeZone

Saat dilimi kimliği ve Eşgüdümlü Evrensel Zaman (UTC) ile saat farkı. Yalnızca CARD_CLICKED ve SUBMIT_DIALOG etkinlik türleri için desteklenir.

JSON gösterimi
{
  "id": string,
  "offset": integer
}
Alanlar
id

string

IANA TZ saat dilimi veritabanı kodu ("America/Toronto" gibi).

offset

integer

Eşgüdümlü Evrensel Zaman'a (UTC) göre milisaniye cinsinden kullanıcı saat dilimi ofseti.

Girişler

Kullanıcıların kartlara veya iletişim kutularına girebileceği veri türleri. Giriş türü, widget'ın kabul ettiği değer türüne bağlıdır.

JSON gösterimi
{

  // 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.
}
Alanlar

Birlik alanı inputs.

inputs yalnızca aşağıdakilerden biri olabilir:

stringInputs

object (StringInputs)

Kullanıcının bir widget'a girdiği değerleri temsil eden dizelerin listesi.

Widget yalnızca tek bir değer kabul ediyorsa (ör. TextInput widget'ı) liste bir dize nesnesi içerir. Widget birden fazla değer kabul ediyorsa (ör. onay kutularından oluşan bir SelectionInput widget'ı) liste, kullanıcının girdiği veya seçtiği her değer için bir dize nesnesi içerir.

dateTimeInput

object (DateTimeInput)

Hem tarih hem de saat kabul eden bir DateTimePicker widget'ından tarih ve saat giriş değerleri.

dateInput

object (DateInput)

Yalnızca tarih değerlerini kabul eden bir DateTimePicker widget'ından tarih giriş değerleri.

timeInput

object (TimeInput)

Yalnızca saat değerlerini kabul eden bir DateTimePicker widget'ından alınan saat girişi değerleri.

StringInputs

Normal widget'lar için giriş parametresi. Tek değerli widget'lar için tek değerli bir listetir. Onay kutusu gibi çok değerli widget'lar için tüm değerler sunulur.

JSON gösterimi
{
  "value": [
    string
  ]
}
Alanlar
value[]

string

Kullanıcı tarafından girilen dizelerin listesi.

DateTimeInput

Tarih ve saat giriş değerleri.

JSON gösterimi
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Alanlar
msSinceEpoch

string (int64 format)

Dönemden bu yana geçen süre (milisaniye).

hasDate

boolean

datetime girişinin takvim tarihi içerip içermediği.

hasTime

boolean

datetime girişinin zaman damgası içerip içermediği.

DateInput

Tarih giriş değerleri.

JSON gösterimi
{
  "msSinceEpoch": string
}
Alanlar
msSinceEpoch

string (int64 format)

Dönemden bu yana geçen süre (milisaniye).

TimeInput

Zaman giriş değerleri.

JSON gösterimi
{
  "hours": integer,
  "minutes": integer
}
Alanlar
hours

integer

24 saatlik saatteki saat.

minutes

integer

Saatin geçtiği dakika sayısı. Geçerli değerler 0-59 arasındadır.

AppCommandMetadata

Uygulama komutlarıyla ilişkili meta veriler. Uygulama komutları, kullanıcıların bir Chat uygulamasını çağırıp uygulamayla etkileşime geçmesinin bir yoludur. Bunlar, oluşturma kutusuna yazılan eğik çizgi komutları veya doğrudan entegrasyon menüsünden seçilen öğeler olabilir.

JSON gösterimi
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Alanlar
appCommandId

integer

Belirtilen uygulama etkileşiminin komut kimliği.

appCommandType

enum (AppCommandType)

Uygulama komutunun türü.