playlistItem
रिसॉर्स, प्लेलिस्ट में शामिल किसी दूसरे रिसॉर्स की पहचान करता है. जैसे, वीडियो. इसके अलावा, playlistItem
रिसॉर्स में शामिल किए गए रिसॉर्स के बारे में जानकारी होती है. इसमें खास तौर पर, उस रिसॉर्स के इस्तेमाल के बारे में जानकारी होती है जिसका इस्तेमाल उस प्लेलिस्ट में किया गया है.
YouTube, प्लेलिस्ट का इस्तेमाल करके भी चैनल पर अपलोड किए गए वीडियो की सूची की पहचान करता है. इस सूची में मौजूद हर playlistItem
, एक अपलोड किए गए वीडियो को दिखाता है. किसी चैनल के channel
रिसॉर्स से, उस सूची का प्लेलिस्ट आईडी पाया जा सकता है. इसके बाद, सूची में playlistItems.list
तरीके का इस्तेमाल किया जा सकता है.
तरीके
एपीआई, playlistItems
संसाधनों के लिए इन तरीकों का इस्तेमाल करता है:
- list
- एपीआई के अनुरोध पैरामीटर से मैच करने वाले प्लेलिस्ट आइटम का कलेक्शन दिखाता है. किसी प्लेलिस्ट के सभी आइटम या एक या उससे ज़्यादा आइटम को उनके यूनीक आईडी के हिसाब से वापस पाया जा सकता है. इसे अभी आज़माएं.
- शामिल करें
- किसी प्लेलिस्ट में संसाधन जोड़ता है. इसे अभी आज़माएं.
- अपडेट करें
- किसी प्लेलिस्ट आइटम में बदलाव करता है. उदाहरण के लिए, प्लेलिस्ट में आइटम की पोज़िशन अपडेट की जा सकती है. इसे अभी आज़माएं.
- मिटाएं
- प्लेलिस्ट का कोई आइटम मिटाता है. इसे अभी आज़माएं.
संसाधन का प्रतिनिधित्व
यहां दिया गया JSON स्ट्रक्चर, playlistItems
संसाधन का फ़ॉर्मैट दिखाता है:
{ "kind": "youtube#playlistItem", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
प्रॉपर्टी
इस टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#playlistItem होगी. |
etag |
etag इस संसाधन का Etag. |
id |
string यह एक आईडी है. इसका इस्तेमाल YouTube, प्लेलिस्ट आइटम की खास तौर पर पहचान करने के लिए करता है. |
snippet |
object snippet ऑब्जेक्ट में, प्लेलिस्ट आइटम के बारे में बुनियादी जानकारी होती है. जैसे, उसका टाइटल और प्लेलिस्ट में उसकी पोज़िशन. |
snippet.publishedAt |
datetime प्लेलिस्ट में आइटम को जोड़ने की तारीख और समय. वैल्यू को ISO 8601 फ़ॉर्मैट में बताया गया है. |
snippet.channelId |
string यह एक आईडी है. इसका इस्तेमाल YouTube, प्लेलिस्ट में आइटम जोड़ने वाले उपयोगकर्ता की पहचान करने के लिए करता है. |
snippet.title |
string आइटम का टाइटल. |
snippet.description |
string आइटम का ब्यौरा. |
snippet.thumbnails |
object प्लेलिस्ट आइटम से जुड़े थंबनेल की इमेज का मैप. मैप में मौजूद हर ऑब्जेक्ट के लिए, कुंजी थंबनेल इमेज का नाम होती है और वैल्यू एक ऐसा ऑब्जेक्ट होता है जिसमें थंबनेल के बारे में अन्य जानकारी होती है. |
snippet.thumbnails.(key) |
object मान्य कुंजी वैल्यू ये हैं:
|
snippet.thumbnails.(key).url |
string इमेज का यूआरएल. |
snippet.thumbnails.(key).width |
unsigned integer इमेज की चौड़ाई. |
snippet.thumbnails.(key).height |
unsigned integer इमेज की ऊंचाई. |
snippet.channelTitle |
string उस चैनल का टाइटल जिसका प्लेलिस्ट आइटम है. |
snippet.videoOwnerChannelTitle |
string इस वीडियो को अपलोड करने वाले चैनल का टाइटल. |
snippet.videoOwnerChannelId |
string इस वीडियो को अपलोड करने वाले चैनल का चैनल आईडी. |
snippet.playlistId |
string वह आईडी जिसका इस्तेमाल YouTube, प्लेलिस्ट आइटम की उस प्लेलिस्ट की खास पहचान करने के लिए करता है जिसमें वह आइटम मौजूद है. |
snippet.position |
unsigned integer प्लेलिस्ट में आइटम दिखने का क्रम. वैल्यू में शून्य-आधारित इंडेक्स का इस्तेमाल किया जाता है. इसलिए, पहले आइटम की पोज़िशन 0 , दूसरे आइटम की पोज़िशन 1 वगैरह होती है. |
snippet.resourceId |
object id ऑब्जेक्ट में ऐसी जानकारी होती है जिसका इस्तेमाल, प्लेलिस्ट आइटम के तौर पर प्लेलिस्ट में शामिल किए गए रिसॉर्स की खास पहचान करने के लिए किया जा सकता है. |
snippet.resourceId.kind |
string रेफ़र किए गए संसाधन का टाइप. |
snippet.resourceId.videoId |
string अगर snippet.resourceId.kind प्रॉपर्टी की वैल्यू youtube#video है, तो यह प्रॉपर्टी मौजूद होगी और इसकी वैल्यू में वह आईडी होगा जिसका इस्तेमाल YouTube, प्लेलिस्ट में वीडियो की खास पहचान करने के लिए करता है. |
contentDetails |
object अगर शामिल किए गए आइटम में YouTube वीडियो है, तो contentDetails ऑब्जेक्ट को संसाधन में शामिल किया जाता है. ऑब्जेक्ट में वीडियो के बारे में ज़्यादा जानकारी होती है. |
contentDetails.videoId |
string ऐसा आईडी जिसका इस्तेमाल YouTube किसी वीडियो की खास ढंग से पहचान करने के लिए करता है. video संसाधन को वापस पाने के लिए, अपने एपीआई अनुरोध में id क्वेरी पैरामीटर को इस वैल्यू पर सेट करें. |
contentDetails.startAt |
string ध्यान दें: इस प्रॉपर्टी का इस्तेमाल बंद कर दिया गया है. अगर इसे सेट किया जाता है, तो इसकी वैल्यू को अनदेखा कर दिया जाता है. वीडियो शुरू होने के बाद, वीडियो चलने में लगने वाला समय. इसे सेकंड में मेज़र किया जाता है. (प्लेलिस्ट का मालिक यह तय कर सकता है कि प्लेलिस्ट के संदर्भ में वीडियो चलने पर, उसे कब शुरू और कब बंद किया जाए.) डिफ़ॉल्ट वैल्यू 0 है. |
contentDetails.endAt |
string ध्यान दें: इस प्रॉपर्टी का इस्तेमाल बंद कर दिया गया है. अगर इसे सेट किया जाता है, तो इसकी वैल्यू को अनदेखा कर दिया जाता है. वीडियो के शुरू होने से लेकर, वीडियो के बंद होने तक का समय, सेकंड में. (प्लेलिस्ट का मालिक यह तय कर सकता है कि प्लेलिस्ट के संदर्भ में वीडियो कब चलना शुरू और कब बंद होना चाहिए.) डिफ़ॉल्ट रूप से, मान लें कि video.endTime वीडियो का आखिरी हिस्सा है. |
contentDetails.note |
string इस आइटम के लिए, उपयोगकर्ता का बनाया गया नोट. प्रॉपर्टी की वैल्यू में ज़्यादा से ज़्यादा 280 वर्ण हो सकते हैं. |
contentDetails.videoPublishedAt |
datetime YouTube पर वीडियो पब्लिश करने की तारीख और समय. वैल्यू को ISO 8601 फ़ॉर्मैट में दिया गया है. |
status |
object status ऑब्जेक्ट में, प्लेलिस्ट आइटम की निजता की स्थिति की जानकारी होती है. |
status.privacyStatus |
string प्लेलिस्ट आइटम की निजता की स्थिति. प्लेलिस्ट आइटम में मौजूद वीडियो को अपलोड करने वाले चैनल के पास, videos.insert या videos.update में से किसी एक तरीके का इस्तेमाल करके, इस वैल्यू को सेट करने का विकल्प होता है. |