Event

Google Chat ऐप्लिकेशन के साथ इंटरैक्शन करने से जुड़ा इवेंट. इसमें Chat ऐप्लिकेशन के साथ उपयोगकर्ता के इंटरैक्शन का डेटा होता है. इंटरैक्शन इवेंट पाने के लिए, Chat ऐप्लिकेशन को कॉन्फ़िगर करने का तरीका जानने के लिए, उपयोगकर्ता के इंटरैक्शन पाना और उनका जवाब देना लेख पढ़ें.

Chat ऐप्लिकेशन को, उपयोगकर्ता के इंटरैक्शन से जुड़े इवेंट के साथ-साथ स्पेस में हुए बदलावों से जुड़े इवेंट भी मिल सकते हैं. जैसे, किसी स्पेस में नया सदस्य जोड़े जाने पर. स्पेस के इवेंट के बारे में जानने के लिए, Google Chat के इवेंट इस्तेमाल करना लेख पढ़ें.

ध्यान दें: इस इवेंट का इस्तेमाल सिर्फ़ चैट इंटरैक्शन इवेंट के लिए किया जाता है. अगर आपका Chat ऐप्लिकेशन, Google Workspace ऐड-ऑन के तौर पर बनाया गया है, तो ऐड-ऑन के दस्तावेज़ में Chat इवेंट ऑब्जेक्ट देखें.

JSON के काेड में दिखाना 
{
  "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)
  }
}
फ़ील्ड
type

enum (EventType)

Chat ऐप्लिकेशन के साथ उपयोगकर्ता के इंटरैक्शन का टाइप, जैसे कि MESSAGE या ADDED_TO_SPACE.
eventTime

string (Timestamp format)

यह टाइमस्टैंप बताता है कि इंटरैक्शन इवेंट कब हुआ.
token

string

यह एक सीक्रेट वैल्यू है. इसका इस्तेमाल लेगसी Chat ऐप्लिकेशन यह पुष्टि करने के लिए कर सकते हैं कि अनुरोध Google से मिला है या नहीं. Google, टोकन को रैंडम तरीके से जनरेट करता है. इसकी वैल्यू स्टैटिक रहती है. Google Cloud Console में, Chat API के कॉन्फ़िगरेशन पेज से टोकन हासिल किया जा सकता है, उसे रद्द किया जा सकता है या फिर से जनरेट किया जा सकता है.

मॉडर्न Chat ऐप्लिकेशन, इस फ़ील्ड का इस्तेमाल नहीं करते. यह एपीआई रिस्पॉन्स और Chat API कॉन्फ़िगरेशन पेज पर मौजूद नहीं है.
threadKey

string

यह Chat ऐप्लिकेशन में तय की गई थ्रेड की मुख्य वैल्यू होती है. यह इंटरैक्शन इवेंट से जुड़ी होती है. ज़्यादा जानकारी के लिए, spaces.messages.thread.threadKey पर जाएं.
message

object (Message)

ADDED_TO_SPACE, CARD_CLICKED, और MESSAGE इंटरैक्शन इवेंट के लिए, वह मैसेज जिसने इंटरैक्शन इवेंट को ट्रिगर किया है. हालांकि, यह जानकारी सिर्फ़ तब उपलब्ध होती है, जब लागू हो.
user

object (User)

Chat ऐप्लिकेशन का इस्तेमाल करने वाला उपयोगकर्ता.
thread

object (Thread)

वह थ्रेड जिसमें उपयोगकर्ता ने Chat ऐप्लिकेशन के साथ इंटरैक्ट किया. यह किसी नए मैसेज से बनाई गई नई थ्रेड में हो सकता है. अगर इंटरैक्शन इवेंट, किसी मैसेज या थ्रेड से जुड़ा है, तो इस फ़ील्ड में जानकारी अपने-आप भर जाती है.
space

object (Space)

वह स्पेस जिसमें उपयोगकर्ता ने Chat ऐप्लिकेशन के साथ इंटरैक्ट किया.
action

object (FormAction)

CARD_CLICKED इंटरैक्शन इवेंट के लिए, फ़ॉर्म ऐक्शन से जुड़ा डेटा. यह डेटा तब इकट्ठा होता है, जब कोई उपयोगकर्ता किसी कार्ड या डायलॉग पर क्लिक करता है. ज़्यादा जानने के लिए, कार्ड पर उपयोगकर्ताओं के डाले गए फ़ॉर्म डेटा को पढ़ना लेख पढ़ें.
configCompleteRedirectUrl

string

