इस पेज पर, Google Workspace ऐड-ऑन के इवेंट ऑब्जेक्ट के बारे में जानकारी दी गई है.
इवेंट ऑब्जेक्ट, JSON स्ट्रक्चर होते हैं. जब कोई उपयोगकर्ता किसी ऐड-ऑन के साथ इंटरैक्ट करता है, तो ये अपने-आप बन जाते हैं और ट्रिगर या कॉलबैक फ़ंक्शन के पैरामीटर के तौर पर पास हो जाते हैं. इवेंट ऑब्जेक्ट में होस्ट ऐप्लिकेशन और मौजूदा संदर्भ को ऐड-ऑन के सर्वर-साइड कॉलबैक फ़ंक्शन के साथ जोड़ा जाना चाहिए.
Google Workspace के ऐड-ऑन, इवेंट ऑब्जेक्ट का इस्तेमाल यहां करते हैं:
होम पेज ट्रिगर. होम पेज ट्रिगर फ़ंक्शन ट्रिगर होने पर, आपके तय किए गए हर
homepageTrigger
फ़ंक्शन को अपने-आप एक इवेंट ऑब्जेक्ट पास किया जाता है. इस ऑब्जेक्ट का इस्तेमाल इसमें किया जा सकता है आपका होम पेज ट्रिगर करने वाला फ़ंक्शन होता है, जिससे सक्रिय होस्ट ऐप्लिकेशन, क्लाइंट के प्लैटफ़ॉर्म, उपयोगकर्ता की स्थान-भाषा, और अन्य जानकारी शामिल होती है.होम पेज के ट्रिगर होने पर बनाए गए इवेंट ऑब्जेक्ट में, दूसरे दो मामलों में शामिल सभी फ़ील्ड शामिल नहीं होते. विजेट और संदर्भ से जुड़ी जानकारी वाले फ़ील्ड को हटा दिया जाता है.
कॉन्टेक्स्ट ट्रिगर. हर होस्ट ऐप्लिकेशन, संदर्भ के हिसाब से ट्रिगर का एक अलग सेट उपलब्ध कराता है. जब उपयोगकर्ता किसी खास संदर्भ में जाता है, तो ट्रिगर सक्रिय हो जाता है. उदाहरण के लिए:
- जब कोई उपयोगकर्ता एक मैसेज खुलता है दूसरा, जब कोई उपयोगकर्ता मैसेज लिखें.
- जब कोई उपयोगकर्ता कोई इवेंट खोलता है.
- जब कोई उपयोगकर्ता Drive की फ़ाइलें चुनी जाती है.
जब कोई प्रासंगिक ट्रिगर सक्रिय होता है, तो होस्ट ऐप्लिकेशन संबंधित
runFunction
को ऐड-ऑन मेनिफ़ेस्ट में शामिल किया गया है. साथ ही, इसे पास किया जा रहा है पैरामीटर के रूप में इवेंट ऑब्जेक्ट. संदर्भ के हिसाब से ट्रिगर होने पर बनाए गए इवेंट ऑब्जेक्ट में, होम पेज ट्रिगर इवेंट ऑब्जेक्ट में शामिल सभी फ़ील्ड के साथ-साथ, संदर्भ के हिसाब से जानकारी वाले फ़ील्ड भी शामिल होते हैं.विजेट की कार्रवाइयां. इवेंट ऑब्जेक्ट विजेट का इस्तेमाल करने के लिए भी इस्तेमाल किया जाता है इंटरैक्ट करते हुए, वह ऐक्शन मॉडल जिसे Gmail ऐड-ऑन के तौर पर उपलब्ध कराया गया है इस्तेमाल करें. Google Workspace के ऐड-ऑन, विजेट हैंडलर के सभी फ़ंक्शन,
Action
ऑब्जेक्ट, और ऐक्शन रिस्पॉन्स का इस्तेमाल करते हैं. हालांकि, Google Workspace ऐड-ऑन में, ऐक्शन इवेंट ऑब्जेक्ट में ज़्यादा जानकारी शामिल होती है. इस जानकारी के आधार पर कॉलबैक फ़ंक्शन काम कर सकता है.विजेट की कार्रवाइयों के नतीजे के तौर पर बने इवेंट ऑब्जेक्ट में कॉन्टेक्स्चुअल ट्रिगर इवेंट ऑब्जेक्ट में शामिल फ़ील्ड. साथ ही, फ़ील्ड में ये शामिल हैं विजेट की जानकारी.
लिंक ट्रिगर की झलक देखें. Google Docs, Sheets, और Slides में, यूआरएल के खास पैटर्न के आधार पर, तीसरे पक्ष की सेवाओं के लिए लिंक की झलक को कॉन्फ़िगर किया जा सकता है. जब उपयोगकर्ता किसी ऐसे लिंक से इंटरैक्ट करते हैं जो पैटर्न,
linkPreviewTriggers
सक्रिय होता है और लिंक वाला एक इवेंट ऑब्जेक्ट, ट्रिगर को भेज दिया जाता है कॉलबैक फ़ंक्शन. आपका ऐड-ऑन इस इवेंट ऑब्जेक्ट का इस्तेमाल स्मार्ट चिप और कार्ड, जो होस्ट में मौजूद लिंक के बारे में जानकारी दिखाता है का इस्तेमाल करें. उपयोगकर्ताओं को झलक वाले कार्ड और उसके कॉन्टेंट के साथ इंटरैक्ट करने की सुविधा देने के लिए, विजेट ऐक्शन भी बनाए जा सकते हैं.
इवेंट ऑब्जेक्ट का स्ट्रक्चर
नीचे दी गई टेबल में, 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.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
Action.setParameters() का इस्तेमाल करके,
Action को दिए गए अन्य सभी पैरामीटर.
|
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 . इस फ़ील्ड को चालू करने के लिए, आपको इसे सेट करना होगा
आपके ऐड-ऑन की मेनिफ़ेस्ट फ़ाइल में, true के लिए addOns.common.useLocaleFromApp .
आपके ऐड-ऑन की दायरे की सूची में,
https://www.googleapis.com/auth/script.locale . ज़्यादा जानकारी के लिए,
उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन को ऐक्सेस करना देखें.
|
commonEventObject.timeZone.offset |
string इस उपयोगकर्ता के कोऑर्डिनेटेड यूनिवर्सल टाइम (यूटीसी) से समय ऑफ़सेट समय क्षेत्र, मिलीसेकंड में मापा जाता है. यहां जाएं: ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थान-भाषा और टाइमज़ोन को ऐक्सेस किया जा रहा है. |
तारीख और समय चुनने वाले टूल की सुविधा वाले फ़ॉर्म के इनपुट
ऐक्शन कॉलबैक फ़ंक्शन
commonEventObject.formInputs
फ़ील्ड में मौजूदा विजेट वैल्यू पा सकता है.
इसमें तारीख या समय चुनने वाले विजेट में, उपयोगकर्ता की चुनी गई तारीख या समय की वैल्यू शामिल होती हैं.
हालांकि, जानकारी की संरचना इस आधार पर अलग-अलग होती है कि
विजेट को तारीख और समय चुनने वाले टूल, सिर्फ़ तारीख चुनने वाले टूल या सिर्फ़ समय चुनने वाले टूल के तौर पर कॉन्फ़िगर किया गया
पिकर. स्ट्रक्चर में अंतर के बारे में नीचे दी गई टेबल में बताया गया है:
Calendar इवेंट ऑब्जेक्ट
Calendar इवेंट ऑब्जेक्ट, इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के कैलेंडर और कैलेंडर इवेंट की जानकारी होती है. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब होस्ट ऐप्लिकेशन Google Calendar हो.
इस टेबल में, किसी इवेंट ऑब्जेक्ट के calendarEventObject
फ़ील्ड में मौजूद फ़ील्ड की सूची दी गई है. यूज़र जनरेटेड डेटा के तौर पर मार्क किए गए फ़ील्ड
इवेंट ऑब्जेक्ट में तभी मौजूद होता है, जब कैलेंडर में डेटा मौजूद हो
इवेंट और ऐड-ऑन अपने addOns.calendar.currentEventAccess
को सेट करता है
मेनिफ़ेस्ट
फ़ील्ड से
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
मेनिफ़ेस्ट
फ़ील्ड को 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 अगर यह मेहमान इस इवेंट से जुड़ा है
वह कैलेंडर जिसमें यह इवेंट दिखता है; अगर ऐसा नहीं है, तो false .
|
कॉन्फ़्रेंस का डेटा
कॉन्फ़्रेंस डेटा ऑब्जेक्ट में, Google Calendar इवेंट से जुड़ी कॉन्फ़्रेंस की जानकारी होती है. ये Google कॉन्फ़्रेंस समाधान हो सकते हैं, जैसे
Google Meet या तीसरे पक्ष की कॉन्फ़्रेंस. यह जानकारी इसमें मौजूद है:
इवेंट ऑब्जेक्ट सिर्फ़ तभी होता है, जब कैलेंडर इवेंट में डेटा मौजूद होता है और
ऐड-ऑन, अपने 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 कॉन्फ़्रेंस समाधान किस तरह का है. संभावित वैल्यू निम्नलिखित शामिल करें:
|
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 एंट्री पॉइंट पर लागू होती हैं:
|
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.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 इवेंट ऑब्जेक्ट
दस्तावेज़ इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट के बारे में जानकारी. यह सिर्फ़ तब किसी इवेंट ऑब्जेक्ट में मौजूद होता है, जब होस्ट ऐप्लिकेशन 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 , ऐड-ऑन ने अनुरोध किया है
और https://www.googleapis.com/auth/drive.file मिले
प्रज़ेंटेशन के लिए स्कोप की अनुमति, Slides के यूज़र इंटरफ़ेस (यूआई) में खुलती है; अन्य मामलों में
यह फ़ील्ड false है.
|
slides.matchedUrl.url |
string
सिर्फ़ इन शर्तों के पूरा होने पर दिखाएं:
उस लिंक का यूआरएल जो Google Slides में झलक जनरेट करता है. इस फ़ील्ड का इस्तेमाल करने के लिए, आपको अपने ऐड-ऑन के मेनिफ़ेस्ट में LinkPreviewTriggers को कॉन्फ़िगर करना होगा.
ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.
जब कोई उपयोगकर्ता लिंक "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |