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

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

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

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

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

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

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

    जब कोई कॉन्टेक्स्चुअल ट्रिगर फ़ायर होता है, तो होस्ट ऐप्लिकेशन, ऐड-ऑन मेनिफ़ेस्ट में बताए गए 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 हो. एक ऑब्जेक्ट, जिसमें शीट की जानकारी होती है.
eventObject.slides Slides event object
सिर्फ़ तब प्रज़ेंट करें, जब कॉल करने वाला होस्ट Google Slides हो. एक ऑब्जेक्ट, जिसमें Slides की जानकारी होती है.
Gmail ऐड-ऑन के मूल फ़ील्ड
eventObject.messageMetadata.accessToken string
अब काम नहीं करता. ऐक्सेस टोकन. इसका इस्तेमाल करके, कुछ समय के लिए रहने वाले Gmail ऐड-ऑन दायरों का इस्तेमाल करके, उपयोगकर्ता के डेटा का ऐक्सेस चालू किया जा सकता है.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • A date-time picker: a DateTimeInput object.

    उदाहरण: myDTPicker आईडी वाले पिकर के लिए, e.commonEventObject.formInputs.myDTPicker.dateTimeInput का इस्तेमाल करके 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
Action.setParameters() का इस्तेमाल करके Action को दिया गया कोई अतिरिक्त पैरामीटर.
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 फ़ील्ड में मौजूदा विजेट वैल्यू मिल सकती हैं. इसमें तारीख या समय पिकर विजेट में, उपयोगकर्ता की चुनी गई तारीख या समय की वैल्यू शामिल हैं. हालांकि, जानकारी का स्ट्रक्चर इस बात पर निर्भर करता है कि विजेट को तारीख-समय पिकर के तौर पर कॉन्फ़िगर किया गया है या सिर्फ़ तारीख चुनने वाले टूल के तौर पर या सिर्फ़ समय चुनने वाले टूल के तौर पर. इन टेबल में इन स्ट्रक्चर के अंतर के बारे में बताया गया है:

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

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

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

नीचे दी गई टेबल में, किसी इवेंट ऑब्जेक्ट के calendarEventObject फ़ील्ड में मौजूद फ़ील्ड की सूची दी गई है. उपयोगकर्ता का जनरेट किया गया डेटा के तौर पर मार्क किए गए फ़ील्ड, इवेंट ऑब्जेक्ट में तब मौजूद होते हैं, जब डेटा, Calendar इवेंट में मौजूद हो और ऐड-ऑन अपने 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
फ़ोन नंबर का क्षेत्रीय कोड. अगर यूआरआई में देश का कोड शामिल नहीं है, तो उपयोगकर्ताओं को इसकी ज़रूरत होती है. ये वैल्यू, इलाके के कोड की सार्वजनिक 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
डिफ़ॉल्ट रूप से बंद. "सीसी:" पाने वालों के ईमेल पतों की सूची. फ़िलहाल, इस ड्राफ़्ट में ऐड-ऑन शामिल है. इस फ़ील्ड को चालू करने के लिए, आपको अपने मेनिफ़ेस्ट में 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
सिर्फ़ तब मौजूद होती है, जब इन शर्तों को पूरा किया गया हो:
  • 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 इवेंट ऑब्जेक्ट

शीट इवेंट ऑब्जेक्ट, पूरे इवेंट ऑब्जेक्ट का वह हिस्सा होता है जिसमें उपयोगकर्ता के दस्तावेज़ और उसके कॉन्टेंट के बारे में जानकारी होती है. यह किसी इवेंट ऑब्जेक्ट में सिर्फ़ तब मौजूद होता है, जब होस्ट ऐप्लिकेशन 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 का मतलब है कि ऐड-ऑन ने शीट के यूज़र इंटरफ़ेस (यूआई) में खुली स्प्रेडशीट के लिए, 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"
  }
}