यह यूआरएल, MESSAGE, ADDED_TO_SPACE, और APP_COMMAND इंटरैक्शन इवेंट के लिए अपने-आप भर जाता है. Google Chat के बाहर, अनुमति देने या कॉन्फ़िगरेशन फ़्लो पूरा करने के बाद, उपयोगकर्ताओं को इस यूआरएल पर रीडायरेक्ट किया जाना चाहिए. इससे Google Chat को यह सिग्नल मिलेगा कि अनुमति देने या कॉन्फ़िगरेशन फ़्लो पूरा हो गया है. ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन को अन्य सेवाओं और टूल से कनेक्ट करना लेख पढ़ें.
isDialogEvent

boolean

CARD_CLICKED और MESSAGE इंटरैक्शन इवेंट के लिए, यह जानकारी मिलती है कि उपयोगकर्ता किसी डायलॉग से इंटरैक्ट कर रहा है या इंटरैक्ट करने वाला है.
dialogEventType

enum (DialogEventType)

मिले हुए डायलॉग इंटरैक्शन इवेंट का टाइप.
common

object (CommonEventObject)

यह कुकी, उपयोगकर्ता के क्लाइंट के बारे में जानकारी दिखाती है. जैसे, स्थान-भाषा, होस्ट ऐप्लिकेशन, और प्लैटफ़ॉर्म. Chat ऐप्लिकेशन के लिए, CommonEventObject में डायलॉग से इंटरैक्ट करने वाले उपयोगकर्ताओं की सबमिट की गई जानकारी शामिल होती है. जैसे, कार्ड पर डाला गया डेटा.
appCommandMetadata

object (AppCommandMetadata)

Chat ऐप्लिकेशन की कमांड के बारे में मेटाडेटा.

CommonEventObject

कॉमन इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जो उपयोगकर्ता के क्लाइंट से ऐड-ऑन को सामान्य जानकारी देता है. यह जानकारी, होस्ट से जुड़ी नहीं होती. इस जानकारी में, उपयोगकर्ता की स्थान-भाषा, होस्ट ऐप्लिकेशन, और प्लैटफ़ॉर्म जैसी जानकारी शामिल होती है.

होम पेज और कॉन्टेक्स्ट के हिसाब से ट्रिगर होने वाले इवेंट के अलावा, ऐड-ऑन इवेंट ऑब्जेक्ट बनाते हैं और उन्हें ऐक्शन कॉलबैक फ़ंक्शन को पास करते हैं. ऐसा तब होता है, जब उपयोगकर्ता विजेट से इंटरैक्ट करता है. आपके ऐड-ऑन का कॉलबैक फ़ंक्शन, सामान्य इवेंट ऑब्जेक्ट से क्वेरी कर सकता है. इससे यह पता चलता है कि उपयोगकर्ता के क्लाइंट में कौनसे विजेट खुले हैं. उदाहरण के लिए, आपका ऐड-ऑन उस टेक्स्ट का पता लगा सकता है जिसे किसी व्यक्ति ने eventObject.commentEventObject.formInputs ऑब्जेक्ट में मौजूद TextInput विजेट में डाला है.

चैट ऐप्लिकेशन के लिए, उस फ़ंक्शन का नाम जिसे उपयोगकर्ता ने विजेट से इंटरैक्ट करते समय शुरू किया था.

JSON के काेड में दिखाना 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
फ़ील्ड
userLocale

string

डिफ़ॉल्ट रूप से बंद होती है. उपयोगकर्ता की भाषा और देश/इलाके का आइडेंटिफ़ायर, ISO 639 भाषा कोड-ISO 3166 देश/इलाके के कोड के फ़ॉर्मैट में. उदाहरण के लिए, en-US.

इस फ़ील्ड को चालू करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में addOns.common.useLocaleFromApp को true पर सेट करना होगा. आपके ऐड-ऑन के स्कोप की सूची में https://www.googleapis.com/auth/script.locale भी शामिल होना चाहिए. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थान-भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.
hostApp

enum (HostApp)

इससे पता चलता है कि इवेंट ऑब्जेक्ट जनरेट होने पर, ऐड-ऑन किस होस्ट ऐप्लिकेशन में चालू है. ये वैल्यू हो सकती हैं:

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

enum (Platform)

यह प्लैटफ़ॉर्म enum है. इससे पता चलता है कि इवेंट किस प्लैटफ़ॉर्म से शुरू हुआ है (WEB, IOS या ANDROID). यह Chat ऐप्लिकेशन के साथ काम नहीं करता.
timeZone

object (TimeZone)

डिफ़ॉल्ट रूप से बंद होती है. टाइमज़ोन आईडी और कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से ऑफ़सेट. इस फ़ील्ड को चालू करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में addOns.common.useLocaleFromApp को true पर सेट करना होगा. आपके ऐड-ऑन के स्कोप की सूची में https://www.googleapis.com/auth/script.locale भी शामिल होना चाहिए. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थान-भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

