activities.list
वाला तरीका
अब भी चैनल बुलेटिन नहीं दिखाता है. साथ ही, activities.insert
वाला तरीका अब
काम नहीं करता. ज़्यादा जानकारी के लिए, कृपया
YouTube सहायता केंद्र पर जाएं.
यह फ़ंक्शन अनुरोध की शर्तों से मेल खाने वाली, चैनल की गतिविधियों के इवेंट की सूची दिखाता है. उदाहरण के लिए, किसी खास चैनल या उपयोगकर्ता के चैनल से जुड़े इवेंट की जानकारी फ़ेच की जा सकती है.
कोटा पर असर: इस तरीके का इस्तेमाल करने पर एक यूनिट की कोटे की कीमत लागू होती है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/activities
पैरामीटर
इस टेबल में वे पैरामीटर दिए गए हैं जो इस क्वेरी पर काम करते हैं. सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर, एक या एक से ज़्यादा activity संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. इस सूची में एपीआई के रिस्पॉन्स शामिल होंगे.अगर पैरामीटर किसी ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी शामिल हैं, तो जवाब में चाइल्ड प्रॉपर्टी शामिल हो जाएंगी. उदाहरण के लिए, activity संसाधन में, snippet प्रॉपर्टी में ऐसी अन्य प्रॉपर्टी शामिल होती हैं जो गतिविधि के टाइप, गतिविधि के डिसप्ले टाइटल वगैरह के बारे में बताती हैं. अगर part=snippet को सेट किया जाता है, तो एपीआई के रिस्पॉन्स में नेस्ट की गई सभी प्रॉपर्टी भी शामिल होंगी.यहां दी गई सूची में part नाम हैं, जिन्हें पैरामीटर की वैल्यू में शामिल किया जा सकता है:
|
|
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं) | ||
channelId |
string channelId पैरामीटर से, YouTube चैनल का यूनीक आईडी पता चलता है. इसके बाद, एपीआई उस चैनल की गतिविधियों की सूची दिखाएगा. |
|
home |
boolean ध्यान दें: यह पैरामीटर अब काम नहीं करता. इस पैरामीटर को सेट करने वाले अनुरोधों के लिए, एपीआई के रिस्पॉन्स में ऐसे आइटम शामिल होते हैं जो लॉग-आउट कर चुके उपयोगकर्ता को YouTube के होम पेज पर दिखते हैं. ध्यान दें कि इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. |
|
mine |
boolean इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. पुष्टि किए गए उपयोगकर्ता की गतिविधियों का फ़ीड फिर से पाने के लिए, इस पैरामीटर की वैल्यू को true पर सेट करें. |
|
वैकल्पिक पैरामीटर | ||
maxResults |
unsigned integer maxResults पैरामीटर से यह तय होता है कि ज़्यादा से ज़्यादा कितने आइटम, नतीजे के सेट में दिखाए जाने चाहिए. स्वीकार किए जाने वाले मान 0 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
pageToken |
string pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है. |
|
publishedAfter |
datetime publishedAfter पैरामीटर से, उस तारीख और समय की जानकारी मिलती है जब एपीआई के रिस्पॉन्स में उस गतिविधि को शामिल करने के लिए, कोई गतिविधि हो सकती थी. अगर पैरामीटर की वैल्यू में समय के बजाय दिन की जानकारी दी गई है, तो उस दिन हुई सभी गतिविधियों को नतीजे के सेट में शामिल किया जाएगा. यह वैल्यू ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ) फ़ॉर्मैट में होती है. |
|
publishedBefore |
datetime publishedBefore पैरामीटर से पता चलता है कि एपीआई के रिस्पॉन्स में किसी गतिविधि को शामिल करने के लिए, किस तारीख और समय से पहले कोई गतिविधि हुई होनी चाहिए. अगर पैरामीटर की वैल्यू में समय के बजाय दिन की जानकारी दी गई है, तो उस दिन हुई सभी गतिविधियों को नतीजे के सेट से बाहर रखा जाएगा. यह वैल्यू ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ ) फ़ॉर्मैट में होती है. |
|
regionCode |
string regionCode पैरामीटर, एपीआई को किसी देश के लिए नतीजे दिखाने का निर्देश देता है. पैरामीटर की वैल्यू, ISO 3166-1 alpha-2 देश का कोड होती है. YouTube इस वैल्यू का इस्तेमाल तब करता है, जब YouTube पर अनुमति पा चुके उपयोगकर्ता की पिछली गतिविधि ने गतिविधि फ़ीड जनरेट करने के लिए ज़रूरी जानकारी नहीं दी है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर यह तरीका काम करता है, तो यह इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "youtube#activityListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ activity Resource ] }
प्रॉपर्टी
यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string इससे पता चलता है कि एपीआई रिसॉर्स किस तरह का है. मान youtube#activityListResponse होगा. |
etag |
etag इस संसाधन का ईटैग. |
nextPageToken |
string नतीजे के सेट का अगला पेज वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
prevPageToken |
string नतीजे के सेट में पिछले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजे के सेट में मौजूद नतीजों की कुल संख्या. |
pageInfo.resultsPerPage |
integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या. |
items[] |
list अनुरोध की शर्तों से मेल खाने वाली गतिविधियों या इवेंट की सूची. |
गड़बड़ियां
नीचे दी गई टेबल में गड़बड़ी के ऐसे मैसेज की पहचान की गई है जिन्हें एपीआई इस तरीके को कॉल करने पर जवाब दे सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी के मैसेज का दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
forbidden (403) |
forbidden |
अनुरोध सही तरीके से अनुमति नहीं दी गई है. |
forbidden (403) |
homeParameterDeprecated |
इस एपीआई की मदद से, उपयोगकर्ता के होम पेज पर की गई गतिविधि का डेटा उपलब्ध नहीं होता. यह गड़बड़ी तब हो सकती है, जब बिना अनुमति के किए गए किसी अनुरोध में home पैरामीटर को true पर सेट किया गया हो. |
notFound (404) |
channelNotFound |
अनुरोध के channelId पैरामीटर से पहचाना गया चैनल आईडी नहीं मिला. |
notFound (404) |
homeChannelNotFound |
वर्तमान में प्रमाणित उपयोगकर्ता के लिए YouTube होम पेज फ़ीड नहीं मिला. |
unauthorized (401) |
authorizationRequired |
अनुरोध में home पैरामीटर का इस्तेमाल किया गया है, लेकिन इसे सही तरीके से अनुमति नहीं मिली है. |
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.