members
एंडपॉइंट, 31 मार्च, 2020 से sponsors
एंडपॉइंट की जगह ले लेगा. sponsors
एंडपॉइंट अब काम नहीं करता और इसे 30 सितंबर, 2020 को या इसके बाद इस्तेमाल नहीं किया जा सकेगा. एपीआई क्लाइंट को members.list
तरीके का इस्तेमाल करने के लिए, कॉल को sponsors.list
तरीके पर अपडेट करना चाहिए.
इस एंडपॉइंट का इस्तेमाल, सिर्फ़ अलग-अलग क्रिएटर्स अपने YouTube चैनल के लिए अनुरोध करने के लिए कर सकते हैं. इस चैनल पर पैसे चुकाकर ली जाने वाली सदस्यता की सुविधा चालू होनी चाहिए. ऐक्सेस का अनुरोध करने के लिए, अपने Google या YouTube प्रतिनिधि से संपर्क करें.
member
रिसॉर्स, YouTube चैनल के किसी सदस्य की जानकारी दिखाता है. पैसे चुकाकर बने सदस्य, क्रिएटर को बार-बार पैसे देते हैं. इसके बदले, उन्हें खास फ़ायदे मिलते हैं. उदाहरण के लिए, जब क्रिएटर किसी चैट के लिए सिर्फ़ पैसे चुकाकर बने सदस्यों के लिए मोड चालू करता है, तो सदस्य चैट कर सकते हैं.
तरीके
एपीआई, member
संसाधनों के लिए इन तरीकों का इस्तेमाल करता है:
- list
- इसमें किसी चैनल के पैसे चुकाकर बने सदस्यों (जिन्हें पहले "प्रायोजित सदस्य" कहा जाता था) की सूची होती है. एपीआई के अनुरोध के लिए, चैनल के मालिक की अनुमति ज़रूरी है.
संसाधन का प्रतिनिधित्व
यहां दिया गया JSON स्ट्रक्चर, member
संसाधन का फ़ॉर्मैट दिखाता है:
{ "kind": "youtube#member", "etag": etag, "snippet": { "creatorChannelId": string, "memberDetails": { "channelId": string, "channelUrl": string, "displayName": string, "profileImageUrl": string }, "membershipsDetails": { "highestAccessibleLevel": string, "highestAccessibleLevelDisplayName": string, "accessibleLevels": [ string ], "membershipsDuration": { "memberSince": datetime, "memberTotalDurationMonths": integer, }, "membershipsDurationAtLevel": [ { "level": string, "memberSince": datetime, "memberTotalDurationMonths": integer, } ] } } }
प्रॉपर्टी
इस टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#member होगी. |
etag |
etag इस संसाधन का Etag. |
snippet |
object snippet ऑब्जेक्ट में, सदस्य के बारे में जानकारी होती है. |
snippet.creatorChannelId |
string पैसे चुकाकर चैनल की सदस्यताएं लेने की सुविधा देने वाले क्रिएटर का YouTube चैनल आईडी. |
snippet.memberDetails |
object इस ऑब्जेक्ट में, उस YouTube चैनल की प्रोफ़ाइल का डेटा होता है जिसने पैसे चुकाकर सदस्यता ली है. ध्यान दें कि किसी चैनल के ऐसे सदस्य हो सकते हैं जिनकी प्रोफ़ाइल का डेटा उपलब्ध न हो. उदाहरण के लिए, ऐसा उन सदस्यों के साथ होता है जिन्होंने अपने चैनल मिटा दिए हैं, लेकिन अब भी पैसे चुकाकर सदस्यताएं ले रहे हैं. ध्यान दें कि ये सदस्य अब भी अपनी सदस्यता के फ़ायदे ऐक्सेस कर सकते हैं. एपीआई के जवाबों में उन सदस्यों के लिए संसाधन शामिल होते हैं, ताकि यह पक्का किया जा सके कि सदस्यों की संख्या सही है. भले ही, memberDetails ऑब्जेक्ट में प्रोफ़ाइल की जानकारी सेट न की गई हो. ऐसे सदस्यों को अब भी membershipsDetails मिलते रहेंगे. |
snippet.memberDetails.channelId |
string पैसे चुकाकर बने सदस्यों के लिए बने चैनल का YouTube चैनल आईडी. अगर यह सेट है, तो चैनल आईडी को सदस्य के लिए यूनीक आइडेंटिफ़ायर के तौर पर भी इस्तेमाल किया जा सकता है. अगर यह एट्रिब्यूट सेट नहीं है, तो सदस्य की खास पहचान नहीं की जा सकती. हालांकि, संसाधन में सदस्यता की जानकारी दी जाती है. जैसे, सदस्य कौनसे लेवल ऐक्सेस कर सकता है और उसकी सदस्यता की अवधि कितनी है. |
snippet.memberDetails.channelUrl |
string चैनल का यूआरएल. |
snippet.memberDetails.displayName |
string चैनल का डिसप्ले नेम. |
snippet.memberDetails.profileImageUrl |
string चैनल के अवतार का यूआरएल. |
snippet.membershipsDetails |
object इस ऑब्जेक्ट में, पैसे चुकाकर बने सदस्यों के लिए चैनल की सदस्यता की जानकारी शामिल होती है. |
snippet.membershipsDetails.highestAccessibleLevel |
string पैसे चुकाकर ली जाने वाली सदस्यता के उस लेवल का आईडी जिसे पैसे चुकाकर चैनल की सदस्यता लेने वाले लोग फ़िलहाल ऐक्सेस कर सकते हैं. यह वैल्यू, membershipsLevel संसाधन में मौजूद id प्रॉपर्टी की वैल्यू से मेल खाती है. |
snippet.membershipsDetails.highestAccessibleLevelDisplayName |
string पैसे चुकाकर ली जाने वाली सदस्यता के उस लेवल का नाम जिसका ऐक्सेस, पैसे चुकाकर बने सदस्य के चैनल के पास फ़िलहाल है. यह वैल्यू, membershipsLevel संसाधन में मौजूद displayName प्रॉपर्टी की वैल्यू से मेल खाती है. |
snippet.membershipsDetails.accessibleLevels[] |
list (of strings) पैसे चुकाकर ली जाने वाली सदस्यता के उन सभी लेवल के आईडी की सूची जिन्हें उपयोगकर्ता फ़िलहाल ऐक्सेस कर सकता है. इस सूची में, फ़िलहाल चालू लेवल और उससे नीचे के सभी लेवल शामिल होते हैं. |
snippet.membershipsDuration |
object इस ऑब्जेक्ट में, पैसे चुकाकर बने मौजूदा सदस्य की सदस्यता की कुल अवधि के बारे में जानकारी होती है. इसमें सदस्यता की कीमत के लेवल की जानकारी शामिल नहीं होती. इसके बाद, snippet.membershipsDetails.membershipsDurationAtLevel[]
प्रॉपर्टी में उन ऑब्जेक्ट की सूची होती है जिनमें सदस्यता की उस अवधि के बारे में जानकारी होती है जब सदस्य के पास किसी खास सदस्यता लेवल का ऐक्सेस था.
इस उदाहरण से पता चलता है कि ये प्रॉपर्टी कैसे काम करती हैं: किसी सदस्य ने जनवरी में, सदस्यता के लेवल 1 पर नई सदस्यता खरीदी और मार्च तक उसके पास यह सदस्यता थी. अप्रैल और मई में, सदस्य के पास सदस्यता नहीं है. जून में, सदस्य ने अपनी सदस्यता फिर से शुरू की, फिर से लेवल 1 पर. इसके बाद, अगस्त में वह सदस्यता को लेवल 2 पर अपग्रेड करता है. इसलिए, अगर अक्टूबर में कोई एपीआई कॉल किया जाता है, तो member संसाधन में ये चीज़ें शामिल होंगी:
"membershipsDetails": { "membershipsDuration": { "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7, }, "membershipsDurationAtLevel": [ { "level": "level_1_ID", "memberSince": "2020-06-01T12:00:00", "memberTotalDurationMonths": 7 }, { "level": "level_2_ID", "memberSince": "2020-08-01T12:00:00", "memberTotalDurationMonths": 2 }, ] } |
snippet.membershipsDuration.memberSince |
datetime सदस्यता शुरू होने की तारीख और समय. दूसरे शब्दों में, इस तारीख और समय से सदस्य के पास सदस्यता है. ध्यान दें कि सदस्यता की अलग-अलग अवधियों को, सदस्यता के अलग-अलग लेवल पर खर्च किया जा सकता है. |
snippet.membershipsDuration.memberTotalDurationMonths |
integer उपयोगकर्ता के सदस्य होने के महीनों की संख्या, जो सबसे छोटे पूर्णांक तक राउंड ऑफ़ की गई है. इस वैल्यू से यह पता चलता है कि सदस्यता के कितने पूरे महीने पूरे हो चुके हैं. हालांकि, इस वैल्यू का मतलब यह नहीं है कि सदस्यता लगातार इतने महीनों तक चालू रही है. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel[] |
list (of objects) ऑब्जेक्ट की सूची, जिसमें हर ऑब्जेक्ट में सदस्यता की उस अवधि के बारे में जानकारी होती है जब सदस्य के पास सदस्यता के किसी खास लेवल का ऐक्सेस था. इस सूची में, पैसे चुकाकर ली जाने वाली सदस्यता के हर उस लेवल के लिए एक ऑब्जेक्ट शामिल होता है जिसका ऐक्सेस सदस्य के पास फ़िलहाल है. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.level |
string सदस्यता के लेवल का आईडी. यह वैल्यू, membershipsLevel संसाधन में मौजूद
id प्रॉपर्टी की वैल्यू से मेल खाती है. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberSince |
datetime वह तारीख और समय जब से सदस्य के पास पैसे चुकाकर ली जाने वाली सदस्यता के किसी लेवल का ऐक्सेस है. दूसरे शब्दों में, इस तारीख और समय से सदस्य के पास लेवल का ऐक्सेस लगातार है. ध्यान दें कि सदस्यता की अलग-अलग अवधियों को, सदस्यता के ज़्यादा लेवल पर बिताया गया हो सकता है. |
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel.memberTotalDurationMonths |
integer उपयोगकर्ता के पास, तय किए गए लेवल का ऐक्सेस कितने महीनों से है. यह संख्या, सबसे नज़दीकी पूर्णांक तक राउंड ऑफ की जाती है. इस वैल्यू से यह पता चलता है कि सदस्य के पास कितने महीनों तक लेवल का ऐक्सेस रहा. हालांकि, इस वैल्यू का यह मतलब नहीं है कि सदस्य के पास इतने महीनों तक लगातार सदस्यता रही. |