सिर्फ़ CARD_CLICKED और SUBMIT_DIALOG इवेंट टाइप के लिए उपलब्ध है.
formInputs

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

ऐसा मैप जिसमें दिखाए गए कार्ड में मौजूद विजेट की मौजूदा वैल्यू शामिल हों. मैप की, हर विजेट को असाइन किए गए स्ट्रिंग आईडी होते हैं.

मैप वैल्यू ऑब्जेक्ट का स्ट्रक्चर, विजेट के टाइप पर निर्भर करता है:

ध्यान दें: यहां दिए गए उदाहरण, Apps Script के V8 रनटाइम के लिए फ़ॉर्मैट किए गए हैं. अगर Rhino runtime का इस्तेमाल किया जा रहा है, तो आपको वैल्यू के बाद [""] जोड़ना होगा. उदाहरण के लिए, e.commonEventObject.formInputs.employeeName.stringInputs.value[0] के बजाय, इवेंट ऑब्जेक्ट को e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] के तौर पर फ़ॉर्मैट करें. Apps Script में रनटाइम के बारे में ज़्यादा जानने के लिए, V8 रनटाइम की खास जानकारी देखें.

  • सिंगल वैल्यू वाले विजेट (उदाहरण के लिए, टेक्स्ट बॉक्स): स्ट्रिंग की सूची (सिर्फ़ एक एलिमेंट).

उदाहरण: अगर टेक्स्ट इनपुट वाले किसी विजेट का आईडी employeeName है, तो टेक्स्ट इनपुट की वैल्यू को e.commonEventObject.formInputs.employeeName.stringInputs.value[0] की मदद से ऐक्सेस करें.

  • एक से ज़्यादा वैल्यू वाले विजेट (उदाहरण के लिए, चेकबॉक्स ग्रुप): स्ट्रिंग की सूची.

उदाहरण: participants को आईडी के तौर पर इस्तेमाल करने वाले मल्टी-वैल्यू विजेट के लिए, वैल्यू कलेक्शन को इस तरह ऐक्सेस करें: e.commonEventObject.formInputs.participants.stringInputs.value.

उदाहरण: myDTPicker आईडी वाले पिकर के लिए, e.commonEventObject.formInputs.myDTPicker.dateTimeInput का इस्तेमाल करके DateTimeInput ऑब्जेक्ट को ऐक्सेस करें.

  • सिर्फ़ तारीख चुनने वाला टूल: DateInput object.

उदाहरण: myDatePicker आईडी वाले पिकर के लिए, e.commonEventObject.formInputs.myDatePicker.dateInput का इस्तेमाल करके DateInput ऑब्जेक्ट को ऐक्सेस करें.

  • सिर्फ़ समय चुनने वाला विजेट: TimeInput object.

उदाहरण: myTimePicker आईडी वाले पिकर के लिए, e.commonEventObject.formInputs.myTimePicker.timeInput का इस्तेमाल करके TimeInput ऑब्जेक्ट को ऐक्सेस करें.
parameters

map (key: string, value: string)

actionParameters या Action.setParameters() का इस्तेमाल करके, किसी कार्रवाई के लिए दिए गए अतिरिक्त पैरामीटर.

डेवलपर के लिए झलक: Google Chat की सुविधाओं को बढ़ाने वाले ऐड-ऑन के लिए, मल्टीसिलेक्ट मेन्यू में उपयोगकर्ताओं के टाइप किए गए शब्दों के आधार पर आइटम सुझाने के लिए, "autocomplete_widget_query" कुंजी (event.commonEventObject.parameters["autocomplete_widget_query"]) की वैल्यू का इस्तेमाल करें. इस वैल्यू का इस्तेमाल करके, डेटाबेस से क्वेरी की जा सकती है. साथ ही, उपयोगकर्ताओं के टाइप करते समय उन्हें चुनने लायक आइटम सुझाए जा सकते हैं. ज़्यादा जानकारी के लिए, Google Chat इस्तेमाल करने वाले लोगों की जानकारी इकट्ठा करना और उसे प्रोसेस करना लेख पढ़ें.
invokedFunction

string

लागू किए जाने वाले फ़ंक्शन का नाम.

यह फ़ील्ड, Google Chat की सुविधाओं को बढ़ाने वाले Google Workspace ऐड-ऑन के लिए नहीं भरता है. इसके बजाय, Chat की सुविधाओं को बढ़ाने वाले ऐड-ऑन को आइडेंटिफ़ायर जैसे फ़ंक्शन डेटा को पाने के लिए, parameters फ़ील्ड का इस्तेमाल करना चाहिए. Chat ऐप्लिकेशन के लिए इंटरैक्टिव इंटरफ़ेस बनाना लेख पढ़ें.

