Event

Bir kullanıcının Chat uygulamasıyla etkileşimini temsil eden ve bu etkileşimle ilgili verileri içeren bir Google Chat uygulaması etkileşim etkinliği. Chat uygulamanızı etkileşim etkinliklerini 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 etkinliklerin yanı sıra alanlardaki değişikliklerle ilgili etkinlikleri de (ör. bir alana yeni üye eklendiğinde) alabilir. Alan etkinlikleri hakkında bilgi edinmek için Google Chat'teki etkinliklerle çalışma başlıklı makaleyi inceleyin.

Not: Bu etkinlik yalnızca sohbet etkileşimi etkinlikleri için kullanılır. Chat uygulamanız Google Workspace eklentisi olarak oluşturulmuşsa eklenti belgelerindeki Chat etkinlik nesneleri bölümüne bakın.

JSON gösterimi 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "thread": {
    object (Thread)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
Alanlar
type

enum (EventType)

Chat uygulamasıyla kurulan kullanıcı etkileşiminin türü (ör. MESSAGE veya ADDED_TO_SPACE).
eventTime

string (Timestamp format)

Etkileşim etkinliğinin gerçekleştiği zamanı 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 değeri statik kalır. Google Cloud Console'daki Chat API yapılandırma sayfasından jetonu 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 iş parçacığı 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ı.
thread

object (Thread)

Kullanıcının Chat uygulamasıyla etkileşimde bulunduğu ileti dizisi. Bu, yeni gönderilen bir mesajla oluşturulan yeni bir ileti dizisi olabilir. Bu alan, etkileşim etkinliği belirli bir ileti veya ileti dizisiyle ilişkilendirilmişse doldurulur.
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

Bu URL, MESSAGE, ADDED_TO_SPACE ve APP_COMMAND etkileşim etkinlikleri için doldurulur. Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra, yetkilendirme ya da yapılandırma akışının başarılı olduğunu Google Chat'e bildirmek için kullanıcıların bu URL'ye yönlendirilmesi gerekir. Daha fazla bilgi için Bir Chat uygulamasını diğer hizmetlere 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ığı veya etkileşimde bulunmak üzere olup olmadığı.
dialogEventType

enum (DialogEventType)

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

object (CommonEventObject)

Kullanıcının istemcisiyle ilgili bilgileri (ör. yerel ayar, ana makine uygulaması ve platform) temsil eder. Chat uygulamaları için CommonEventObject, iletişim kutularıyla etkileşimde bulunan kullanıcılar tarafından gönderilen bilgileri (ör. karta girilen veriler) içerir.
appCommandMetadata

object (AppCommandMetadata)

Chat uygulama komutuyla ilgili meta veriler.

CommonEventObject

Ortak etkinlik nesnesi, genel etkinlik nesnesinin bir bölümüdür ve kullanıcının istemcisinden eklentiye genel, ana makineden bağımsız bilgiler taşır. Bu bilgiler arasında kullanıcının yerel ayarı, ana makine uygulaması ve platformu gibi ayrıntılar yer alır.

Ana sayfa ve bağlamsal tetikleyicilere ek olarak, kullanıcı widget'larla etkileşimde bulunduğunda eklentiler etkinlik nesneleri oluşturup işlem geri çağırma işlevlerine iletir. Eklentinizin geri çağırma işlevi, kullanıcının istemcisinde açık olan widget'ların içeriğini belirlemek için ortak etkinlik nesnesini sorgulayabilir. Örneğin, eklentiniz kullanıcının eventObject.commentEventObject.formInputs nesnesindeki bir TextInput widget'ına girdiği metni bulabilir.

Chat uygulamalarında, kullanıcının bir widget ile etkileşimde bulunurken çağırdığı işlevin adı.

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

Varsayılan olarak devre dışıdır. Kullanıcının dili ve ülke/bölge tanımlayıcısı, ISO 639 dil kodu-ISO 3166 ülke/bölge kodu biçiminde. Örneğin, en-US.

Bu alanı etkinleştirmek için eklentinizin manifest dosyasında addOns.common.useLocaleFromApp değerini true olarak ayarlamanız gerekir. Eklentinizin kapsam listesi https://www.googleapis.com/auth/script.locale öğesini de içermelidir. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.
hostApp

enum (HostApp)

Etkinlik nesnesi oluşturulduğunda eklentinin etkin olduğu ana uygulamayı gösterir. Olası değerler şunlardır:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

Etkinliğin kaynağını gösteren platform numaralandırması (WEB, IOS veya ANDROID). Chat uygulamaları tarafından desteklenmez.
timeZone

object (TimeZone)

Varsayılan olarak devre dışıdır. Saat dilimi kimliği ve Eşgüdümlü Evrensel Saat (UTC) ile saat farkı. Bu alanı etkinleştirmek için eklentinizin manifest dosyasında addOns.common.useLocaleFromApp değerini true olarak ayarlamanız gerekir. Eklentinizin kapsam listesi https://www.googleapis.com/auth/script.locale öğesini de içermelidir. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

Yalnızca CARD_CLICKED ve SUBMIT_DIALOG etkinlik türleri için desteklenir.
formInputs

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

Gösterilen karttaki widget'ların mevcut değerlerini içeren bir harita. Harita anahtarları, her widget'a atanan dize kimlikleridir.

Harita değeri nesnesinin yapısı, widget türüne bağlıdır:

Not: Aşağıdaki örnekler, Apps Komut Dosyası'nın V8 çalışma zamanı için biçimlendirilmiştir. Rhino çalışma zamanını kullanıyorsanız değerin sonuna [""] eklemeniz gerekir. Örneğin, e.commonEventObject.formInputs.employeeName.stringInputs.value[0] yerine etkinlik nesnesini e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] olarak biçimlendirin. Apps Komut Dosyası'ndaki çalışma zamanları hakkında daha fazla bilgi edinmek için V8 Çalışma Zamanına Genel Bakış başlıklı makaleyi inceleyin.

  • Tek değerli widget'lar (ör. metin kutusu): dizeler listesi (yalnızca bir öğe).

Örnek: Kimliği employeeName olan bir metin girişi widget'ı için metin girişi değerine e.commonEventObject.formInputs.employeeName.stringInputs.value[0] ile erişin.

  • Çok değerli widget'lar (ör. onay kutusu grupları): bir dize listesi.

Örnek: Kimliği participants olan çok değerli bir widget için değer dizisine e.commonEventObject.formInputs.participants.stringInputs.value ile erişin.

Örnek: Kimliği myDTPicker olan bir seçici için DateTimeInput nesnesine e.commonEventObject.formInputs.myDTPicker.dateTimeInput kullanarak erişin.

Örnek: Kimliği myDatePicker olan bir seçici için DateInput nesnesine e.commonEventObject.formInputs.myDatePicker.dateInput kullanarak erişin.

Örnek: Kimliği myTimePicker olan bir seçici için TimeInput nesnesine e.commonEventObject.formInputs.myTimePicker.timeInput kullanarak erişin.
parameters

map (key: string, value: string)

actionParameters veya Action.setParameters() kullanarak bir işleme sağladığınız ek parametreler.

Geliştirici Önizlemesi: Google Chat'i genişleten eklentilerde, kullanıcıların çoklu seçim menülerine yazdıklarına göre öğe önermek için "autocomplete_widget_query" anahtarının değerini (event.commonEventObject.parameters["autocomplete_widget_query"]) kullanın. Bu değeri, bir veritabanına sorgu göndermek ve kullanıcılar yazarken seçilebilir öğeler önermek için kullanabilirsiniz. Ayrıntılı bilgi için Google Chat kullanıcılarından bilgi toplama ve bu bilgileri işleme başlıklı makaleyi inceleyin.
invokedFunction

string

Çağrılacak işlevin adı.

Bu alan, Google Chat'i genişleten Google Workspace eklentileri için doldurulmaz. Bunun yerine, tanımlayıcılar gibi işlev verilerini almak için Chat'i genişleten eklentiler parameters alanını kullanmalıdır. Chat uygulamaları için etkileşimli arayüzler oluşturma başlıklı makaleyi inceleyin.

TimeZone

Saat dilimi kimliği ve Eşgüdümlü Evrensel Saat (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

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

integer

Kullanıcının saat dilimi farkı (milisaniye cinsinden, Eşgüdümlü Evrensel Zaman'a (UTC) göre).

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ğerlerin 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

Birleştirme 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 bir değer kabul ediyorsa (ör. TextInput widget'ı) listede bir dize nesnesi bulunur. Widget birden fazla değer kabul ediyorsa (ör. onay kutularından oluşan bir SelectionInput widget'ı) listede, kullanıcının girdiği veya seçtiği her değer için bir dize nesnesi bulunur.
dateTimeInput

object (DateTimeInput)

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

object (DateInput)

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

object (TimeInput)

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

StringInputs

Normal widget'lar için giriş parametresi. Tek değerli widget'lar için tek değerli bir listedir. Onay kutusu gibi çok değerli widget'larda tüm değerler gösterilir.

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çmesinin üzerinden geçen dakika sayısı. Geçerli değerler 0-59 arasıdır.

AppCommandMetadata

Chat uygulaması komutu ile ilgili meta veriler.

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

integer

Chat API yapılandırmasında belirtilen komutun kimliği.
appCommandType

enum (AppCommandType)

Chat uygulaması komutunun türü.