Members

member संसाधन, YouTube चैनल के लिए पैसे चुकाकर बने सदस्य को दिखाता है. पैसे चुकाकर बने सदस्य, क्रिएटर को बार-बार आर्थिक मदद देते हैं और खास फ़ायदे पाते हैं. उदाहरण के लिए, अगर क्रिएटर ने चैट के लिए, पैसे चुकाकर बने सदस्यों के लिए उपलब्ध मोड चालू किया है, तो पैसे चुकाकर बने सदस्य ही चैट कर पाएंगे.

ऐक्सेस से जुड़ी ये पाबंदियां लागू होती हैं:

  • members और membershipsLevels एंडपॉइंट का ऐक्सेस, सिर्फ़ उन YouTube क्रिएटर्स के लिए उपलब्ध है जिनके पास YouTube Partner Manager है.
  • ऐक्सेस, चैनल के लेवल पर दिया जाता है. चैनल-लेवल पर अनुमति वाली सूची में शामिल होने की वजह से, youtube.channel-memberships.creator OAuth स्कोप को Google Cloud OAuth की पुष्टि करने की स्टैंडर्ड प्रोसेस से नहीं गुज़रना पड़ता.

तरीके

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