इवेंट ऑब्जेक्ट

इस पेज पर, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट के स्ट्रक्चर के बारे में बताया गया है.

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

Google Workspace ऐड-ऑन, इन जगहों पर इवेंट ऑब्जेक्ट का इस्तेमाल करते हैं:

  • होम पेज ट्रिगर. होम पेज ट्रिगर फ़ंक्शन के फ़ायर होने पर, आपके तय किए गए हर homepageTrigger फ़ंक्शन को अपने-आप एक इवेंट ऑब्जेक्ट पास हो जाता है. इस ऑब्जेक्ट का इस्तेमाल, होम पेज ट्रिगर फ़ंक्शन में किया जा सकता है. इससे, चालू होस्ट ऐप्लिकेशन, क्लाइंट के प्लैटफ़ॉर्म, उपयोगकर्ता की भाषा, और अन्य जानकारी की पहचान की जा सकती है.

    होम पेज ट्रिगर होने पर बनाए गए इवेंट ऑब्जेक्ट में, अन्य मामलों में शामिल सभी फ़ील्ड शामिल नहीं होते. विजेट और काम की जानकारी से जुड़े फ़ील्ड शामिल नहीं किए जाते.

  • कॉन्टेक्स्ट के हिसाब से ट्रिगर. हर होस्ट ऐप्लिकेशन, कॉन्टेक्स्ट के हिसाब से ट्रिगर होने वाले अलग-अलग सेट उपलब्ध कराता है. ये ट्रिगर तब चालू होते हैं, जब उपयोगकर्ता किसी खास कॉन्टेक्स्ट में जाता है:

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

  • विजेट से जुड़ी कार्रवाइयां. इवेंट ऑब्जेक्ट, विजेट को इंटरैक्टिव बनाते हैं. इसके लिए, वे उसी ऐक्शन मॉडल का इस्तेमाल करते हैं जिसका इस्तेमाल Gmail ऐड-ऑन करते हैं. Google Workspace ऐड-ऑन, एक ही विजेट हैंडलर फ़ंक्शन, Action ऑब्जेक्ट, और ऐक्शन रिस्पॉन्स का इस्तेमाल करते हैं. Google Workspace ऐड-ऑन में, ऐक्शन इवेंट ऑब्जेक्ट में ज़्यादा जानकारी शामिल होती है. इस जानकारी का इस्तेमाल करके, कॉलबैक फ़ंक्शन काम कर सकता है.

    विजेट की कार्रवाइयों से बनाए गए इवेंट ऑब्जेक्ट में, कॉन्टेक्स्ट के हिसाब से ट्रिगर होने वाले इवेंट ऑब्जेक्ट में शामिल सभी फ़ील्ड होते हैं. साथ ही, इनमें विजेट की जानकारी वाले फ़ील्ड भी होते हैं.

  • लिंक ट्रिगर की झलक देखना. Google Docs, Sheets, और Slides में, तीसरे पक्ष की सेवाओं के लिए लिंक की झलक कॉन्फ़िगर की जा सकती है. इसके लिए, आपको खास यूआरएल पैटर्न का इस्तेमाल करना होगा. जब उपयोगकर्ता पैटर्न से मैच होने वाले किसी लिंक से इंटरैक्ट करते हैं, तो linkPreviewTriggers ट्रिगर होता है. साथ ही, लिंक वाला इवेंट ऑब्जेक्ट, ट्रिगर के कॉलबैक फ़ंक्शन को पास कर दिया जाता है. आपका ऐड-ऑन, इस इवेंट ऑब्जेक्ट का इस्तेमाल करके स्मार्ट चिप और कार्ड बना सकता है. इससे होस्ट ऐप्लिकेशन में मौजूद लिंक के बारे में जानकारी दिखती है. विजेट ऐक्शन भी बनाए जा सकते हैं, ताकि उपयोगकर्ता झलक वाले कार्ड और उसके कॉन्टेंट के साथ इंटरैक्ट कर सकें.

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

इवेंट ऑब्जेक्ट का स्ट्रक्चर

नीचे दी गई टेबल में, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट के टॉप-लेवल स्ट्रक्चर के बारे में बताया गया है. इस स्ट्रक्चर में, होस्ट से अलग जानकारी के लिए commonEventObject टॉप-लेवल फ़ील्ड शामिल होता है. हर इवेंट ऑब्जेक्ट में, होस्ट के हिसाब से टॉप-लेवल का इनमें से कोई एक फ़ील्ड भी हो सकता है. यह फ़ील्ड, चालू होस्ट ऐप्लिकेशन के हिसाब से तय होता है: gmailEventObject, calendarEventObject या driveEventObject.

पुराने सिस्टम के साथ काम करने की सुविधा के लिए, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट में, Gmail ऐड-ऑन के ऐक्शन इवेंट ऑब्जेक्ट में इस्तेमाल किए गए ओरिजनल फ़ील्ड शामिल होते हैं. ये फ़ील्ड, "Gmail ऐड-ऑन के ओरिजनल फ़ील्ड" में मौजूद होते हैं. ये commonEventObject का हिस्सा नहीं होते.

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

