playlistItem संसाधन, किसी अन्य संसाधन की पहचान करता है. जैसे, प्लेलिस्ट में शामिल किया गया कोई वीडियो. इसके अलावा, playlistItem संसाधन में शामिल किए गए संसाधन के बारे में जानकारी होती है. यह जानकारी खास तौर पर इस बारे में होती है कि उस संसाधन का इस्तेमाल प्लेलिस्ट में कैसे किया जाता है.
YouTube, अपलोड किए गए वीडियो की सूची वाले चैनल की पहचान करने के लिए भी प्लेलिस्ट का इस्तेमाल करता है. इस सूची में मौजूद हर playlistItem, अपलोड किए गए एक वीडियो को दिखाता है. किसी चैनल के लिए, channel रिसॉर्स से उस सूची का प्लेलिस्ट आईडी वापस पाया जा सकता है. इसके बाद, सूची में playlistItems.list तरीके का इस्तेमाल किया जा सकता है.
तरीके
एपीआई, playlistItems संसाधनों के लिए इन तरीकों का इस्तेमाल करता है:
- list
- यह एपीआई अनुरोध के पैरामीटर से मेल खाने वाले प्लेलिस्ट आइटम का कलेक्शन दिखाता है. किसी प्लेलिस्ट में मौजूद सभी आइटम को वापस लाया जा सकता है. इसके अलावा, एक या उससे ज़्यादा आइटम को उनके यूनीक आईडी के हिसाब से भी वापस लाया जा सकता है. इसे अभी आज़माएं.
- insert
- किसी संसाधन को प्लेलिस्ट में जोड़ता है. इसे अभी आज़माएं.
- अपडेट करें
- किसी प्लेलिस्ट आइटम में बदलाव करता है. उदाहरण के लिए, प्लेलिस्ट में आइटम की जगह अपडेट की जा सकती है. इसे अभी आज़माएं.
- मिटाएं
- प्लेलिस्ट आइटम मिटाता है. इसे अभी आज़माएं.
संसाधन का रेप्रज़ेंटेशन
यहां दिए गए 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 |
objectsnippet ऑब्जेक्ट में प्लेलिस्ट आइटम के बारे में बुनियादी जानकारी होती है. जैसे, उसका टाइटल और प्लेलिस्ट में उसकी पोज़िशन. |
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 |
objectid ऑब्जेक्ट में ऐसी जानकारी होती है जिसका इस्तेमाल, प्लेलिस्ट में शामिल उस संसाधन की पहचान करने के लिए किया जा सकता है जिसे प्लेलिस्ट आइटम के तौर पर शामिल किया गया है. |
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 |
datetimeYouTube पर वीडियो पब्लिश करने की तारीख और समय. वैल्यू को ISO 8601 फ़ॉर्मैट में तय किया जाता है. |
status |
objectstatus ऑब्जेक्ट में, प्लेलिस्ट आइटम की निजता की स्थिति के बारे में जानकारी होती है. |
status.privacyStatus |
stringप्लेलिस्ट में शामिल आइटम की निजता की स्थिति. प्लेलिस्ट आइटम के तौर पर मौजूद वीडियो को अपलोड करने वाला चैनल, videos.insert या videos.update तरीके का इस्तेमाल करके इस वैल्यू को सेट कर सकता है. |