ऐड-ऑन कार्रवाइयां

ऐड-ऑन कार्रवाइयों से आपको इंटरैक्टिव व्यवहार मिलता है विजेट. कोई कार्रवाई बनाकर, आप तय करते हैं कि जब उपयोगकर्ता कोई कार्रवाई करता है या उसे अपडेट करता है, तो क्या होता है विजेट.

ज़्यादातर मामलों में, इसका इस्तेमाल करके ऐड-ऑन कार्रवाइयां तय की जा सकती हैं Action Apps Script कार्ड सेवा से मिले ऑब्जेक्ट. हर Action इससे जुड़ा है आपको कॉलबैक फ़ंक्शन बनाना हो. कॉलबैक फ़ंक्शन लागू किया जाता है उपयोगकर्ता के विजेट से इंटरैक्ट करने पर, मनमुताबिक कदम उठाने के लिए. आपको यह भी करना होगा Action को विजेट से लिंक करें सही विजेट हैंडलर फ़ंक्शन का इस्तेमाल करके तय करता है कि किस तरह का इंटरैक्शन Action कॉलबैक.

Action के साथ विजेट को कॉन्फ़िगर करें इस सामान्य प्रोसेस का इस्तेमाल करके:

  1. Action ऑब्जेक्ट बनाएं, वह कॉलबैक फ़ंक्शन तय कर रहा है जो उसे करना चाहिए लागू करने के लिए ज़रूरी पैरामीटर सेट करें.
  2. सही विजेट हैंडलर फ़ंक्शन को कॉल करें Action का इस्तेमाल करके विजेट पर ऑब्जेक्ट है.
  3. ज़रूरी व्यवहार लागू करने के लिए कॉलबैक फ़ंक्शन लागू करें.

विजेट हैंडलर के फ़ंक्शन

किसी विजेट को किसी खास Action से लिंक करने के लिए या अन्य व्यवहार के लिए, आप विजेट का उपयोग करते हैं हैंडलर फ़ंक्शन. हैंडलर फ़ंक्शन तय करता है कि किस तरह का इंटरैक्शन (उदाहरण के लिए, विजेट पर क्लिक करने या टेक्स्ट फ़ील्ड में बदलाव करने से) कार्रवाई का व्यवहार. हैंडलर फ़ंक्शन से यह भी तय होता है कि यूज़र इंटरफ़ेस (यूआई) कौनसे कदम उठाता है, अगर कोई है, तो कार्रवाई पूरी होने के बाद.

नीचे दी गई टेबल में, विजेट के लिए अलग-अलग तरह के हैंडलर और उन चीज़ों की सूची दी गई है विजेट जिनके साथ उनका उपयोग होता है:

हैंडलर फ़ंक्शन इससे कार्रवाई ट्रिगर होती है लागू विजेट ब्यौरा
setOnChangeAction() विजेट की वैल्यू बदल जाती है DatePicker
DateTimePicker
SelectionInput
Switch
TextInput TimePicker 		Action सेट करता है जो विजेट के फ़ोकस न होने पर, Apps Script फ़ंक्शन चलाता है, जैसे उदाहरण के लिए, जब उपयोगकर्ता इनपुट में टेक्स्ट डालता है और Enter दबाता है. कॉन्टेंट बनाने हैंडलर, अपने-आप इवेंट ऑब्जेक्ट को उस फ़ंक्शन में सबमिट करें जिसे यह कॉल करता है. इस इवेंट ऑब्जेक्ट में पैरामीटर की अन्य जानकारी भी डाली जा सकती है अगर आप चाहें.
setOnClickAction() उपयोगकर्ता विजेट पर क्लिक करता है CardAction
Image
ImageButton
DecoratedText
TextButton 		Action सेट करता है जो उपयोगकर्ता के विजेट पर क्लिक करने पर Apps Script फ़ंक्शन चलाता है. कॉन्टेंट बनाने हैंडलर, अपने-आप इवेंट ऑब्जेक्ट को उस फ़ंक्शन में सबमिट करें जिसे यह कॉल करता है. इस इवेंट ऑब्जेक्ट में पैरामीटर की वैकल्पिक जानकारी शामिल की जा सकती है.
setComposeAction() उपयोगकर्ता विजेट पर क्लिक करता है CardAction
Image
ImageButton
DecoratedText
TextButton 		खास तौर पर Gmail के लिए. यह Action जो एक ईमेल ड्राफ़्ट बनाता है, फिर उस ड्राफ़्ट को उपयोगकर्ता को Gmail के यूज़र इंटरफ़ेस (यूआई) पर लिखने की विंडो. इस ड्राफ़्ट को नए मैसेज या Gmail में खुले हुए मैसेज का जवाब दें. जब हैंडलर ड्राफ़्ट-बिल्डिंग कॉलबैक फ़ंक्शन है, यह इवेंट ऑब्जेक्ट सबमिट करें. यहां जाएं: ड्राफ़्ट मैसेज लिखना देखें.
setOnClickOpenLinkAction() उपयोगकर्ता विजेट पर क्लिक करता है CardAction
Image
ImageButton
DecoratedText
TextButton 		Action सेट करता है का इस्तेमाल करें. इस हैंडलर का इस्तेमाल तब करें, जब को URL का निर्माण करना चाहिए या लिंक से पहले अन्य कार्रवाइयां करनी चाहिए खोलें; अगर ऐसा नहीं है, तो आम तौर पर setOpenLink() का इस्तेमाल करना ज़्यादा आसान होता है. यूआरएल को सिर्फ़ नई विंडो में खोला जा सकता है. बंद होने पर, यूज़र इंटरफ़ेस (यूआई) की इमेज, ताकि ऐड-ऑन को फिर से लोड किया जा सके.
setOpenLink() उपयोगकर्ता विजेट पर क्लिक करता है CardAction
Image
ImageButton
DecoratedText
TextButton 		उपयोगकर्ता के विजेट पर क्लिक करने पर, सीधे कोई यूआरएल खुलता है. इसका इस्तेमाल करें हैंडलर, जब आपको यूआरएल पता हो और आपको सिर्फ़ उसे खोलने की ज़रूरत हो; अगर ऐसा नहीं है, तो इसका इस्तेमाल करें setOnClickOpenLinkAction(). यूआरएल को किसी नई विंडो या ओवरले में खोला जा सकता है. बंद होने पर, आपको ऐड-ऑन को फिर से लोड करने में यूज़र इंटरफ़ेस (यूआई) शामिल हो सकता है.
setSuggestionsAction() जब उपयोगकर्ता किसी इनपुट में टेक्स्ट डालता है TextInput Action सेट करता है जो उपयोगकर्ता के ब्राउज़र में टेक्स्ट डालने पर, Apps Script फ़ंक्शन एक्ज़ीक्यूट करता है टेक्स्ट इनपुट विजेट. हैंडलर अपने-आप इवेंट ऑब्जेक्ट को उस फ़ंक्शन में सबमिट करें जिसे यह कॉल करता है. यहां जाएं: ऑटोकंप्लीट सुविधा से मिलने वाले सुझाव देखें. ज़्यादा जानकारी की है.

कॉलबैक फ़ंक्शन

कॉलबैक फ़ंक्शन तब लागू होते हैं, जब कोई Action ट्रिगर हैं. कॉलबैक फ़ंक्शन, Apps Script फ़ंक्शन हैं. इसलिए, इनका इस्तेमाल किया जा सकता है करीब-करीब हर वह काम करें जो कोई अन्य स्क्रिप्ट फ़ंक्शन कर सकता है.

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

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

कार्रवाई की कोशिश की गई कॉलबैक फ़ंक्शन वापस आना चाहिए
कार्ड के बीच नेविगेट करना ActionResponse
Notification दिखाएं ActionResponse
setOnClickOpenLinkAction() का इस्तेमाल करके लिंक खोलें ActionResponse
अपने-आप पूरा होने वाले सुझाव दिखाना SuggestionResponse
यूनिवर्सल ऐक्शन का इस्तेमाल करें UniversalActionResponse
अन्य कार्रवाइयां Nothing

इन कार्रवाइयों के अलावा, हर होस्ट ऐप्लिकेशन में ऐसी कार्रवाइयां जो सिर्फ़ उस होस्ट में की जा सकती हैं. जानकारी के लिए, यहां देखें: गाइड:

ऐक्शन इवेंट ऑब्जेक्ट

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

कार्रवाई इवेंट ऑब्जेक्ट में एक खास JSON स्ट्रक्चर होता है, जो उनकी जानकारी किस तरह की है. उसी संरचना का इस्तेमाल तब किया जाता है, जब होम पेज ट्रिगर किसी होम पेज को बनाने के लिए ट्रिगर होता है या जब कोई संदर्भ के हिसाब से ट्रिगर ऐड-ऑन डिसप्ले को अपडेट करने के लिए टैग करता है.

पूरी जानकारी के लिए, इवेंट ऑब्जेक्ट देखें इवेंट ऑब्जेक्ट के स्ट्रक्चर की जानकारी.