इवेंट ऑब्जेक्ट
eventObject.commonEventObject Common fields object
एक ऐसा ऑब्जेक्ट जिसमें सभी इवेंट ऑब्जेक्ट की सामान्य जानकारी होती है. इससे कोई फ़र्क़ नहीं पड़ता कि होस्ट ऐप्लिकेशन कौनसा है.
eventObject.calendar Calendar event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Calendar हो. एक ऑब्जेक्ट, जिसमें कैलेंडर और इवेंट की जानकारी होती है.
eventObject.chat Chat event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Chat हो. ऐसा ऑब्जेक्ट जिसमें चैट की जानकारी शामिल हो.
eventObject.drive Drive event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Drive हो. ऐसा ऑब्जेक्ट जिसमें Drive की जानकारी शामिल हो.
eventObject.gmail Gmail event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Gmail हो. Gmail की जानकारी वाला ऑब्जेक्ट.
eventObject.docs Docs event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Docs हो. एक ऑब्जेक्ट, जिसमें Docs की जानकारी शामिल है.
eventObject.sheets Sheets event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Sheets हो. Sheets की जानकारी वाला ऑब्जेक्ट.
eventObject.slides Slides event object
यह सिर्फ़ तब मौजूद होता है, जब कॉल करने वाला होस्ट Google Slides हो. ऐसा ऑब्जेक्ट जिसमें Slides की जानकारी शामिल हो.
Gmail ऐड-ऑन के ओरिजनल फ़ील्ड
eventObject.messageMetadata.accessToken string
अब काम नहीं करता. एक ऐक्सेस टोकन. इसका इस्तेमाल करके, Gmail ऐड-ऑन के कुछ समय के लिए मान्य स्कोप की मदद से, उपयोगकर्ता के डेटा का ऐक्सेस चालू किया जा सकता है.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.gmail.accessToken फ़ील्ड में देखें.

eventObject.messageMetadata.messageId string
अब काम नहीं करता. Gmail के यूज़र इंटरफ़ेस (यूआई) में खुले थ्रेड का मैसेज आईडी.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.gmail.messageId फ़ील्ड में देखें.

eventObject.clientPlatform string
अब काम नहीं करता. इससे पता चलता है कि इवेंट कहां से शुरू हुआ (वेब, iOS या Android).

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.platform फ़ील्ड में देखें.

eventObject.formInput object
अब काम नहीं करता. कार्ड में मौजूद सभी फ़ॉर्म विजेट की मौजूदा वैल्यू का मैप. इसमें हर विजेट के लिए सिर्फ़ एक वैल्यू हो सकती है. इसमें मौजूद बटन, विजेट से जुड़े स्ट्रिंग आईडी होते हैं और वैल्यू, स्ट्रिंग होती हैं. इवेंट ऑब्जेक्ट, formInput को सुविधा के तौर पर उपलब्ध कराता है. ऐसा तब होता है, जब आपको कई विजेट से डेटा पढ़ना हो और उनमें एक जैसी वैल्यू की उम्मीद हो. जैसे, टेक्स्ट इनपुट और स्विच. एक से ज़्यादा वैल्यू वाले विजेट, जैसे कि चेकबॉक्स के लिए, हर वैल्यू को formInputs से पढ़ें.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.formInputs फ़ील्ड में ढूंढें; सिंगल वैल्यू वाले विजेट को सिंगल एलिमेंट वाले ऐरे के तौर पर दिखाया जाता है.

eventObject.formInputs object
अब काम नहीं करता. कार्ड में मौजूद विजेट की मौजूदा वैल्यू का मैप, जो स्ट्रिंग की सूचियों के तौर पर दिखाया जाता है. कुंजियां, विजेट से जुड़े स्ट्रिंग आईडी होती हैं. सिंगल-वैल्यू वाले विजेट के लिए, वैल्यू को सिंगल-एलिमेंट कलेक्शन में दिखाया जाता है. एक से ज़्यादा वैल्यू वाले विजेट, जैसे कि चेकबॉक्स ग्रुप के लिए, सभी वैल्यू एक सूची में दिखाई जाती हैं.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.formInputs फ़ील्ड में देखें.

eventObject.parameters object
अब काम नहीं करता. Action.setParameters का इस्तेमाल करके, Action को दिए गए किसी भी अतिरिक्त पैरामीटर का मैप. मैप की कुंजियां और वैल्यू, स्ट्रिंग होती हैं.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.parameters फ़ील्ड में देखें.

eventObject.userCountry string
अब इस्तेमाल नहीं किया जा सकता और डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के देश या इलाके को बताने वाला दो अक्षर का कोड. यह देश का न्यूमेरिक UN M49 कोड भी हो सकता है.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.userLocale फ़ील्ड में देखें.

eventObject.userLocale string
अब इस्तेमाल नहीं किया जा सकता और डिफ़ॉल्ट रूप से बंद है. दो अक्षरों वाला ISO 639 कोड, जिससे उपयोगकर्ता की भाषा का पता चलता है. ज़्यादा जानकारी के लिए, उपयोगकर्ता की भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.userLocale फ़ील्ड में देखें.

eventObject.userTimezone.id string
अब इस्तेमाल नहीं किया जा सकता और डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के टाइमज़ोन का टाइमज़ोन आइडेंटिफ़ायर. उदाहरण के लिए: America/New_York, Europe/Vienna, और Asia/Seoul. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.timeZone.id फ़ील्ड में देखें.

eventObject.userTimezone.offset string
अब इस्तेमाल नहीं किया जा सकता और डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के टाइमज़ोन के कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से टाइम ऑफ़सेट. इसे मिलीसेकंड में मेज़र किया जाता है. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.

Google Workspace ऐड-ऑन के लिए, यह जानकारी eventObject.commonEventObject.timeZone.offset फ़ील्ड में देखें.

सामान्य इवेंट ऑब्जेक्ट

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

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

सामान्य इवेंट ऑब्जेक्ट फ़ील्ड
commonEventObject.platform string
इससे पता चलता है कि इवेंट कहां से शुरू हुआ (`WEB`, `IOS` या `ANDROID`).
commonEventObject.formInputs object
एक मैप, जिसमें दिखाए गए कार्ड में मौजूद विजेट की मौजूदा वैल्यू शामिल होती हैं. मैप की कुंजियां, हर विजेट को असाइन किए गए स्ट्रिंग आईडी होती हैं.

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

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

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

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

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

  • A date-time picker: DateTimeInput object.

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

  • A date-only picker: DateInput object.

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

  • A time-only picker: TimeInput object.

    उदाहरण: myTimePicker आईडी वाले पिकर के लिए, e.commonEventObject.formInputs.myTimePicker.timeInput का इस्तेमाल करके TimeInput ऑब्जेक्ट को ऐक्सेस करें.
