एपीआई अनुरोध पैरामीटर से मेल खाने वाले प्लेलिस्ट आइटम का संग्रह दिखाता है. किसी प्लेलिस्ट में मौजूद सभी आइटम को फिर से डाउनलोड किया जा सकता है. इसके अलावा, एक या एक से ज़्यादा प्लेलिस्ट आइटम को उनके यूनीक आईडी के हिसाब से भी लाया जा सकता है.
कोटा पर असर: इस तरीके का इस्तेमाल करने पर एक यूनिट की कोटे की कीमत लागू होती है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/playlistItems
पैरामीटर
इस टेबल में वे पैरामीटर दिए गए हैं जो इस क्वेरी पर काम करते हैं. सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर, एक या एक से ज़्यादा playlistItem संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. इस सूची में एपीआई के रिस्पॉन्स शामिल होंगे.अगर पैरामीटर किसी ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी शामिल हैं, तो जवाब में चाइल्ड प्रॉपर्टी शामिल हो जाएंगी. उदाहरण के लिए, playlistItem संसाधन में, snippet प्रॉपर्टी में कई फ़ील्ड होते हैं, जिनमें title , description , position , और resourceId प्रॉपर्टी शामिल हैं. इसलिए, अगर part=snippet को सेट किया जाता है, तो एपीआई से मिले रिस्पॉन्स में वे सभी प्रॉपर्टी शामिल होंगी.यहां दी गई सूची में part नाम हैं, जिन्हें पैरामीटर की वैल्यू में शामिल किया जा सकता है:
|
|
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं) | ||
id |
string id पैरामीटर, एक या एक से ज़्यादा यूनीक प्लेलिस्ट आइटम आईडी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. |
|
playlistId |
string playlistId पैरामीटर उस प्लेलिस्ट का यूनीक आईडी तय करता है जिसके लिए आपको प्लेलिस्ट में आइटम वापस लाने हैं. ध्यान दें, भले ही यह एक वैकल्पिक पैरामीटर है, लेकिन प्लेलिस्ट के आइटम वापस पाने के हर अनुरोध में, id पैरामीटर या playlistId पैरामीटर के लिए वैल्यू तय की जानी चाहिए. |
|
वैकल्पिक पैरामीटर | ||
maxResults |
unsigned integer maxResults पैरामीटर से यह तय होता है कि ज़्यादा से ज़्यादा कितने आइटम, नतीजे के सेट में दिखाए जाने चाहिए. स्वीकार किए जाने वाले मान 0 से 50 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
onBehalfOfContentOwner |
string इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई अलग-अलग YouTube चैनलों का मालिकाना हक होता है और उन्हें मैनेज करने का अधिकार होता है. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के साथ-साथ, अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं पड़ती. उपयोगकर्ता जिस कॉन्टेंट मैनेजमेंट सिस्टम से पुष्टि करता है वह खाता, YouTube कॉन्टेंट के उस मालिक से जुड़ा होना चाहिए. |
|
pageToken |
string pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है. |
|
videoId |
string videoId पैरामीटर से यह पता चलता है कि अनुरोध करने पर, प्लेलिस्ट में मौजूद सिर्फ़ वे आइटम दिखेंगे जिनमें यह वीडियो शामिल है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर यह तरीका काम करता है, तो यह इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "youtube#playlistItemListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistItem Resource ] }
प्रॉपर्टी
यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string इससे पता चलता है कि एपीआई रिसॉर्स किस तरह का है. मान youtube#playlistItemListResponse होगा. |
etag |
etag इस संसाधन का ईटैग. |
nextPageToken |
string नतीजे के सेट का अगला पेज वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
prevPageToken |
string नतीजे के सेट में पिछले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजे के सेट में मौजूद नतीजों की कुल संख्या. |
pageInfo.resultsPerPage |
integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या. |
items[] |
list प्लेलिस्ट में मौजूद ऐसे आइटम की सूची जो अनुरोध की शर्तों को पूरा करते हैं. |
उदाहरण
ध्यान दें: हो सकता है कि यहां दिए गए कोड सैंपल, इस्तेमाल की जा सकने वाली सभी प्रोग्रामिंग भाषाओं को न दिखाते हों. इस्तेमाल की जा सकने वाली भाषाओं की सूची देखने के लिए, क्लाइंट लाइब्रेरी के दस्तावेज़ देखें.
शुरू करें
यह कोड सैंपल, एपीआई केplaylistItems.list
तरीके को कॉल करता है, ताकि अनुरोध से जुड़े चैनल पर अपलोड किए गए वीडियो की सूची हासिल की जा सके. यह कोड, channels.list
तरीके को भी कॉल करता है. इसमें mine
पैरामीटर true
पर सेट होता है, ताकि चैनल के अपलोड किए गए वीडियो की पहचान करने वाले प्लेलिस्ट आईडी को वापस पाया जा सके.
इस उदाहरण में, Go क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है.
package main import ( "fmt" "log" "google.golang.org/api/youtube/v3" ) // Retrieve playlistItems in the specified playlist func playlistItemsList(service *youtube.Service, part string, playlistId string, pageToken string) *youtube.PlaylistItemListResponse { call := service.PlaylistItems.List(part) call = call.PlaylistId(playlistId) if pageToken != "" { call = call.PageToken(pageToken) } response, err := call.Do() handleError(err, "") return response } // Retrieve resource for the authenticated user's channel func channelsListMine(service *youtube.Service, part string) *youtube.ChannelListResponse { call := service.Channels.List(part) call = call.Mine(true) response, err := call.Do() handleError(err, "") return response } func main() { client := getClient(youtube.YoutubeReadonlyScope) service, err := youtube.New(client) if err != nil { log.Fatalf("Error creating YouTube client: %v", err) } response := channelsListMine(service, "contentDetails") for _, channel := range response.Items { playlistId := channel.ContentDetails.RelatedPlaylists.Uploads // Print the playlist ID for the list of uploaded videos. fmt.Printf("Videos in list %s\r\n", playlistId) nextPageToken := "" for { // Retrieve next set of items in the playlist. playlistResponse := playlistItemsList(service, "snippet", playlistId, nextPageToken) for _, playlistItem := range playlistResponse.Items { title := playlistItem.Snippet.Title videoId := playlistItem.Snippet.ResourceId.VideoId fmt.Printf("%v, (%v)\r\n", title, videoId) } // Set the token to retrieve the next page of results // or exit the loop if all results have been retrieved. nextPageToken = playlistResponse.NextPageToken if nextPageToken == "" { break } fmt.Println() } } }
.NET
नीचे दिए गए कोड सैंपल में, एपीआई केplaylistItems.list
तरीके को कॉल किया जाता है, ताकि अनुरोध से जुड़े चैनल पर अपलोड किए गए वीडियो की सूची हासिल की जा सके. यह कोड, channels.list
तरीके को भी कॉल करता है. इसमें mine
पैरामीटर true
पर सेट होता है, ताकि चैनल के अपलोड किए गए वीडियो की पहचान करने वाले प्लेलिस्ट आईडी को हासिल किया जा सके.
इस उदाहरण में, .NET क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है.
using System; using System.IO; using System.Reflection; using System.Threading; using System.Threading.Tasks; using Google.Apis.Auth.OAuth2; using Google.Apis.Services; using Google.Apis.Upload; using Google.Apis.Util.Store; using Google.Apis.YouTube.v3; using Google.Apis.YouTube.v3.Data; namespace Google.Apis.YouTube.Samples { /// <summary> /// YouTube Data API v3 sample: retrieve my uploads. /// Relies on the Google APIs Client Library for .NET, v1.7.0 or higher. /// See https://developers.google.com/api-client-library/dotnet/get_started /// </summary> internal class MyUploads { [STAThread] static void Main(string[] args) { Console.WriteLine("YouTube Data API: My Uploads"); Console.WriteLine("============================"); try { new MyUploads().Run().Wait(); } catch (AggregateException ex) { foreach (var e in ex.InnerExceptions) { Console.WriteLine("Error: " + e.Message); } } Console.WriteLine("Press any key to continue..."); Console.ReadKey(); } private async Task Run() { UserCredential credential; using (var stream = new FileStream("client_secrets.json", FileMode.Open, FileAccess.Read)) { credential = await GoogleWebAuthorizationBroker.AuthorizeAsync( GoogleClientSecrets.Load(stream).Secrets, // This OAuth 2.0 access scope allows for read-only access to the authenticated // user's account, but not other types of account access. new[] { YouTubeService.Scope.YoutubeReadonly }, "user", CancellationToken.None, new FileDataStore(this.GetType().ToString()) ); } var youtubeService = new YouTubeService(new BaseClientService.Initializer() { HttpClientInitializer = credential, ApplicationName = this.GetType().ToString() }); var channelsListRequest = youtubeService.Channels.List("contentDetails"); channelsListRequest.Mine = true; // Retrieve the contentDetails part of the channel resource for the authenticated user's channel. var channelsListResponse = await channelsListRequest.ExecuteAsync(); foreach (var channel in channelsListResponse.Items) { // From the API response, extract the playlist ID that identifies the list // of videos uploaded to the authenticated user's channel. var uploadsListId = channel.ContentDetails.RelatedPlaylists.Uploads; Console.WriteLine("Videos in list {0}", uploadsListId); var nextPageToken = ""; while (nextPageToken != null) { var playlistItemsListRequest = youtubeService.PlaylistItems.List("snippet"); playlistItemsListRequest.PlaylistId = uploadsListId; playlistItemsListRequest.MaxResults = 50; playlistItemsListRequest.PageToken = nextPageToken; // Retrieve the list of videos uploaded to the authenticated user's channel. var playlistItemsListResponse = await playlistItemsListRequest.ExecuteAsync(); foreach (var playlistItem in playlistItemsListResponse.Items) { // Print information about each video. Console.WriteLine("{0} ({1})", playlistItem.Snippet.Title, playlistItem.Snippet.ResourceId.VideoId); } nextPageToken = playlistItemsListResponse.NextPageToken; } } } } }
Ruby
यह सैंपल, एपीआई केplaylistItems.list
तरीके को कॉल करता है, ताकि अनुरोध से जुड़े चैनल पर अपलोड किए गए वीडियो की सूची वापस पाई जा सके. यह कोड, channels.list
तरीके को भी कॉल करता है. इसमें mine
पैरामीटर true
पर सेट होता है, ताकि चैनल के अपलोड किए गए वीडियो की पहचान करने वाले प्लेलिस्ट आईडी को हासिल किया जा सके.
इस उदाहरण में, Ruby क्लाइंट लाइब्रेरी का इस्तेमाल किया गया है.
#!/usr/bin/ruby require 'rubygems' gem 'google-api-client', '>0.7' require 'google/api_client' require 'google/api_client/client_secrets' require 'google/api_client/auth/file_storage' require 'google/api_client/auth/installed_app' # This OAuth 2.0 access scope allows for read-only access to the authenticated # user's account, but not other types of account access. YOUTUBE_READONLY_SCOPE = 'https://www.googleapis.com/auth/youtube.readonly' YOUTUBE_API_SERVICE_NAME = 'youtube' YOUTUBE_API_VERSION = 'v3' def get_authenticated_service client = Google::APIClient.new( :application_name => $PROGRAM_NAME, :application_version => '1.0.0' ) youtube = client.discovered_api(YOUTUBE_API_SERVICE_NAME, YOUTUBE_API_VERSION) file_storage = Google::APIClient::FileStorage.new("#{$PROGRAM_NAME}-oauth2.json") if file_storage.authorization.nil? client_secrets = Google::APIClient::ClientSecrets.load flow = Google::APIClient::InstalledAppFlow.new( :client_id => client_secrets.client_id, :client_secret => client_secrets.client_secret, :scope => [YOUTUBE_READONLY_SCOPE] ) client.authorization = flow.authorize(file_storage) else client.authorization = file_storage.authorization end return client, youtube end def main client, youtube = get_authenticated_service begin # Retrieve the "contentDetails" part of the channel resource for the # authenticated user's channel. channels_response = client.execute!( :api_method => youtube.channels.list, :parameters => { :mine => true, :part => 'contentDetails' } ) channels_response.data.items.each do |channel| # From the API response, extract the playlist ID that identifies the list # of videos uploaded to the authenticated user's channel. uploads_list_id = channel['contentDetails']['relatedPlaylists']['uploads'] # Retrieve the list of videos uploaded to the authenticated user's channel. next_page_token = '' until next_page_token.nil? playlistitems_response = client.execute!( :api_method => youtube.playlist_items.list, :parameters => { :playlistId => uploads_list_id, :part => 'snippet', :maxResults => 50, :pageToken => next_page_token } ) puts "Videos in list #{uploads_list_id}" # Print information about each video. playlistitems_response.data.items.each do |playlist_item| title = playlist_item['snippet']['title'] video_id = playlist_item['snippet']['resourceId']['videoId'] puts "#{title} (#{video_id})" end next_page_token = playlistitems_response.next_page_token end puts end rescue Google::APIClient::TransmissionError => e puts e.result.body end end main
गड़बड़ियां
नीचे दी गई टेबल में गड़बड़ी के ऐसे मैसेज की पहचान की गई है जिन्हें एपीआई इस तरीके को कॉल करने पर जवाब दे सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी के मैसेज का दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
forbidden (403) |
playlistItemsNotAccessible |
बताई गई प्लेलिस्ट को वापस पाने के लिए, अनुरोध करने की अनुमति सही नहीं है. |
forbidden (403) |
watchHistoryNotAccessible |
एपीआई की मदद से, वीडियो देखने के इतिहास का डेटा नहीं मिल सकता. |
forbidden (403) |
watchLaterNotAccessible |
"बाद में देखें" प्लेलिस्ट में मौजूद आइटम को एपीआई की मदद से वापस नहीं लाया जा सकता. |
notFound (404) |
playlistNotFound |
अनुरोध के playlistId पैरामीटर से पहचानी गई प्लेलिस्ट नहीं मिली. |
notFound (404) |
videoNotFound |
अनुरोध के videoId पैरामीटर से पहचाना गया वीडियो नहीं मिला. |
required (400) |
playlistIdRequired |
सदस्यता के अनुरोध में, ज़रूरी playlistId प्रॉपर्टी के लिए कोई वैल्यू नहीं बताई गई है. |
invalidValue (400) |
playlistOperationUnsupported |
एपीआई किसी खास प्लेलिस्ट में वीडियो की सूची बनाने की सुविधा नहीं देता. उदाहरण के लिए, 'बाद में देखें' प्लेलिस्ट में किसी वीडियो को शामिल नहीं किया जा सकता. |
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.