TimeZone

टाइमज़ोन आईडी और कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से ऑफ़सेट. सिर्फ़ CARD_CLICKED और SUBMIT_DIALOG इवेंट टाइप के लिए उपलब्ध है.

JSON के काेड में दिखाना 
{
  "id": string,
  "offset": integer
}
फ़ील्ड
id

string

आईएएनए टीज़ेड टाइम ज़ोन डेटाबेस कोड, जैसे कि "America/Toronto".
offset

integer

यह उपयोगकर्ता के टाइमज़ोन का ऑफ़सेट है. यह कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से मिलीसेकंड में होता है.

इनपुट

उपयोगकर्ता, कार्ड या डायलॉग बॉक्स में किस तरह का डेटा डाल सकते हैं. इनपुट टाइप, इस बात पर निर्भर करता है कि विजेट किस तरह की वैल्यू स्वीकार करता है.

JSON के काेड में दिखाना 
{

  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
}
फ़ील्ड
यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
stringInputs

object (StringInputs)

यह स्ट्रिंग की एक सूची होती है. इसमें वे वैल्यू शामिल होती हैं जिन्हें उपयोगकर्ता किसी विजेट में डालता है.

अगर विजेट सिर्फ़ एक वैल्यू स्वीकार करता है, जैसे कि TextInput विजेट, तो सूची में एक स्ट्रिंग ऑब्जेक्ट होता है. अगर विजेट में एक से ज़्यादा वैल्यू डाली जा सकती हैं, जैसे कि चेकबॉक्स वाला SelectionInput विजेट, तो सूची में हर उस वैल्यू के लिए एक स्ट्रिंग ऑब्जेक्ट होता है जिसे उपयोगकर्ता डालता है या चुनता है.
dateTimeInput

object (DateTimeInput)

DateTimePicker विजेट से तारीख और समय की इनपुट वैल्यू. यह विजेट, तारीख और समय, दोनों को स्वीकार करता है.
dateInput

object (DateInput)

DateTimePicker विजेट से तारीख की इनपुट वैल्यू. यह विजेट सिर्फ़ तारीख की वैल्यू स्वीकार करता है.
timeInput

object (TimeInput)

DateTimePicker विजेट से समय की इनपुट वैल्यू, जो सिर्फ़ समय की वैल्यू स्वीकार करता है.
एक-दूसरे से अलग फ़ील्ड के आखिर में.

StringInputs

सामान्य विजेट के लिए इनपुट पैरामीटर. सिंगल वैल्यू वाले विजेट के लिए, यह वैल्यू की एक सूची होती है. एक से ज़्यादा वैल्यू वाले विजेट, जैसे कि चेकबॉक्स के लिए, सभी वैल्यू दिखाई जाती हैं.

JSON के काेड में दिखाना 
{
  "value": [
    string
  ]
}
फ़ील्ड
value[]

string

उपयोगकर्ता की ओर से डाली गई स्ट्रिंग की सूची.

DateTimeInput

तारीख और समय की इनपुट वैल्यू.

JSON के काेड में दिखाना 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
फ़ील्ड
msSinceEpoch

string (int64 format)

epoch टाइम के बाद से, मिलीसेकंड में समय.
hasDate

boolean

datetime इनपुट में कैलेंडर की तारीख शामिल है या नहीं.
hasTime

boolean

क्या datetime इनपुट में टाइमस्टैंप शामिल है.

DateInput

तारीख के लिए इनपुट वैल्यू.

JSON के काेड में दिखाना 
{
  "msSinceEpoch": string
}
फ़ील्ड
msSinceEpoch

string (int64 format)

epoch टाइम के बाद से, मिलीसेकंड में समय.

TimeInput

समय के लिए इनपुट वैल्यू.

JSON के काेड में दिखाना 
{
  "hours": integer,
  "minutes": integer
}
फ़ील्ड
hours

integer

24 घंटे की घड़ी के हिसाब से घंटा.
minutes

integer

घंटे के बाद के मिनटों की संख्या. मान्य वैल्यू 0 से 59 के बीच होनी चाहिए.

AppCommandMetadata

Chat ऐप्लिकेशन के कमांड के बारे में मेटाडेटा.

JSON के काेड में दिखाना 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
फ़ील्ड
appCommandId

integer

Chat API कॉन्फ़िगरेशन में दी गई कमांड का आईडी.
appCommandType

enum (AppCommandType)

Chat ऐप्लिकेशन में इस्तेमाल की गई कमांड का टाइप.