commonEventObject.hostApp string
इससे पता चलता है कि इवेंट ऑब्जेक्ट जनरेट होने पर, ऐड-ऑन किस होस्ट ऐप्लिकेशन में चालू है. इनमें ये वैल्यू शामिल हो सकती हैं:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
कोई भी अतिरिक्त पैरामीटर, जो actionParameters या Action.setParameters का इस्तेमाल करके किसी कार्रवाई को दिया जाता है.

डेवलपर के लिए झलक: Google Chat ऐप्लिकेशन के लिए, कई आइटम चुनने की सुविधा वाले मेन्यू में उपयोगकर्ता जो टाइप करते हैं उसके आधार पर आइटम के सुझाव देने के लिए, "autocomplete_widget_query" कुंजी (event.commonEventObject.parameters["autocomplete_widget_query"]) की वैल्यू का इस्तेमाल करें. इस वैल्यू का इस्तेमाल करके, डेटाबेस से क्वेरी की जा सकती है. साथ ही, उपयोगकर्ताओं को टाइप करते समय, चुने जा सकने वाले आइटम के सुझाव दिए जा सकते हैं. ज़्यादा जानकारी के लिए, Google Chat के उपयोगकर्ताओं की जानकारी इकट्ठा और प्रोसेस करना लेख पढ़ें.
commonEventObject.userLocale string
डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता की भाषा और देश/इलाके का आइडेंटिफ़ायर. इसे ISO 639 भाषा कोड-ISO 3166 देश/इलाके के कोड के फ़ॉर्मैट में लिखा जाता है. उदाहरण के लिए, en-US.

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

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

तारीख और समय चुनने वाले टूल के फ़ॉर्म इनपुट

ऐक्शन कॉलबैक फ़ंक्शन, commonEventObject.formInputs फ़ील्ड में मौजूदा विजेट वैल्यू पा सकते हैं. इसमें तारीख या समय चुनने वाले विजेट में, उपयोगकर्ता की चुनी गई तारीख या समय की वैल्यू शामिल होती हैं. जानकारी का स्ट्रक्चर इस बात पर निर्भर करता है कि विजेट को तारीख और समय चुनने वाले टूल, सिर्फ़ तारीख चुनने वाले टूल या सिर्फ़ समय चुनने वाले टूल के तौर पर कॉन्फ़िगर किया गया है या नहीं. स्ट्रक्चर के अंतर के बारे में यहां दी गई टेबल में बताया गया है:

DateTimeInput ऑब्जेक्ट
dateTimeInput.hasDate boolean
true अगर इनपुट की गई तारीख और समय में तारीख शामिल है; अगर false सिर्फ़ समय शामिल है.
dateTimeInput.hasTime boolean
true अगर इनपुट की गई तारीख और समय में समय शामिल है; अगर false सिर्फ़ तारीख शामिल है.
dateTimeInput.msSinceEpoch string
उपयोगकर्ता ने जो समय चुना है वह Epoch (1 जनवरी, 1970 को 00:00:00 यूटीसी) के बाद से मिलीसेकंड में है.
DateInput ऑब्जेक्ट
dateInput.msSinceEpoch string
उपयोगकर्ता ने जो समय चुना है वह Epoch (1 जनवरी, 1970 को 00:00:00 यूटीसी) के बाद से मिलीसेकंड में है.
TimeInput ऑब्जेक्ट
timeInput.hours number
उपयोगकर्ता ने घंटे के लिए जो नंबर चुना है.
timeInput.minutes number
उपयोगकर्ता ने मिनट के लिए जो नंबर चुना है.

चैट इवेंट ऑब्जेक्ट

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

Chat
chat.user object (User)
Chat ऐप्लिकेशन से इंटरैक्ट करने वाला Chat उपयोगकर्ता.
chat.space object (Space)
वह Chat स्पेस जहां उपयोगकर्ता ने Chat ऐप्लिकेशन के साथ इंटरैक्ट किया.
chat.eventTime

string (Timestamp format)

इंटरैक्शन होने का समय.

यूनियन फ़ील्ड payload. ऐप्लिकेशन होम ट्रिगर के लिए (जब कोई उपयोगकर्ता होम टैब खोलता है), payload सेट नहीं होता है और chat में chat.user और chat.eventTime शामिल होते हैं.

payload इनमें से सिर्फ़ एक हो सकता है:
chat.messagePayload

object (MessagePayload)

वह पेलोड जो चैट ऐप्लिकेशन को मैसेज ट्रिगर से मिलता है.
chat.addedToSpacePayload

object (AddedToSpacePayload)

वह पेलोड जो चैट ऐप्लिकेशन को स्पेस में जोड़ा गया ट्रिगर से मिलता है.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

वह पेलोड जो Chat ऐप्लिकेशन को स्पेस से हटाया गया ट्रिगर से मिलता है.
chat.buttonClickedPayload

object (ButtonClickedPayload)

जब उपयोगकर्ता किसी मैसेज या कार्ड में मौजूद बटन पर क्लिक करते हैं, तो Chat ऐप्लिकेशन को मिलने वाला पेलोड. अगर कोई उपयोगकर्ता जानकारी सबमिट करने के लिए किसी बटन पर क्लिक करता है, तो commonEventObject.formInputs ऑब्जेक्ट में उपयोगकर्ता से इकट्ठा की गई वैल्यू शामिल होती हैं. इसके बारे में ज़्यादा जानने के लिए, Google Chat इस्तेमाल करने वालों से जानकारी इकट्ठा करना देखें.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

वह पेलोड जो चैट ऐप्लिकेशन को तब मिलता है, जब उपयोगकर्ता selectionInput विजेट के कई विकल्प चुनने वाले मेन्यू में टेक्स्ट टाइप करते हैं. चैट ऐप्लिकेशन, इस इवेंट ऑब्जेक्ट का इस्तेमाल करके डाइनैमिक डेटा सोर्स से सुझाए गए आइटम भर सकते हैं. उदाहरण के लिए, किसी बाहरी डेटा सोर्स से सहायता मामलों की जानकारी भरने के लिए, Chat ऐप्लिकेशन उस डेटा सोर्स से क्वेरी कर सकता है. यह क्वेरी, उपयोगकर्ता के मेन्यू में टाइप किए गए टेक्स्ट के आधार पर की जाती है. इसके बाद, Chat ऐप्लिकेशन, क्वेरी से मैच होने वाले सहायता मामलों को चुने जा सकने वाले आइटम के तौर पर दिखाता है.

CommonEventObject.parameters['autocomplete_widget_query'] ऑब्जेक्ट में वह स्ट्रिंग वैल्यू होती है जिसे उपयोगकर्ता मेन्यू में टाइप करता है.

chat.appCommandPayload

object (AppCommandPayload)

जब कोई उपयोगकर्ता Chat ऐप्लिकेशन में किसी कमांड का इस्तेमाल करता है, तो Chat ऐप्लिकेशन को मिलने वाला पेलोड.

पेलोड

चैट ऐप्लिकेशन के साथ होने वाले इंटरैक्शन के टाइप के आधार पर, इवेंट में एक या उससे ज़्यादा Chat API रिसॉर्स वाला पेलोड शामिल होता है.

मैसेज पेलोड
MessagePayload
chat.messagePayload.message object (Message)
वह चैट मैसेज जिससे इवेंट ट्रिगर हुआ.
chat.messagePayload.space object (Space)
Chat का वह स्पेस जिसमें किसी उपयोगकर्ता ने मैसेज भेजा है. इस मैसेज की वजह से Chat ऐप्लिकेशन को शुरू किया गया.
chat.messagePayload.configCompleteRedirectUri string
वह यूआरएल जिस पर चैट ऐप्लिकेशन को उपयोगकर्ता को रीडायरेक्ट करना चाहिए. यह रीडायरेक्शन, Google Chat के बाहर अनुमति या कॉन्फ़िगरेशन फ़्लो पूरा करने के बाद होना चाहिए. ज़्यादा जानकारी के लिए, अपने Google Workspace ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करना लेख पढ़ें.
स्पेस पेलोड में जोड़ा गया
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Chat का वह स्पेस जिसमें उपयोगकर्ता ने Chat ऐप्लिकेशन को जोड़ा या इंस्टॉल किया है.

जब एडमिन Chat ऐप्लिकेशन इंस्टॉल करते हैं, तो space.adminInstalled फ़ील्ड को true पर सेट किया जाता है.

chat.addedToSpacePayload.interactionAdd boolean
क्या कोई उपयोगकर्ता, मैसेज का इस्तेमाल करके Chat ऐप्लिकेशन को किसी स्पेस में जोड़ता है. उदाहरण के लिए, चैट ऐप्लिकेशन को @mention करना या किसी निर्देश का इस्तेमाल करना. अगर true, तो Chat एक और इवेंट ऑब्जेक्ट भेजता है. इसमें messagePayload होता है, जिसमें मैसेज की जानकारी होती है.
chat.addedToSpacePayload.configCompleteRedirectUri string
वह यूआरएल जिस पर चैट ऐप्लिकेशन को उपयोगकर्ता को रीडायरेक्ट करना चाहिए. यह रीडायरेक्शन, Google Chat के बाहर अनुमति या कॉन्फ़िगरेशन फ़्लो पूरा करने के बाद होना चाहिए. ज़्यादा जानकारी के लिए, अपने Google Workspace ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करना लेख पढ़ें.
स्पेस पेलोड से हटाया गया
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
वह Chat स्पेस जिससे उपयोगकर्ता ने Chat ऐप्लिकेशन को हटाया या अनइंस्टॉल किया.

जब एडमिन, चैट ऐप्लिकेशन अनइंस्टॉल करते हैं, तो space.adminInstalled फ़ील्ड को false पर सेट कर दिया जाता है.

बटन पर क्लिक करने से जुड़ा पेलोड
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Chat का वह मैसेज जिसमें मौजूद बटन पर उपयोगकर्ता ने क्लिक किया.
chat.buttonClickedPayload.space object (Space)
वह Chat स्पेस जहां उपयोगकर्ता ने Chat ऐप्लिकेशन के मैसेज में मौजूद किसी बटन पर क्लिक किया.
chat.buttonClickedPayload.isDialogEvent boolean
क्या उपयोगकर्ता ने डायलॉग से इंटरैक्ट करने के लिए, बटन पर क्लिक किया.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
अगर isDialogEvent की वैल्यू true है, तो डायलॉग में इंटरैक्शन का टाइप.

Enum DialogEventType.

