स्क्रीन शेयर करने की सुविधा से, उपयोगकर्ताओं के लिए किसी ऐड-ऑन का प्रमोशन करें

स्क्रीन शेयर करने की सुविधा का इस्तेमाल करके, किसी ऐड-ऑन का प्रमोशन करना.

इस पेज पर, Google Meet में किसी टैब को स्क्रीन शेयर करते समय, उपयोगकर्ताओं को किसी ऐड-ऑन का प्रमोशन करने का तरीका बताया गया है. इसके लिए, किसी दूसरे वेब पेज पर थोड़ा कोड डालना होगा.

exposeToMeetWhenScreensharing() वाले तरीके से, साइट को Meet में जानकारी भेजने की अनुमति मिलती है. ऐसा तब होता है, जब साइट का टैब स्क्रीन शेयर किया जाता है. इस जानकारी का इस्तेमाल, Meet में ऐड-ऑन के अनुभव के लिए किया जाता है. ऐसा तब होता है, जब उपयोगकर्ता के पास ऐड-ऑन इंस्टॉल हो और वह प्रज़ेंटेशन बैनर पर "गतिविधि शुरू करें" पर क्लिक करता है. अगर उपयोगकर्ता ने स्क्रीन शेयर करने के लिए कोई टैब चुना है और उसके पास ऐड-ऑन इंस्टॉल नहीं है, तो उसे ऐड-ऑन इंस्टॉल करने के लिए कहा जाएगा.

AddonScreenshareInfo ऑब्जेक्ट में पांच प्रॉपर्टी होती हैं. इन्हें इस्तेमाल के उदाहरण के आधार पर जोड़ा जा सकता है:

  • additionalData: ऐसी जानकारी जिसका इस्तेमाल ऐड-ऑन, खुद को शुरू करने के लिए कर सकता है. इसे सिर्फ़ तब सेट किया जा सकता है, जब startActivityOnOpen प्रॉपर्टी 'सही' पर सेट हो और इसे ActivityStartingState का इस्तेमाल करके ऐक्सेस किया जा सकता हो. ज़्यादा जानकारी के लिए, गतिविधि शुरू होने की स्थिति पाना लेख पढ़ें.

  • cloudProjectNumber: ज़रूरी है. आपके Google Cloud प्रोजेक्ट का प्रोजेक्ट नंबर.

  • mainStageUrl: ऐड-ऑन शुरू होने के बाद, मुख्य स्टेज खुलने वाला यूआरएल, जैसे कि https://www.example.com. यूआरएल, ऐड-ऑन मेनिफ़ेस्ट में बताए गए यूआरएल के उसी ऑरिजिन से जुड़ा होना चाहिए.

  • sidePanelUrl: यह वह यूआरएल होता है जो ऐड-ऑन शुरू होने के बाद, साइड पैनल खोलता है, जैसे कि https://www.example.com. यूआरएल, ऐड-ऑन मेनिफ़ेस्ट में बताए गए यूआरएल के उसी ऑरिजिन से जुड़ा होना चाहिए.

  • startActivityOnOpen: ज़रूरी है. उपयोगकर्ता जब प्रज़ेंटेशन बैनर से ऐड-ऑन शुरू करता है, तो क्या Meet में गतिविधि ऐड-ऑन का अनुभव तुरंत शुरू करना है. अगर mainStageUrl प्रॉपर्टी का इस्तेमाल किया जाता है, तो इसकी वैल्यू 'सही' होनी चाहिए.

SDK टूल इंस्टॉल और इंपोर्ट करना

SDK टूल को npm या gstatic का इस्तेमाल करके ऐक्सेस किया जा सकता है.

अगर आपका प्रोजेक्ट npm का इस्तेमाल करता है, तो Meet के ऐड-ऑन SDK टूल के npm पैकेज के लिए दिए गए निर्देशों का पालन करें.

सबसे पहले, npm पैकेज इंस्टॉल करें:

npm install @googleworkspace/meet-addons

इसके बाद, Meet के ऐड-ऑन SDK टूल को इस्तेमाल करने के लिए, MeetAddonScreenshareExport इंटरफ़ेस को इंपोर्ट करें:

import {meet} from '@googleworkspace/meet-addons/meet.addons.screenshare';

TypeScript का इस्तेमाल करने वाले लोगों के लिए, TypeScript की परिभाषाएं मॉड्यूल के साथ पैकेज की जाती हैं.

gstatic

Google Meet के ऐड-ऑन SDK टूल, gstatic से JavaScript बंडल के तौर पर उपलब्ध है. यह एक ऐसा डोमेन है जो स्टैटिक कॉन्टेंट दिखाता है.

Meet ऐड-ऑन SDK टूल का इस्तेमाल करने के लिए, अपने ऐप्लिकेशन में यह स्क्रिप्ट टैग जोड़ें:

