Event

Bir kullanıcının Chat uygulamasıyla etkileşimi hakkındaki verileri temsil eden ve 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 etkinlik almanın yanı sıra alanlardaki değişikliklerle ilgili etkinlikleri 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.

Uyarı: Bu olay nesnesi yalnızca eklenti olmayan Chat uygulamaları için kullanılır. Chat uygulamanız Google Workspace eklentisi olarak oluşturulduysa eklenti dokümanlarındaki Eklenti etkinlik nesneleri bölümüne bakın. Uygulamanızın hangi etkinlik türünü aldığını doğrulamak için Etkinlik türünüzü belirleme 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)

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 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 gösterilmez.
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ını inceleyin.
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 mesaj dizisi. Bu, yeni gönderilen bir mesaj tarafından oluşturulan yeni bir mesaj dizisi olabilir. Etkileşim etkinliği belirli bir mesaj veya ileti dizisiyle ilişkiliyse bu alan 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 için Kullanıcılar tarafından kartlara 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ışındaki bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra kullanıcılar, yetkilendirme veya yapılandırma akışının başarılı olduğunu Google Chat'e bildirmek için bu URL'ye yönlendirilmelidir. Daha fazla bilgi için 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 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 uygulama ve platform) temsil eder. Chat uygulamaları için CommonEventObject, kullanıcıların iletişim kutularıyla etkileşim kurarak gönderdiği bilgileri (ör. bir karta girilen veriler) içerir.
appCommandMetadata

object (AppCommandMetadata)

Chat uygulaması komutuyla ilgili meta veriler.

CommonEventObject

Ortak olay nesnesi, genel olay nesnesinin, kullanıcı istemcisinden eklentiye genel, ana makineden bağımsız bilgiler taşıyan kısmıdı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 eklentiler, kullanıcı widget'larla etkileşimde bulunduğunda olay nesneleri oluşturur ve bunları işlem geri çağırma işlevlerine iletir. Eklentinizin geri çağırma işlevi, kullanıcının istemcisindeki açık widget'ların içeriğini belirlemek için ortak olay nesnesini sorgulayabilir. Örneğin, eklentiniz bir kullanıcının eventObject.commentEventObject.formInputs nesnesindeki TextInput widget'ına girdiği metni bulabilir.

Chat uygulamaları için, 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çimindedir. Ö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 kapsamını da 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)

Olay nesnesi oluşturulduğunda eklentinin etkin olduğu ana uygulamayı belirtir. Olası değerler şunlardır:

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

enum (Platform)

Etkinliğin kaynaklandığı platformu (WEB, IOS veya ANDROID) belirten platform enum'u. 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 Zaman (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 kapsamını da 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örüntülenen karttaki widget'ların mevcut değerlerini içeren bir harita. Harita anahtarları, her giriş widget'ına (ör. TextInput.name, SelectionInput.name, DateTimePicker.name veya DecoratedText.SwitchControl.name) atanan dize name değerleridir.

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ğerden sonra [""] eklemeniz gerekir. Örneğin, etkinlik nesnesini e.commonEventObject.formInputs.employeeName.stringInputs.value[0] yerine 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 (örneğin, TextInput widget'ı veya DROPDOWN ya da RADIO_BUTTON türünde bir SelectionInput widget'ı): Tek öğeli bir liste (veya seçim yapılmazsa boş bir liste) içeren bir StringInputs nesnesi.

Örnek: name değeri 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. CHECK_BOX, SWITCH veya MULTI_SELECT türünde bir SelectionInput widget'ı): Seçilen öğe value dizelerinin listesini içeren bir StringInputs nesnesi.

Örnek: name değeri participants olan çoklu değer widget'ı için değer dizisine e.commonEventObject.formInputs.participants.stringInputs.value ile erişin.

  • DecoratedText.SwitchControl widget'ı: StringInputs nesnesi. selected, true olduğunda stringInputs.value, anahtarın value alanını (veya value belirtilmemişse "" değerini) içerir. Birden fazla anahtar aynı name değerini paylaşıyorsa seçilen her anahtarın value değeri listeye dahil edilir. selected, false olduğunda anahtarın value değeri stringInputs.value değerinden çıkarılır.

  • Tarih-saat seçici (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

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

Örnek: name değeri myTimePicker olan bir seçici için e.commonEventObject.formInputs.myTimePicker.timeInput kullanarak TimeInput nesnesine 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 (event.commonEventObject.parameters["autocomplete_widget_query"]) değerini kullanın. Bu değeri, bir veritabanını sorgulamak 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 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 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 (ör. "America/Toronto").
offset

integer

Kullanıcının saat diliminin Eşgüdümlü Evrensel Zaman'dan (UTC) milisaniye cinsinden farkı.

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 
{

  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
}
Alanlar
Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
stringInputs

object (StringInputs)

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

Widget yalnızca bir değer kabul ediyorsa (ör. TextInput widget'ı) listede bir dize nesnesi bulunur. Widget, onay kutularından oluşan bir SelectionInput widget'ı gibi birden fazla değer kabul ediyorsa 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 saat giriş değerleri.
Birbirini hariç tutan alanların sonu.

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'lar için tüm değerler gösterilir.

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

string

Kullanıcı tarafından girilen dize listesi.

DateTimeInput

Tarih ve saat giriş değerleri.

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

string (int64 format)

Epoch zamanından bu yana geçen süre (milisaniye cinsinden).
hasDate

boolean

datetime girişinin bir 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)

Epoch zamanından bu yana geçen süre (milisaniye cinsinden).

TimeInput

Zaman girişi değerleri.

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

integer

24 saatlik biçimde saat.
minutes

integer

Saat başından sonra geçen dakika sayısı. Geçerli değerler 0 ile 59 arasındadı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ü.