यह किसी चैनल के सदस्यों (पहले इन्हें "स्पॉन्सर" के नाम से जाना जाता था) की सूची बनाता है. एपीआई अनुरोध के लिए, चैनल के मालिक की अनुमति होनी चाहिए.
कोटा पर असर: इस तरीके का इस्तेमाल करने पर, दो यूनिट की कोटे की कीमत तय होती है.
अनुरोध
एचटीटीपी अनुरोध
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 से ज़्यादा चैनलों के बारे में बताती है. |