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() तरीके पर कॉल करें. optimize_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.रेंडर की मदद से बटन रेंडर करना

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