<script src="https://www.gstatic.com/meetjs/addons/1.1.0/meet.addons.screenshare.js"></script>

Meet के ऐड-ऑन SDK टूल, window.meet.addon में जाकर MeetAddon इंटरफ़ेस से उपलब्ध हैं.

उदाहरण: कोई गतिविधि शुरू किए बिना साइड पैनल में लोड करना

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

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: false,
    sidePanelUrl: SIDE_PANEL_URL,
  }
);
</script>

इनकी जगह ये डालें:

  • CLOUD_PROJECT_NUMBER: स्ट्रिंग. आपके Cloud प्रोजेक्ट का प्रोजेक्ट नंबर.
  • SIDE_PANEL_URL: स्ट्रिंग. साइड पैनल का यूआरएल.

जब Meet कॉल की स्क्रीन पर मौजूद उपयोगकर्ता पेज शेयर करता है, तो उसे Meet में प्रज़ेंटेशन बैनर दिखता है. बैनर पर मौजूद बटन पर क्लिक करने से, साइड पैनल में दिए गए क्लाउड प्रोजेक्ट नंबर के लिए ऐड-ऑन खुल जाता है. startActivityOnOpen प्रॉपर्टी को 'गलत' पर सेट किया गया था. इसलिए, ActivityStartingState सेट होने तक गतिविधि शुरू करने का बटन बंद रहेगा. ज़्यादा जानकारी के लिए, गतिविधि की शुरुआती स्थिति का इस्तेमाल करना लेख पढ़ें.

गतिविधि शुरू होने के बाद, कॉल में शामिल अन्य लोगों को ऐड-ऑन को लॉन्च करने या इंस्टॉल करने के लिए कहा जाता है.

GitHub पर"ऐनिमेशन" सैंपल ऐड-ऑन में, इस उदाहरण को पूरे ऐड-ऑन के हिस्से के तौर पर शामिल किया गया है. जब ऐड-ऑन से जुड़े वेब ऐप्लिकेशन का इंडेक्स पेज दिखाया जाता है, तो प्रज़ेंट करने वाले उपयोगकर्ता को ऐड-ऑन को इंस्टॉल या सेट अप करने के लिए कहा जाता है.

उदाहरण: मुख्य स्टेज में लोड करना

नीचे दिए गए कोड सैंपल में, Meet में स्क्रीन शेयर करने वाले उस उपयोगकर्ता को ऐड-ऑन लॉन्च करने के लिए कहा जाता है जिसके वेब पेज में यह कोड मौजूद है:

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    mainStageUrl: MAIN_STAGE_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

इनकी जगह ये डालें:

  • CLOUD_PROJECT_NUMBER: स्ट्रिंग. आपके Google Cloud प्रोजेक्ट का प्रोजेक्ट नंबर.
  • MAIN_STAGE_URL: स्ट्रिंग. मुख्य स्क्रीन का यूआरएल.

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

उदाहरण: साइड पैनल में लोड करना

यहां दिए गए कोड सैंपल में, उपयोगकर्ता की स्क्रीन पर एक ऐसा पेज शेयर किया गया है जिसमें एक ऐड-ऑन है. यह ऐड-ऑन, मुख्य स्क्रीन के बजाय साइड पैनल में शुरू होना चाहिए:

<script>
meet.addon.screensharing.exposeToMeetWhenScreensharing(
  {
    cloudProjectNumber: CLOUD_PROJECT_NUMBER,
    startActivityOnOpen: true,
    sidePanelUrl: SIDE_PANEL_URL,
    additionalData: "{\"selected_item\": \"42\"}",
  }
);
</script>

इनकी जगह ये डालें:

  • CLOUD_PROJECT_NUMBER: स्ट्रिंग. आपके Cloud प्रोजेक्ट का प्रोजेक्ट नंबर.
  • SIDE_PANEL_URL: स्ट्रिंग. साइड पैनल का यूआरएल.

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

ऑरिजिन मैचिंग

mainStageUrl प्रॉपर्टी और sidePanelUrl प्रॉपर्टी में दिए गए ऑरिजिन की तुलना, दिए गए क्लाउड प्रोजेक्ट नंबर के ऐड-ऑन मेनिफ़ेस्ट में मौजूद ऑरिजिन से की जाती है. अगर सब कुछ मैच करता है, तो उपयोगकर्ता को ऐड-ऑन लॉन्च करने की अनुमति मिलती है.

इसके अलावा, स्क्रीन शेयर करने वाली साइट का ऑरिजिन, ऐड-ऑन मेनिफ़ेस्ट में addOnOrigins फ़ील्ड में शामिल होना चाहिए.

ज़्यादा जानकारी के लिए, ऐड-ऑन की सुरक्षा लेख पढ़ें.