members
एंडपॉइंट ने
sponsors
एंडपॉइंट की जगह ले ली है. अब यह एंडपॉइंट बंद कर दिया गया है और 30 सितंबर, 2020 या इसके बाद से
यह काम नहीं करेगा. एपीआई क्लाइंट को कॉल को sponsors.list
तरीके पर अपडेट करना चाहिए, ताकि वे इसके बजाय members.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 इस संसाधन का ईटैग. |
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 उपयोगकर्ताओं को एक तय लेवल का ऐक्सेस मिलने के बाद, महीनों की संख्या को सबसे करीबी पूर्णांक में बदल दिया जाता है. इस वैल्यू से उन महीनों की संख्या का पता चलता है जब सदस्य के पास लेवल का ऐक्सेस था. हालांकि, संख्या से यह पता नहीं चलता कि सदस्य को कितने महीनों से लगातार सदस्यता मिली हुई है. |