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

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

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

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

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

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

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

    • Gmail, उपयोगकर्ता के लिए कॉन्टेक्स्ट के हिसाब से ट्रिगर उपलब्ध कराता है. ऐसा तब होता है, जब उपयोगकर्ता कोई मैसेज खोलता है. इसके अलावा, एक और ट्रिगर तब उपलब्ध कराया जाता है, जब उपयोगकर्ता कोई मैसेज लिखता है.
    • Google Calendar, कॉन्टेक्स्ट के हिसाब से ट्रिगर उपलब्ध कराता है. इसका इस्तेमाल तब किया जाता है, जब कोई उपयोगकर्ता कोई इवेंट खोलता है.
    • Google Drive, कॉन्टेक्स्ट के हिसाब से ट्रिगर उपलब्ध कराता है. इसका इस्तेमाल तब किया जाता है, जब कोई उपयोगकर्ता Drive में मौजूद फ़ाइलें चुनता है.

    जब कॉन्टेक्स्ट के हिसाब से ट्रिगर फ़ायर होता है, तो होस्ट ऐप्लिकेशन, ऐड-ऑन मेनिफ़ेस्ट में शामिल 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 के ओरिजनल ऐड-ऑन के फ़ील्ड" सेक्शन में बताया गया है; इन फ़ील्ड में मौजूद जानकारी को नए ऑब्जेक्ट स्ट्रक्चर में फिर से बनाया जाता है.

इवेंट ऑब्जेक्ट
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 हो. स्लाइड की जानकारी देने वाला ऑब्जेक्ट.
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: a DateTimeInput object.

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

  • A date-only picker: a DateInput object.

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

  • A time-only picker: a 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.user object (User)
Chat ऐप्लिकेशन का इस्तेमाल करने वाला वह व्यक्ति जिसने Chat ऐप्लिकेशन से इंटरैक्ट किया है.
chat.space object (Space)
वह Chat स्पेस जहां उपयोगकर्ता ने Chat ऐप्लिकेशन के साथ इंटरैक्ट किया था.
chat.eventTime

string (Timestamp format)

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

यूनियन फ़ील्ड payload.

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

object (MessagePayload)

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

object (AddedToSpacePayload)

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

object (RemovedFromSpacePayload)

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

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

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

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

chat.appCommandPayload

object (AppCommandPayload)

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

पेलोड

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

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

स्पेस के पेलोड में जोड़ा गया
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
वह Chat स्पेस जिसमें उपयोगकर्ता ने Chat ऐप्लिकेशन जोड़ा या इंस्टॉल किया है.

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

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

स्पेस के पेलोड से हटा दिया गया
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
वह Chat स्पेस जहां से उपयोगकर्ता ने 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.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 मेन्यू से कमांड चुनता है.

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

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

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

कैलेंडर इवेंट ऑब्जेक्ट
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 के इवेंट में शामिल लोगों की जानकारी होती है. यह जानकारी इवेंट ऑब्जेक्ट में तब ही मौजूद होती है, जब Calendar इवेंट में डेटा मौजूद हो और ऐड-ऑन, addOns.calendar.currentEventAccess manifest फ़ील्ड को READ या READ_WRITE पर सेट करता हो.

मीटिंग में हिस्सा लेने वाले व्यक्ति का ऑब्जेक्ट
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 manifest फ़ील्ड को 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 for consumers के लिए (http://hangouts.google.com).
  • eventNamedHangout Google Workspace का इस्तेमाल करने वाले लोगों के लिए, Hangouts का क्लासिक वर्शन (http://hangouts.google.com).
  • hangoutsMeet for Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
इस कॉन्फ़्रेंस सेवा का नाम, जो उपयोगकर्ता को दिखता है. यह नाम स्थानीय भाषा में नहीं होता.
conferenceData.entryPoints[] list of entry point objects
कॉन्फ़्रेंस में शामिल होने के एंट्री पॉइंट की सूची, जैसे कि यूआरएल या फ़ोन नंबर.
conferenceData.notes string
कॉन्फ़्रेंस के बारे में अतिरिक्त नोट (जैसे, डोमेन एडमिन के निर्देश या कानूनी नोटिस), ताकि उपयोगकर्ता को दिखाया जा सके. इसमें एचटीएमएल शामिल किया जा सकता है. इसमें ज़्यादा से ज़्यादा 2,048 वर्ण इस्तेमाल किए जा सकते हैं.
conferenceData.parameters object
यह एक ऐसा ऑब्जेक्ट है जिसमें ऐड-ऑन के इस्तेमाल के लिए, तय किए गए पैरामीटर डेटा का मैप होता है.
conferenceData.parameters.addOnParameters object
पैरामीटर स्ट्रिंग की और वैल्यू का मैप. इन कुंजियों और वैल्यू को ऐड-ऑन डेवलपर तय करता है, ताकि ऐड-ऑन के इस्तेमाल के लिए किसी कॉन्फ़्रेंस से जानकारी जोड़ी जा सके.

आने की जगह

एंट्री पॉइंट ऑब्जेक्ट में, किसी कॉन्फ़्रेंस को ऐक्सेस करने के लिए उपलब्ध तरीकों के बारे में जानकारी होती है. जैसे, फ़ोन या वीडियो के ज़रिए कॉन्फ़्रेंस में शामिल होना. यह जानकारी इवेंट ऑब्जेक्ट में तब और सिर्फ़ तब मौजूद होती है, जब डेटा Calendar इवेंट में मौजूद हो और ऐड-ऑन, addOns.calendar.currentEventAccess manifest फ़ील्ड को 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
चुने गए आइटम का MIME टाइप.
item.title string
चुने गए आइटम का टाइटल.

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

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

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