इनमें चैनल की पैसे चुकाकर बने सदस्यों की सूची होती है. इसे पहले "स्पॉन्सर" कहा जाता था. एपीआई अनुरोध को चैनल के मालिक की अनुमति मिली होनी चाहिए.
कोटा असर: इस तरीके को कॉल करने पर कोटा लागत दो इकाइयों की होती है.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/members
अनुमति देना
इस अनुरोध के लिए नीचे दिए गए दायरे की अनुमति चाहिए:
दायरा |
---|
https://www.googleapis.com/auth/youtube.channel-memberships.creator |
पैरामीटर
इस टेबल में ऐसे पैरामीटर दिए गए हैं जो क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर, member संसाधन प्रॉपर्टी के बारे में बताता है, जिन्हें एपीआई रिस्पॉन्स में शामिल किया जाएगा. पैरामीटर वैल्यू को snippet पर सेट करें. |
|
ज़रूरी पैरामीटर | ||
mode |
string mode पैरामीटर से पता चलता है कि एपीआई के रिस्पॉन्स में कौनसे सदस्य शामिल होंगे. पैरामीटर वैल्यू को इनमें से किसी एक वैल्यू पर सेट करें:
|
|
maxResults |
unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजों की सूची में कितने आइटम दिखाए जाने चाहिए. 0 से 1000 तक के मान स्वीकार किए जाते हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
pageToken |
string pageToken पैरामीटर, नतीजों के सेट में मौजूद उस खास पेज की पहचान करता है
जिसे दिखाना है. यह टोकन खास तौर पर
mode के मूल एपीआई अनुरोध के साथ इस्तेमाल किया जाता है. इस वजह से, किसी भी मोड के साथ मिले पेज टोकन का इस्तेमाल किसी अन्य मोड पर स्विच करने के लिए नहीं किया जा सकता.
|
|
hasAccessToLevel |
string hasAccessToLevel पैरामीटर वैल्यू एक लेवल आईडी है, जो
नतीजों के सेट में मौजूद सदस्यों के लिए कम से कम लेवल तय करता है. |
|
filterByMemberChannelId |
string filterByMemberChannelId पैरामीटर, चैनल आईडी की कॉमा-सेपरेटेड लिस्ट दिखाता है. इसका इस्तेमाल खास उपयोगकर्ताओं की सदस्यता की स्थिति देखने के लिए किया जा सकता है. उदाहरण के लिए, UC_1,UC_2,UC_3 . हर कॉल के लिए, ज़्यादा से ज़्यादा 100 चैनल जोड़े जा सकते हैं. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "youtube#memberListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ member Resource ] }
प्रॉपर्टी
इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:
प्रॉपर्टी | |
---|---|
kind |
string इससे यह पता चलता है कि एपीआई संसाधन किस तरह का है. वैल्यू youtube#memberListResponse होगी. |
etag |
etag इस संसाधन का ऐट. |
nextPageToken |
string यह टोकन, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे, नतीजों के सेट में अगला पेज वापस मिल जाता है. पेज के टोकन की समयसीमा खत्म हो सकती है. साथ ही, आपके अनुरोध से
टोकन को हटा दिया जाना चाहिए और नया अनुरोध करने के लिए, pageToken के बिना एपीआई को कॉल किया जाना चाहिए. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजों के सेट में कुल नतीजे. |
pageInfo.resultsPerPage |
integer एपीआई रिस्पॉन्स में शामिल किए गए नतीजों की संख्या. |
items[] |
list ऐसे सदस्यों की सूची जो अनुरोध की शर्तों को पूरा करते हैं. |
गड़बड़ियां
इस टेबल में उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके से कॉल करने पर एपीआई मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | जानकारी |
---|---|---|
badRequest (400) |
channelMembershipsNotEnabled |
जिस क्रिएटर चैनल ने अनुरोध भेजा है उस पर चैनल की पैसे चुकाकर ली जाने वाली सदस्यता की सुविधा चालू नहीं है. |
badRequest (400) |
invalidMode |
mode पैरामीटर की वैल्यू अमान्य है.
यह गड़बड़ी तब हो सकती है, जब pageToken पैरामीटर
किसी ऐसे टोकन के बारे में बताता है जिसे किसी खास मोड के बजाय किसी दूसरे मोड का इस्तेमाल करके हासिल किया गया हो. |
badRequest (400) |
invalidPageToken |
pageToken पैरामीटर की वैल्यू अमान्य है. यह गड़बड़ी तब दिख सकती है, जब अनुरोध में इस्तेमाल किए गए पेज टोकन की समयसीमा खत्म हो गई हो या उसकी पहचान न की गई हो. |
badRequest (400) |
invalidHasAccessToLevel |
hasAccessToLevel
पैरामीटर की वैल्यू अमान्य है. बताए गए id के लिए कोई लेवल नहीं है. |
badRequest (400) |
invalidFilterByMemberChannelId |
filterByMemberChannelId
पैरामीटर की वैल्यू अमान्य है. यह गड़बड़ी तब होती है, जब filterByMemberChannelId पैरामीटर की वैल्यू में 100 से ज़्यादा चैनल शामिल होते हैं. |