dialogEventType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
REQUEST_DIALOG कोई उपयोगकर्ता, डायलॉग का अनुरोध करता है. उदाहरण के लिए, वे किसी निर्देश का इस्तेमाल करते हैं या मैसेज में मौजूद किसी बटन पर क्लिक करते हैं.
SUBMIT_DIALOG कोई उपयोगकर्ता, डायलॉग बॉक्स में मौजूद किसी इंटरैक्टिव एलिमेंट पर क्लिक करता है. उदाहरण के लिए, कोई उपयोगकर्ता किसी डायलॉग बॉक्स में जानकारी भरता है और जानकारी सबमिट करने के लिए किसी बटन पर क्लिक करता है.
विजेट का अपडेट किया गया पेलोड
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
वह Chat स्पेस जहां इंटरैक्शन हुआ.
ऐप्लिकेशन कमांड पेलोड
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
इस बारे में मेटाडेटा कि उपयोगकर्ता ने किस निर्देश का इस्तेमाल किया और उसे कैसे ट्रिगर किया.
chat.appCommandPayload.space object (Space)
वह Chat स्पेस जिसमें किसी उपयोगकर्ता ने कमांड का इस्तेमाल किया.
chat.appCommandPayload.thread object (Thread)
अगर इंटरैक्शन किसी थ्रेड में हुआ है, तो Chat का वह थ्रेड जहां उपयोगकर्ता ने कमांड का इस्तेमाल किया है.
chat.appCommandPayload.message object (Message)
स्लैश कमांड के लिए, स्लैश कमांड वाला मैसेज.
chat.appCommandPayload.configCompleteRedirectUri string
अगर कमांड के लिए अनुमति या कॉन्फ़िगरेशन की ज़रूरत है, तो Google Chat के बाहर प्रोसेस पूरी करने के बाद, उपयोगकर्ता को रीडायरेक्ट करने के लिए यूआरएल.
chat.appCommandPayload.isDialogEvent boolean
क्या कमांड से कोई डायलॉग खुलता है.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
डायलॉग के साथ इंटरैक्शन का टाइप.

Enum DialogEventType.

dialogEventType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
REQUEST_DIALOG कोई उपयोगकर्ता, डायलॉग का अनुरोध करता है. उदाहरण के लिए, वे किसी निर्देश का इस्तेमाल करते हैं या मैसेज में मौजूद किसी बटन पर क्लिक करते हैं.
SUBMIT_DIALOG कोई उपयोगकर्ता, डायलॉग बॉक्स में मौजूद किसी इंटरैक्टिव एलिमेंट पर क्लिक करता है. उदाहरण के लिए, कोई उपयोगकर्ता किसी डायलॉग बॉक्स में जानकारी भरता है और जानकारी सबमिट करने के लिए किसी बटन पर क्लिक करता है.
ऐप्लिकेशन कमांड का मेटाडेटा
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

कमांड आईडी.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
कमांड का टाइप.

Enum AppCommandType.

AppCommandType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
APP_COMMAND_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
SLASH_COMMAND कोई उपयोगकर्ता, स्लैश / से शुरू होने वाला मैसेज भेजकर कमांड का इस्तेमाल करता है.
QUICK_COMMAND उपयोगकर्ता, मैसेज का जवाब देने वाले बॉक्स में मौजूद Chat मेन्यू से कमांड चुनता है.

कैलेंडर इवेंट ऑब्जेक्ट

Calendar इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के कैलेंडर और कैलेंडर इवेंट की जानकारी होती है. यह सिर्फ़ किसी इवेंट ऑब्जेक्ट में मौजूद होता है, अगर ऐड-ऑन Google Calendar को एक्सटेंड करता है.

इस टेबल में, इवेंट ऑब्जेक्ट के calendarEventObject फ़ील्ड में मौजूद फ़ील्ड की सूची दी गई है. उपयोगकर्ता से मिले डेटा के तौर पर मार्क किए गए फ़ील्ड, इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होते हैं, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

इस ऑब्जेक्ट और इसके सबस्ट्रक्चर के कई फ़ील्ड के लिए, एक ही नाम के Calendar API इवेंट रिसॉर्स फ़ील्ड की डायरेक्ट मैपिंग होती है. अगर फ़ील्ड की जानकारी अलग-अलग है, तो यहां दी गई टेबल में मौजूद जानकारी सही है.

कैलेंडर इवेंट ऑब्जेक्ट
calendar.attendees[] list of attendee objects
उपयोगकर्ता से मिला डेटा. कैलेंडर इवेंट में शामिल होने वाले लोगों की सूची.
calendar.calendarId string
कैलेंडर आईडी.
calendar.capabilities object
उपयोगकर्ता से मिला डेटा. यह एक ऐसा ऑब्जेक्ट है जो इवेंट की जानकारी देखने या उसे अपडेट करने के लिए, ऐड-ऑन की सुविधाओं के बारे में बताता है.
calendar.capabilities.canAddAttendees boolean
उपयोगकर्ता से मिला डेटा. true अगर ऐड-ऑन, इवेंट में शामिल होने वाले लोगों की सूची में नए लोगों को जोड़ सकता है; false अगर ऐसा नहीं है.
calendar.capabilities.canSeeAttendees boolean
उपयोगकर्ता से मिला डेटा. true अगर ऐड-ऑन, इवेंट में शामिल होने वाले लोगों की सूची को पढ़ सकता है; false अगर ऐसा नहीं है.
calendar.capabilities.canSeeConferenceData boolean
उपयोगकर्ता से मिला डेटा. true अगर ऐड-ऑन, इवेंट की कॉन्फ़्रेंस का डेटा पढ़ सकता है; false अगर ऐसा नहीं है.
calendar.capabilities.canSetConferenceData boolean
उपयोगकर्ता से मिला डेटा. true अगर ऐड-ऑन, इवेंट के कॉन्फ़्रेंस डेटा को अपडेट कर सकता है; false अगर ऐसा नहीं है, तो.
calendar.capabilities.canAddAttachments boolean
उपयोगकर्ता से मिला डेटा. true अगर ऐड-ऑन, इवेंट में नए अटैचमेंट जोड़ सकता है; false अगर ऐसा नहीं है.
calendar.conferenceData Conference data object
उपयोगकर्ता से मिला डेटा. इस इवेंट से जुड़े किसी भी कॉन्फ़्रेंस डेटा को दिखाने वाला ऑब्जेक्ट, जैसे कि Google Meet कॉन्फ़्रेंस की जानकारी.
calendar.id string
इवेंट आईडी.
calendar.organizer object
इवेंट के आयोजक को दिखाने वाला ऑब्जेक्ट.
calendar.organizer.email string
इवेंट के आयोजक का ईमेल पता.
calendar.recurringEventId string
बार-बार होने वाले इवेंट का आईडी.

मेहमान

मेहमान ऑब्जेक्ट में, Google Calendar इवेंट में शामिल होने वाले हर मेहमान की जानकारी होती है. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा कैलेंडर इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

Attendee object
attendee.additionalGuests number
मेहमान ने अपने साथ आने वाले अन्य मेहमानों की जो संख्या बताई है. डिफ़ॉल्ट तौर पर, यह वैल्यू शून्य पर सेट होती है.
attendee.comment string
मेहमान की प्रतिक्रिया वाली टिप्पणी, अगर कोई हो.
attendee.displayName string
मेहमान का डिसप्ले नेम.
attendee.email string
मेहमान का ईमेल पता.
attendee.optional boolean
true अगर इस मेहमान की मौजूदगी को 'ज़रूरी नहीं' के तौर पर मार्क किया गया है; false नहीं तो.
attendee.organizer boolean
true अगर मेहमान इस इवेंट का आयोजक है.
attendee.resource boolean
true अगर मेहमान किसी संसाधन को दिखाता है, जैसे कि कमरा या उपकरण; false नहीं तो.
attendee.responseStatus string
मेहमान के जवाब का स्टेटस. इनमें ये वैल्यू शामिल हो सकती हैं:
  • accepted: मेहमान ने इवेंट का न्योता स्वीकार कर लिया है.
  • declined: मेहमान ने इवेंट का न्योता अस्वीकार कर दिया है.
  • needsAction: मेहमान ने इवेंट के न्योते का जवाब नहीं दिया है.
  • tentative: मेहमान ने इवेंट के न्योते को कुछ समय के लिए स्वीकार कर लिया है.
attendee.self boolean
true अगर यह मेहमान उस कैलेंडर को दिखाता है जिसमें यह इवेंट दिखता है; false अगर ऐसा नहीं है.

कॉन्फ़्रेंस का डेटा

कॉन्फ़्रेंस डेटा ऑब्जेक्ट में, Google Calendar इवेंट से जुड़ी कॉन्फ़्रेंस की जानकारी होती है. ये Google के कॉन्फ़्रेंसिंग के विकल्प हो सकते हैं, जैसे कि Google Meet या तीसरे पक्ष के कॉन्फ़्रेंसिंग के विकल्प. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

