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

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

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

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

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

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

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

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

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

इस पेज पर, Google Workspace ऐड-ऑन इवेंट की ऑब्जेक्ट की नई बनावट की जानकारी दी गई है.

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

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

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

इवेंट ऑब्जेक्ट
eventObject.commonEventObject Common fields object
ऐसा ऑब्जेक्ट जिसमें सभी इवेंट ऑब्जेक्ट की जानकारी शामिल होती है, भले ही होस्ट ऐप्लिकेशन कुछ भी हो.
eventObject.calendar Calendar event object
सिर्फ़ तब कॉल करें, जब कॉल करने वाला होस्ट Google Calendar हो. ऑब्जेक्ट जिसमें कैलेंडर और इवेंट की जानकारी शामिल होती है.
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 फ़ील्ड में यह जानकारी देखें.

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

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

होम पेज और संदर्भ के हिसाब से ट्रिगर के अलावा, ऐड-ऑन बनाने और इवेंट ऑब्जेक्ट को ऐक्शन कॉलबैक फ़ंक्शन पर भेजने की सुविधा देता है. ऐसा तब होता है, जब उपयोगकर्ता विजेट से इंटरैक्ट करता है. आपका ऐड-ऑन's कॉलबैक फ़ंक्शन, उपयोगकर्ता के खुले विजेट की सामग्री का पता लगाने के लिए सामान्य इवेंट ऑब्जेक्ट की क्वेरी कर सकता है. उदाहरण के लिए, आपका ऐड-ऑन, उपयोगकर्ता के डाले गए टेक्स्ट का पता 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
कोई भी और पैरामीटर, जिसे आप Action.setParameters() का इस्तेमाल करके Action को उपलब्ध कराते हैं.
commonEventObject.userLocale string
डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता और देश/इलाके की पहचान करने वाले की जानकारी, ISO 639 भाषा कोड-ISO 3166 देश/इलाके के फ़ॉर्मैट में. उदाहरण के लिए, en-US.

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

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

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

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

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

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

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

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

आने की जगह

एंट्री पॉइंट ऑब्जेक्ट, दिए गए कॉन्फ़्रेंस को ऐक्सेस करने के उपलब्ध तरीकों के बारे में जानकारी देते हैं, जैसे कि फ़ोन या वीडियो से. यह जानकारी इवेंट ऑब्जेक्ट में तब ही मौजूद होती है, जब कैलेंडर डेटा में डेटा मौजूद हो और ऐड-ऑन अपने 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 पर कॉन्फ़्रेंस में शामिल हों. एक कॉन्फ़्रेंस में ज़्यादा से ज़्यादा एक 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
फ़ोन नंबर का एरिया कोड. उपयोगकर्ताओं के लिए ज़रूरी है, अगर यूआरआई में देश का कोड शामिल न हो. वैल्यू, क्षेत्र के कोड की सार्वजनिक सीएलडीआर सूची पर आधारित होती हैं.
entryPoint.uri string
एंट्री पॉइंट का यूआरआई. ज़्यादा से ज़्यादा 1,300 वर्ण इस्तेमाल किए जा सकते हैं. फ़ॉर्मैट, एंट्री पॉइंट के टाइप के हिसाब से तय होता है:
  • more: http: या https: स्कीमा ज़रूरी है.
  • phone: tel: स्कीमा ज़रूरी है. यूआरआई में डायल करने का पूरा क्रम शामिल होना चाहिए (उदाहरण के लिए, "tel:+12345678900,,12345678;1234").
  • sip: sip: या sips: स्कीमा ज़रूरी है. उदाहरण के लिए, "sip:12345678@myprovider.com".
  • video: http: या https: स्कीमा ज़रूरी है.

'डिस्क' इवेंट ऑब्जेक्ट

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

'डिस्क' इवेंट ऑब्जेक्ट
drive.activeCursorItem Drive item object
Drive का आइटम अभी चालू है.
drive.selectedItems[] list of Drive item objects
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:" पाने वाले ईमेल पतों की सूची, जो अभी ऐड-ऑन के ड्राफ़्ट में शामिल है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में `addDatas` में `addOns.gmail.compauseTrigger.ड्राफ़्टAccess` फ़ील्ड सेट करना होगा.
gmail.ccRecipients[] list of strings
डिफ़ॉल्ट रूप से बंद है. "CC:" पाने वाले ईमेल पतों की सूची जो अभी ऐड-ऑन के ड्राफ़्ट में शामिल है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में `addDatas` में `addOns.gmail.compauseTrigger.ड्राफ़्टAccess` फ़ील्ड सेट करना होगा.
gmail.messageId string
फ़िलहाल खुले हुए Gmail मैसेज का आईडी.
gmail.threadId string
फ़िलहाल, Gmail थ्रेड आईडी खुला हुआ है.
gmail.toRecipients[] list of strings
डिफ़ॉल्ट रूप से बंद है. फ़िलहाल, "To:" पाने वाले के ईमेल पतों की सूची, जिसे ऐड-ऑन के ड्राफ़्ट में शामिल किया गया है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में `addDatas` में `addOns.gmail.compauseTrigger.ड्राफ़्टAccess` फ़ील्ड सेट करना होगा.

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.addonHasFileScopePermission boolean
अगर true ने ऐड-ऑन के लिए अनुरोध किया है, तो उसे 'दस्तावेज़' के यूज़र इंटरफ़ेस (यूआई) पर उपलब्ध दस्तावेज़ के लिए https://www.googleapis.com/auth/drive.file स्कोप ऑथराइज़ेशन की अनुमति मिल गई है. अगर ऐसा नहीं है, तो इस फ़ील्ड में false का इस्तेमाल करें.

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 यूज़र इंटरफ़ेस (यूआई) में खुलता है.
sheets.addonHasFileScopePermission boolean
अगर true है, तो ऐड-ऑन ने Sheets यूज़र इंटरफ़ेस (यूआई) में स्प्रेडशीट खोलने का अनुरोध किया है और https://www.googleapis.com/auth/drive.file इसके लिए अनुमति मिली है; या false.

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.addonHasFileScopePermission boolean
अगर true है, तो ऐड-ऑन ने प्रज़ेंटेशन के लिए अनुरोध किया है और https://www.googleapis.com/auth/drive.file Slides के यूज़र इंटरफ़ेस (यूआई) में प्रज़ेंटेशन के लिए अनुमति देने का अनुरोध किया है. अगर ऐसा नहीं है, तो यह फ़ील्ड false है.