इस पेज पर, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट के स्ट्रक्चर के बारे में बताया गया है.
इवेंट ऑब्जेक्ट, JSON स्ट्रक्चर होते हैं. जब कोई उपयोगकर्ता किसी ऐड-ऑन के साथ इंटरैक्ट करता है, तो ये अपने-आप बन जाते हैं और ट्रिगर या कॉलबैक फ़ंक्शन के पैरामीटर के तौर पर पास हो जाते हैं. इवेंट ऑब्जेक्ट, होस्ट ऐप्लिकेशन और मौजूदा कॉन्टेक्स्ट के बारे में क्लाइंट-साइड की जानकारी को, ऐड-ऑन के सर्वर-साइड कॉलबैक फ़ंक्शन में ले जाते हैं.
Google Workspace के ऐड-ऑन, इवेंट ऑब्जेक्ट का इस्तेमाल इन जगहों पर करते हैं:
होम पेज ट्रिगर. होम पेज ट्रिगर फ़ंक्शन ट्रिगर होने पर, आपके तय किए गए हर
homepageTrigger
फ़ंक्शन को अपने-आप एक इवेंट ऑब्जेक्ट पास किया जाता है. इस ऑब्जेक्ट का इस्तेमाल, अपने होम पेज के ट्रिगर फ़ंक्शन में किया जा सकता है. इससे, ऐक्टिव होस्ट ऐप्लिकेशन, क्लाइंट के प्लैटफ़ॉर्म, उपयोगकर्ता की स्थानीय भाषा, और अन्य जानकारी की पहचान की जा सकती है.होम पेज के ट्रिगर होने पर बनाए गए इवेंट ऑब्जेक्ट में, दूसरे दो मामलों में शामिल सभी फ़ील्ड शामिल नहीं होते. विजेट और संदर्भ से जुड़ी जानकारी वाले फ़ील्ड को हटा दिया जाता है.
कॉन्टेक्स्ट के हिसाब से ट्रिगर. हर होस्ट ऐप्लिकेशन, संदर्भ के हिसाब से ट्रिगर का एक अलग सेट उपलब्ध कराता है. ये ट्रिगर तब ट्रिगर होते हैं, जब उपयोगकर्ता किसी खास संदर्भ में काम करता है. उदाहरण के लिए:
- Gmail, उपयोगकर्ता के मैसेज खोलने और मैसेज लिखने पर, कॉन्टेक्स्ट के हिसाब से ट्रिगर उपलब्ध कराता है.
- जब कोई उपयोगकर्ता कोई इवेंट खोलता है, तो Google Calendar, संदर्भ के हिसाब से ट्रिगर उपलब्ध कराता है.
- जब कोई उपयोगकर्ता Drive की फ़ाइलें चुनता है, तब Google 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.messageMetadata.messageId |
string अब काम नहीं करता. थ्रेड का मैसेज आईडी, Gmail के यूज़र इंटरफ़ेस में खुलेगा.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.clientPlatform |
string अब काम नहीं करता. इससे पता चलता है कि इवेंट कहां से शुरू हुआ (वेब, iOS या Android).
Google Workspace के ऐड-ऑन के लिए, यह जानकारी
|
eventObject.formInput |
object अब काम नहीं करता. कार्ड में मौजूद सभी फ़ॉर्म विजेट की मौजूदा वैल्यू का मैप. इसमें हर विजेट के लिए एक वैल्यू ही दिखती है. इसमें, की वैल्यू, विजेट से जुड़े स्ट्रिंग आईडी होती हैं और वैल्यू, स्ट्रिंग होती हैं. इवेंट ऑब्जेक्ट, formInput को एक सुविधा के तौर पर उपलब्ध कराता है. ऐसा तब किया जाता है, जब आपको टेक्स्ट इनपुट और स्विच जैसी एकल वैल्यू वाले कई विजेट से डेटा पढ़ना हो. चेकबॉक्स जैसे कई वैल्यू वाले विजेट के लिए, formInputs से हर वैल्यू को पढ़ा जा सकता है.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.formInputs |
object अब काम नहीं करता. कार्ड में मौजूद विजेट की मौजूदा वैल्यू का मैप, जो स्ट्रिंग की सूचियों के तौर पर दिखाया जाता है. कुंजियां, विजेट से जुड़े स्ट्रिंग आईडी होती हैं. एक वैल्यू वाले विजेट के लिए, वैल्यू को एक एलिमेंट वाले ऐरे में दिखाया जाता है. कई वैल्यू वाले विजेट के लिए, सभी वैल्यू एक सूची में दिखाई जाती हैं. जैसे, चेकबॉक्स ग्रुप.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.parameters |
object अब काम नहीं करता. Action.setParameters() का इस्तेमाल करके,
Action को दिए गए अन्य सभी पैरामीटर का मैप. मैप की की और वैल्यू,
स्ट्रिंग होती हैं.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.userCountry |
string अब इस्तेमाल नहीं किया जा सकता और यह डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के देश या इलाके का पता चलने वाला, दो अक्षर का कोड. यह संख्या वाला भी हो सकता है UN M49 देश कोड.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.userLocale |
string अब इस्तेमाल नहीं किया जा सकता और यह डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता की भाषा बताने वाला, दो अक्षरों वाला ISO 639 कोड. ज़्यादा जानकारी के लिए, उपयोगकर्ता के भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.userTimezone.id |
string अब इस्तेमाल नहीं किया जा सकता और यह डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के टाइमज़ोन का टाइमज़ोन आइडेंटिफ़ायर. उदाहरण के लिए: America/New_York , Europe/Vienna , और
Asia/Seoul . ज़्यादा जानकारी के लिए,
उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना देखें.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
eventObject.userTimezone.offset |
string अब इस्तेमाल नहीं किया जा सकता और यह डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता के टाइमज़ोन का कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से समय ऑफ़सेट, जिसे मिलीसेकंड में मेज़र किया जाता है. ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना लेख पढ़ें.
Google Workspace के ऐड-ऑन के लिए, यह जानकारी |
सामान्य इवेंट ऑब्जेक्ट
सामान्य इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जो उपयोगकर्ता के क्लाइंट से, ऐड-ऑन में सामान्य और होस्ट से स्वतंत्र जानकारी देता है. इस जानकारी में, उपयोगकर्ता की स्थानीय भाषा, होस्ट ऐप्लिकेशन, और प्लैटफ़ॉर्म जैसी जानकारी शामिल होती है.
होम पेज और काम के हिसाब से ट्रिगर के अलावा, जब उपयोगकर्ता विजेट से इंटरैक्ट करता है, तो ऐड-ऑन ऐक्शन कॉलबैक फ़ंक्शन को इवेंट ऑब्जेक्ट बनाकर पास करते हैं. आपके ऐड-ऑन का कॉलबैक फ़ंक्शन, उपयोगकर्ता के क्लाइंट में खुले विजेट के कॉन्टेंट का पता लगाने के लिए, सामान्य इवेंट ऑब्जेक्ट से क्वेरी कर सकता है. उदाहरण के लिए, आपका ऐड-ऑन, eventObject.commentEventObject.formInputs
ऑब्जेक्ट में उस टेक्स्ट का पता लगा सकता है जिसे उपयोगकर्ता ने TextInput
विजेट में डाला है.
इवेंट ऑब्जेक्ट के सामान्य फ़ील्ड | |
---|---|
commonEventObject.platform |
string इससे पता चलता है कि इवेंट कहां से शुरू हुआ है (`वेब`, `iOS` या `Android`). |
commonEventObject.formInputs |
object एक मैप, जिसमें दिखाए गए कार्ड में मौजूद विजेट की मौजूदा वैल्यू होती हैं. मैप की कुंजियां, हर विजेट के साथ असाइन किए गए स्ट्रिंग आईडी होती हैं. मैप वैल्यू ऑब्जेक्ट का स्ट्रक्चर, विजेट के टाइप पर निर्भर करता है:
|
commonEventObject.hostApp |
string इससे उस होस्ट ऐप्लिकेशन के बारे में पता चलता है जिसमें इवेंट ऑब्जेक्ट जनरेट होने पर, ऐड-ऑन चालू होता है. ये वैल्यू हो सकती हैं:
|
commonEventObject.parameters |
object actionParameters या
Action.setParameters() का इस्तेमाल करके, किसी कार्रवाई के लिए दिए गए अतिरिक्त पैरामीटर.
डेवलपर के लिए झलक: Google Chat को बेहतर बनाने वाले ऐड-ऑन के लिए, |
commonEventObject.userLocale |
string डिफ़ॉल्ट रूप से बंद है. उपयोगकर्ता की भाषा और देश/इलाके का आइडेंटिफ़ायर, ISO 639 भाषा कोड-ISO 3166 देश/इलाके के कोड के फ़ॉर्मैट में. उदाहरण के लिए, en-US .
इस फ़ील्ड को चालू करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में |
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
फ़ील्ड में मौजूद विजेट की मौजूदा वैल्यू मिल सकती हैं.
इसमें तारीख या समय चुनने वाले विजेट में, उपयोगकर्ता की चुनी गई तारीख या समय की वैल्यू शामिल होती हैं.
हालांकि, जानकारी का स्ट्रक्चर अलग-अलग होता है. यह इस बात पर निर्भर करता है कि विजेट को तारीख-समय चुनने वाले टूल, सिर्फ़ तारीख चुनने वाले टूल या सिर्फ़ समय चुनने वाले टूल के तौर पर कॉन्फ़िगर किया गया था या नहीं. स्ट्रक्चर में अंतर के बारे में नीचे दी गई टेबल में बताया गया है:
Calendar इवेंट ऑब्जेक्ट
Calendar इवेंट ऑब्जेक्ट, इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के कैलेंडर और कैलेंडर इवेंट की जानकारी होती है. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब होस्ट ऐप्लिकेशन Google Calendar हो.
इस टेबल में, किसी इवेंट ऑब्जेक्ट के calendarEventObject
फ़ील्ड में मौजूद फ़ील्ड की सूची दी गई है. उपयोगकर्ता से जनरेट किया गया डेटा के तौर पर मार्क किए गए फ़ील्ड, इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होते हैं, जब Calendar इवेंट में डेटा मौजूद हो और ऐड-ऑन अपने addOns.calendar.currentEventAccess
manifest फ़ील्ड को READ
या READ_WRITE
पर सेट करता हो.
Calendar इवेंट ऑब्जेक्ट | |
---|---|
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 मीटिंग में शामिल व्यक्ति के जवाब की स्थिति. ये वैल्यू हो सकती हैं:
|
attendee.self |
boolean true अगर यह व्यक्ति उस कैलेंडर से जुड़ा है जिसमें यह इवेंट दिखता है, तो 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 कॉन्फ़्रेंस के लिए इस्तेमाल किया जाने वाला सलूशन. ये वैल्यू हो सकती हैं:
|
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
manifest
फ़ील्ड को READ
या READ_WRITE
पर सेट करता हो.
एंट्री पॉइंट ऑब्जेक्ट | |
---|---|
entryPoint.accessCode |
string कॉन्फ़्रेंस को ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला ऐक्सेस कोड. इसमें 128 से ज़्यादा वर्ण नहीं हो सकते. कॉन्फ़्रेंस की सेवा देने वाली कंपनियां, आम तौर पर कॉन्फ़्रेंस का ऐक्सेस देने के लिए, { accessCode , meetingCode ,
passcode , password , pin } के सिर्फ़ सबसेट का इस्तेमाल करती हैं. सिर्फ़ उन फ़ील्ड को मैच करें और दिखाएं जिनका इस्तेमाल, कॉन्फ़्रेंस की सेवा देने वाली कंपनी करती है.
|
entryPoint.entryPointFeatures |
list एंट्री पॉइंट की सुविधाएं. फ़िलहाल, ये सुविधाएं सिर्फ़ phone एंट्री पॉइंट पर लागू होती हैं:
|
entryPoint.entryPointType |
string एंट्री पॉइंट का टाइप. ये वैल्यू इस्तेमाल की जा सकती हैं:
|
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 वर्ण इस्तेमाल किए जा सकते हैं. फ़ॉर्मैटिंग, एंट्री पॉइंट के टाइप पर निर्भर करती है:
|
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 डिफ़ॉल्ट रूप से बंद है. "गुप्त कॉपी" पाने वाले लोगों के ईमेल पतों की सूची. फ़िलहाल, यह सूची उस ड्राफ़्ट में शामिल है जिसे ऐड-ऑन लिख रहा है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में 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
सिर्फ़ इन शर्तों के पूरा होने पर दिखाएं:
Google Docs में झलक जनरेट करने वाले लिंक का यूआरएल. इस फ़ील्ड का इस्तेमाल करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करना होगा. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.
जब कोई उपयोगकर्ता लिंक की झलक देखता है, तब पैकेज का उदाहरण "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
सिर्फ़ इन शर्तों के पूरा होने पर दिखाएं:
Google Sheets में झलक जनरेट करने वाले लिंक का यूआरएल. इस फ़ील्ड का इस्तेमाल करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करना होगा. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.
जब कोई उपयोगकर्ता लिंक की झलक देखता है, तो पैकेज का उदाहरण "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
सिर्फ़ इन शर्तों के पूरा होने पर दिखाएं:
Google Slides में झलक जनरेट करने वाले लिंक का यूआरएल. इस फ़ील्ड का इस्तेमाल करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करना होगा.
ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.
जब कोई उपयोगकर्ता लिंक की झलक देखता है, तो पैकेज का उदाहरण "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |