Reference Guide

विशेषताएं

इस सेक्शन में, सदस्यता बटन के लिए <div> एलिमेंट बनाने का तरीका बताया गया है. यहां दी गई सूचियों में, एलिमेंट के ज़रूरी और वैकल्पिक एट्रिब्यूट के बारे में बताया गया है. वैकल्पिक एट्रिब्यूट की मदद से, बटन के लेआउट और थीम को कंट्रोल किया जा सकता है. साथ ही, यह चुना जा सकता है कि चैनल के सदस्यों की संख्या दिखानी है या नहीं.

ज़रूरी एट्रिब्यूट

• class – वैल्यू को g-ytsubscribe पर सेट करता है. यह क्लास, <div> एलिमेंट को सदस्यता बटन के कंटेनर के तौर पर पहचानती है. साथ ही, YouTube को एम्बेड किए गए बटन का साइज़ डाइनैमिक तरीके से बदलने की अनुमति देती है. इसके बारे में अगले सेक्शन में बताया गया है.

• आपको इन दो एट्रिब्यूट में से किसी एक की वैल्यू देनी होगी:

  • data-channel – बटन से जुड़े चैनल का नाम. सैंपल वैल्यू: GoogleDevelopers.
  • data-channelid – बटन से जुड़ा चैनल आईडी. सैंपल वैल्यू: UC_x5XG1OV2P6uZZ5FSM9Ttw. अपने चैनल आईडी को YouTube खाते की सेटिंग में जाकर या इस दस्तावेज़ के आखिर में दिए गए APIs Explorer का इस्तेमाल करके वापस पाया जा सकता है. चैनल आईडी के साथ काम करने के बारे में ज़्यादा जानें.

ऐसे एट्रिब्यूट जो ज़रूरी नहीं हैं

• data-layout – बटन का फ़ॉर्मैट. मान्य विशेषता के मान इस प्रकार हैं:

  • default – इसमें, 'चलाएं' बटन का आइकॉन और'सदस्यता लें' शब्द, उपयोगकर्ता की भाषा में दिखता है. यह भाषा, उपयोगकर्ता की भाषा की सेटिंग या उसकी जगह के हिसाब से चुनी जाती है.
  • full – इसमें स्टैंडर्ड बटन के साथ-साथ, चैनल का अवतार और चैनल का नाम दिखता है.

• data-theme – इससे बटन के लिए इस्तेमाल की जाने वाली कलर स्कीम के बारे में पता चलता है. मान्य वैल्यू default और dark हैं. dark थीम का इस्तेमाल उन ऐप्लिकेशन के लिए किया जाता है जिनमें बटन को गहरे रंग वाले बैकग्राउंड एलिमेंट पर रखा जाता है.

• data-count – इससे पता चलता है कि बटन पर, चैनल के सदस्यों की संख्या दिखती है या नहीं. बटन का डिफ़ॉल्ट तरीका यह है कि वह सदस्यों की संख्या दिखाए. मान्य वैल्यू default और hidden हैं.

• data-onytevent – ध्यान दें: इस एट्रिब्यूट का इस्तेमाल अब नहीं किया जा सकेगा.

इवेंट

ध्यान दें: सदस्यता बटन के subscribe और unsubscribe इवेंट अब काम नहीं करते. इसी तरह, data-ytonevent एट्रिब्यूट को भी बंद कर दिया गया है. पहले इसे विजेट एलिमेंट में जोड़ा जा सकता था, ताकि इवेंट की सूचनाओं के लिए लिसनर तय किया जा सके.

डाइनैमिक रेंडरिंग

कॉन्फ़िगरेशन टूल से मिले स्टैंडर्ड एम्बेड कोड का इस्तेमाल करने के बजाय, Subscribe Button को डाइनैमिक तौर पर रेंडर किया जा सकता है. इस तरीके से, एपीआई के JavaScript को पूरे DOM में बटन ढूंढने की ज़रूरत नहीं पड़ती. इससे बटन रेंडर होने में लगने वाला समय कम हो सकता है.

Google+ JavaScript API के तहत, Subscribe Button, स्टैंडर्ड go और render तरीकों के साथ काम करता है. इनका इस्तेमाल, सदस्यता लेने के बटन को डाइनैमिक तरीके से रेंडर करने के लिए किया जा सकता है. उदाहरण के लिए, इन तरीकों का इस्तेमाल करके ऐसा बटन रेंडर किया जा सकता है जो DOM ready इवेंट ट्रिगर होने पर मौजूद नहीं होता. जैसे, AJAX से अपडेट किए गए पेज पर.

तरीका	ब्यौरा
gapi.ytsubscribe.go(   opt_container )	इससे, दिए गए कंटेनर में सदस्यता लेने के सभी बटन रेंडर हो जाते हैं. अगर आपको रेंडर करने के लिए सदस्यता बटन के जिन एलिमेंट की ज़रूरत है वे पहले से मौजूद हैं, तो इस तरीके का इस्तेमाल करें. उदाहरण के लिए, अगर आपका ऐप्लिकेशन ऐसा AJAX अनुरोध भेजता है जो किसी Subscribe Button के लिए पूरा <div> एलिमेंट दिखाता है, तो बटन को रेंडर करने के लिए go() तरीके को कॉल करें. opt_container यह एचटीएमएल एलिमेंट है. इसमें सदस्यता लेने के बटन होते हैं, जिन्हें रेंडर किया जाता है. एलिमेंट का आईडी या डीओएम एलिमेंट तय करें. अगर इस पैरामीटर को शामिल नहीं किया जाता है, तो पेज पर मौजूद सभी सदस्यता बटन रेंडर किए जाते हैं.
gapi.ytsubscribe.render(   container,   parameters )	यह फ़ंक्शन, तय किए गए कंटेनर में Subscribe Button को रेंडर करता है. अगर Subscribe Button को शामिल करने वाला एलिमेंट पहले से मौजूद नहीं है और उसे बनाना है, तो इस तरीके का इस्तेमाल करें. कंटेनर यह खाली एचटीएमएल एलिमेंट की पहचान करता है, जिसमें Subscribe Button रेंडर किया जाएगा. एलिमेंट का आईडी या डीओएम एलिमेंट तय करें. पैरामीटर एक ऐसा ऑब्जेक्ट जिसमें सदस्यता बटन के एट्रिब्यूट को key:value जोड़े के तौर पर शामिल किया जाता है. जैसे, {"channel": "GoogleDevelopers", "layout": "full"}.

gapi.ytsubscribe.go की मदद से बटन रेंडर करना

यहां दिए गए उदाहरण में, उस कोड को दिखाया गया है जिसका इस्तेमाल करके, लिंक पर क्लिक करने पर बटन को डाइनैमिक तरीके से रेंडर करने के लिए, gapi.ytsubscribe.go तरीके को कॉल किया जाता है.

ध्यान दें: ऊपर दिया गया कॉन्फ़िगरेशन टूल भी, बटन के विकल्पों या कोड को अपडेट करने पर नया बटन रेंडर करने के लिए, go तरीके का इस्तेमाल करता है.

gapi.ytsubscribe.render की मदद से बटन रेंडर करना

यहां दिए गए उदाहरण में, लिंक पर क्लिक करने पर बटन को डाइनैमिक तरीके से रेंडर करने के लिए, gapi.ytsubscribe.render तरीके को कॉल करने का तरीका बताया गया है: