members
एंडपॉइंट, 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 इस संसाधन का ऐट. |
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 महीनों की संख्या, पास के पूर्णांक में बदल दी जाती है, जिसे उपयोगकर्ता ने बताए गए लेवल का ऐक्सेस दिया होता है. इस वैल्यू से पता चलता है कि किसी सदस्य के पास, लेवल का ऐक्सेस कितने महीनों से है. हालांकि, इसमें यह शामिल नहीं होता है कि सदस्य के पास उतने महीनों से लगातार सदस्यता है. |