कॉन्फ़्रेंस डेटा ऑब्जेक्ट
conferenceData.conferenceId string
कॉन्फ़्रेंस का आईडी. इस आईडी का मकसद, ऐप्लिकेशन को कॉन्फ़्रेंस ट्रैक करने की अनुमति देना है. आपको यह आईडी उपयोगकर्ताओं को नहीं दिखाना चाहिए.
conferenceData.conferenceSolution object
कॉन्फ़्रेंसिंग के विकल्प को दिखाने वाला ऑब्जेक्ट, जैसे कि Hangouts या Google Meet.
conferenceData.conferenceSolution.iconUri string
इस कॉन्फ़्रेंसिंग के विकल्प को दिखाने वाले आइकॉन का यूआरआई, जो उपयोगकर्ता को दिखता है.
conferenceData.conferenceSolution.key object
वह कुंजी जो इस इवेंट के लिए कॉन्फ़्रेंसिंग के विकल्प की खास तौर पर पहचान करती है.
conferenceData.conferenceSolution.key.type string
कॉन्फ़्रेंसिंग के विकल्प का टाइप. इनमें से कोई एक वैल्यू हो सकती है:
  • eventHangout, उपभोक्ताओं के लिए Hangouts के लिए (http://hangouts.google.com).
  • Google Workspace के उपयोगकर्ताओं के लिए, Hangouts के क्लासिक वर्शन के लिए eventNamedHangout (http://hangouts.google.com).
  • Google Meet (http://meet.google.com) के लिए hangoutsMeet.
conferenceData.conferenceSolution.name string
इस कॉन्फ़्रेंसिंग के विकल्प का नाम, जो उपयोगकर्ता को दिखता है (स्थानीय भाषा में नहीं).
conferenceData.entryPoints[] list of entry point objects
कॉन्फ़्रेंस में शामिल होने के लिए एंट्री पॉइंट की सूची, जैसे कि यूआरएल या फ़ोन नंबर.
conferenceData.notes string
कॉन्फ़्रेंस के बारे में उपयोगकर्ता को दिखाने के लिए अतिरिक्त नोट (जैसे, डोमेन एडमिन के निर्देश या कानूनी नोटिस). इसमें एचटीएमएल शामिल हो सकता है. ज़्यादा से ज़्यादा 2048 वर्ण इस्तेमाल किए जा सकते हैं.
conferenceData.parameters object
ऐसा ऑब्जेक्ट जिसमें तय किए गए पैरामीटर डेटा का मैप शामिल हो, ताकि ऐड-ऑन उसका इस्तेमाल कर सके.
conferenceData.parameters.addOnParameters object
पैरामीटर स्ट्रिंग की और वैल्यू का मैप. इन कुंजियों और वैल्यू को ऐड-ऑन डेवलपर तय करता है, ताकि ऐड-ऑन के इस्तेमाल के लिए किसी खास कॉन्फ़्रेंस में जानकारी अटैच की जा सके.

आने की जगह

एंट्री पॉइंट ऑब्जेक्ट में, किसी कॉन्फ़्रेंस को ऐक्सेस करने के लिए तय किए गए तरीकों की जानकारी होती है. जैसे, फ़ोन या वीडियो से. यह जानकारी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess मेनिफ़ेस्ट फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

एंट्री पॉइंट ऑब्जेक्ट
entryPoint.accessCode string
कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया गया ऐक्सेस कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. सिर्फ़ वे फ़ील्ड मैच करें और दिखाएं जिनका इस्तेमाल कॉन्फ़्रेंस की सुविधा देने वाली कंपनी करती है.
entryPoint.entryPointFeatures list
एंट्री पॉइंट की सुविधाएं. फ़िलहाल, ये सुविधाएं सिर्फ़ phone एंट्री पॉइंट पर लागू होती हैं:
  • toll: एंट्री पॉइंट, टोल फ़ोन कॉल है.
  • toll_free: एंट्री पॉइंट, टोल-फ़्री फ़ोन कॉल है.
entryPoint.entryPointType string
एंट्री पॉइंट का टाइप. इन वैल्यू का इस्तेमाल किया जा सकता है:
  • more: कॉन्फ़्रेंस में शामिल होने के लिए अन्य निर्देश, जैसे कि वैकल्पिक फ़ोन नंबर. किसी कॉन्फ़्रेंस में सिर्फ़ एक more एंट्री पॉइंट हो सकता है. अगर यह मौजूद है, तो कम से कम एक अन्य तरह का एंट्री पॉइंट भी होना चाहिए.
  • phone: फ़ोन नंबर से कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में, phone के शून्य या उससे ज़्यादा एंट्री पॉइंट हो सकते हैं. Google Calendar, फ़ोन से मीटिंग में शामिल होने के लिए सिर्फ़ पहले दो एंट्री पॉइंट दिखाता है. ये एंट्री पॉइंट, फ़ॉर्मैट करने और वर्णमाला के क्रम में लगाने के बाद दिखाए जाते हैं.
  • sip: एसआईपी का इस्तेमाल करके कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में ज़्यादा से ज़्यादा एक sip एंट्री पॉइंट हो सकता है.
  • video: एचटीटीपी का इस्तेमाल करके कॉन्फ़्रेंस में शामिल हों. किसी कॉन्फ़्रेंस में, ज़्यादा से ज़्यादा एक video एंट्री पॉइंट हो सकता है.
entryPoint.label string
एंट्री पॉइंट यूआरआई के लिए, उपयोगकर्ता को दिखने वाला लेबल (स्थानीय भाषा में नहीं).
entryPoint.meetingCode string
कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया गया मीटिंग कोड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. सिर्फ़ वे फ़ील्ड मैच करें और दिखाएं जिनका इस्तेमाल कॉन्फ़्रेंस की सुविधा देने वाली कंपनी करती है.
entryPoint.passcode string
कॉन्फ़्रेंस में शामिल होने के लिए इस्तेमाल किया गया पासवर्ड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. सिर्फ़ वे फ़ील्ड मैच करें और दिखाएं जिनका इस्तेमाल कॉन्फ़्रेंस की सुविधा देने वाली कंपनी करती है.
entryPoint.password string
कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला पासवर्ड. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. सिर्फ़ वे फ़ील्ड मैच करें और दिखाएं जिनका इस्तेमाल कॉन्फ़्रेंस की सुविधा देने वाली कंपनी करती है.
entryPoint.pin string
कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया गया पिन. इसमें ज़्यादा से ज़्यादा 128 वर्ण हो सकते हैं. कॉन्फ़्रेंस की सुविधा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, {accessCode, meetingCode, passcode, password, pin} के सबसेट का ही इस्तेमाल करती हैं. सिर्फ़ वे फ़ील्ड मैच करें और दिखाएं जिनका इस्तेमाल कॉन्फ़्रेंस की सुविधा देने वाली कंपनी करती है.
entryPoint.regionCode string
फ़ोन नंबर का क्षेत्र कोड. अगर यूआरआई में देश का कोड शामिल नहीं है, तो उपयोगकर्ताओं को इसकी ज़रूरत होती है. वैल्यू, देश/इलाके के CLDR कोड की सार्वजनिक सूची के आधार पर तय की जाती हैं.
entryPoint.uri string
एंट्री पॉइंट का यूआरआई. ज़्यादा से ज़्यादा 1,300 वर्ण इस्तेमाल किए जा सकते हैं. फ़ॉर्मैटिंग, एंट्री पॉइंट के टाइप पर निर्भर करती है:
  • more: http: या https: स्कीमा ज़रूरी है.
  • phone: tel: स्कीमा ज़रूरी है. यूआरआई में, डायल करने का पूरा क्रम शामिल होना चाहिए. उदाहरण के लिए, "tel:+12345678900,,,12345678;1234".
  • sip: sip: या sips: स्कीमा ज़रूरी है. उदाहरण के लिए, "sip:12345678@myprovider.com".
  • video: http: या https: स्कीमा ज़रूरी है.

Drive इवेंट ऑब्जेक्ट

Drive इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के Google Drive और उसके कॉन्टेंट की जानकारी होती है. यह सिर्फ़ किसी इवेंट ऑब्जेक्ट में मौजूद होता है, अगर ऐड-ऑन Google Drive को एक्सटेंड करता है.

Drive इवेंट ऑब्जेक्ट
drive.activeCursorItem Drive item object
फ़िलहाल, Drive का यह आइटम चालू है.
drive.selectedItems[] list of Drive item objects
Drive में चुने गए आइटम (फ़ाइलें या फ़ोल्डर) की सूची.

Drive आइटम

Drive आइटम ऑब्जेक्ट में, Drive के खास आइटम की जानकारी होती है. जैसे, फ़ाइलें या फ़ोल्डर.

Drive आइटम ऑब्जेक्ट
item.addonHasFileScopePermission boolean
अगर true है, तो ऐड-ऑन ने इस आइटम के लिए https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे अनुमति मिल गई है. ऐसा न होने पर, यह फ़ील्ड false है.
item.id string
चुने गए आइटम का आईडी.
item.iconUrl string
चुने गए आइटम को दिखाने वाले आइकॉन का यूआरएल.
item.mimeType string
चुने गए आइटम का एमआईएमई टाइप.
item.title string
चुने गए आइटम का टाइटल.

Gmail इवेंट ऑब्जेक्ट

Gmail इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के Gmail मैसेज की जानकारी होती है. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब होस्ट ऐप्लिकेशन Gmail हो.

Gmail इवेंट ऑब्जेक्ट
gmail.accessToken string
Gmail के लिए ऐक्सेस टोकन. इस टोकन का इस्तेमाल GmailApp.setCurrentMessageAccessToken तरीके के साथ करें, ताकि आपके ऐड-ऑन को उपयोगकर्ता के मौजूदा Gmail मैसेज का कुछ समय के लिए ऐक्सेस मिल सके या आपका ऐड-ऑन नए ड्राफ़्ट बना सके.
gmail.bccRecipients[] list of strings
डिफ़ॉल्ट रूप से बंद है. "गुप्त कॉपी:" फ़ील्ड में मौजूद ईमेल पतों की सूची, जो फ़िलहाल उस ड्राफ़्ट में शामिल है जिसे ऐड-ऑन बना रहा है. इस फ़ील्ड को चालू करने के लिए, अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करें.
gmail.ccRecipients[] list of strings
डिफ़ॉल्ट रूप से बंद है. "कॉपी:" फ़ील्ड में मौजूद उन ईमेल पतों की सूची जिन्हें ऐड-ऑन की मदद से लिखे जा रहे ड्राफ़्ट में शामिल किया गया है. इस फ़ील्ड को चालू करने के लिए, अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करें.
gmail.messageId string
फ़िलहाल खुले हुए Gmail मैसेज का आईडी.
gmail.threadId string
फ़िलहाल खुले हुए Gmail थ्रेड का आईडी.
gmail.toRecipients[] list of strings
डिफ़ॉल्ट रूप से बंद है. "पाने वाला:" फ़ील्ड में मौजूद ईमेल पतों की सूची, जो फ़िलहाल उस ड्राफ़्ट में शामिल है जिसे ऐड-ऑन लिख रहा है. इस फ़ील्ड को चालू करने के लिए, अपने मेनिफ़ेस्ट में addOns.gmail.composeTrigger.draftAccess फ़ील्ड को METADATA पर सेट करें.

Docs इवेंट ऑब्जेक्ट

Docs इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह सिर्फ़ किसी इवेंट ऑब्जेक्ट में मौजूद होता है, अगर ऐड-ऑन Google Docs को एक्सटेंड करता है.

Docs इवेंट ऑब्जेक्ट
docs.id string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो.
Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ का आईडी.
docs.title string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो.
Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ का टाइटल.
docs.addonHasFileScopePermission boolean
अगर true, तो ऐड-ऑन ने Docs के यूज़र इंटरफ़ेस (यूआई) में खुले दस्तावेज़ के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है. ऐसा न होने पर, यह फ़ील्ड false है.
docs.matchedUrl.url string
यह सिर्फ़ तब मौजूद होता है, जब ये शर्तें पूरी हों:
  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

उस लिंक का यूआरएल जो Google Docs में झलक जनरेट करता है. इस फ़ील्ड का इस्तेमाल करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करना होगा. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तब के लिए पेलोड का उदाहरण: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Sheets इवेंट ऑब्जेक्ट

Sheets का इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह सिर्फ़ किसी इवेंट ऑब्जेक्ट में मौजूद होता है, अगर ऐड-ऑन Google Sheets को एक्सटेंड करता है.

Sheets इवेंट ऑब्जेक्ट
sheets.id string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Sheets के यूज़र इंटरफ़ेस (यूआई) में खुली हुई स्प्रेडशीट का आईडी.
sheets.title string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Sheets के यूज़र इंटरफ़ेस में खुली हुई स्प्रेडशीट का टाइटल.
sheets.addonHasFileScopePermission boolean
अगर true, तो ऐड-ऑन ने Sheets के यूज़र इंटरफ़ेस (यूआई) में खुली स्प्रेडशीट के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है. ऐसा न होने पर, यह फ़ील्ड false है.
sheets.matchedUrl.url string
यह सिर्फ़ तब मौजूद होता है, जब ये शर्तें पूरी हों:
  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

उस लिंक का यूआरएल जो Google Sheets में झलक जनरेट करता है. इस फ़ील्ड का इस्तेमाल करने के लिए, अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करें. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तब के लिए पेलोड का उदाहरण:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Slides इवेंट ऑब्जेक्ट

Slides इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट की जानकारी होती है. यह इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब ऐड-ऑन Google Slides को एक्सटेंड करता है.

Slides इवेंट ऑब्जेक्ट
slides.id string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन का आईडी.
slides.title string
यह सिर्फ़ तब मौजूद होता है, जब उपयोगकर्ता ने https://www.googleapis.com/auth/drive.file स्कोप को अनुमति दी हो. Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन का टाइटल.
slides.addonHasFileScopePermission boolean
अगर true, तो ऐड-ऑन ने Slides के यूज़र इंटरफ़ेस (यूआई) में खुले प्रज़ेंटेशन के लिए, https://www.googleapis.com/auth/drive.file स्कोप की अनुमति का अनुरोध किया है और उसे यह अनुमति मिल गई है; अगर ऐसा नहीं है, तो इस फ़ील्ड में false होगा.
slides.matchedUrl.url string
यह सिर्फ़ तब मौजूद होता है, जब ये शर्तें पूरी हों:
  • https://www.googleapis.com/auth/workspace.linkpreview को उपयोगकर्ता ने अनुमति दी है.
  • यूआरएल, LinkPreviewTriggers ट्रिगर में बताए गए होस्ट पैटर्न से मैच करता हो.

उस लिंक का यूआरएल जिसकी झलक Google Slides में जनरेट होती है. इस फ़ील्ड का इस्तेमाल करने के लिए, अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करें. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

जब कोई उपयोगकर्ता लिंक https://www.example.com/12345 की झलक देखता है, तब के लिए पेलोड का उदाहरण:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}