blob: 8c571c4ce5815ae586bbfc5ca11c95703b06fc12 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.playlists.html">playlists</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Joe Gregorio1b425aa2012-08-24 12:04:34 -040078 <code><a href="#list">list(id, part, contentOwnerId=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -040079<p class="firstline">Browse the YouTube playlist collection.</p>
80<h3>Method Details</h3>
81<div class="method">
Joe Gregorio1b425aa2012-08-24 12:04:34 -040082 <code class="details" id="list">list(id, part, contentOwnerId=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -040083 <pre>Browse the YouTube playlist collection.
84
85Args:
86 id: string, YouTube IDs of the playlists to be returned. (required)
87 part: string, Parts of the playlist resource to be returned. (required)
Joe Gregorio1b425aa2012-08-24 12:04:34 -040088 contentOwnerId: string, The authenticated user acts on behalf of this content owner.
Joe Gregorio075572b2012-07-09 16:53:09 -040089
90Returns:
91 An object of the form:
92
93 { # JSON template for a PlaylistService.List() response.
94 "kind": "youtube#playlistListResponse", # The type of this API response.
95 "etag": "A String", # The eTag of the response.
Joe Gregorioe7a0c472012-07-12 11:46:04 -040096 "playlists": { # Map of playlists matching the request criteria, keyed by id.
Joe Gregorio1b425aa2012-08-24 12:04:34 -040097 "a_key": { # JSON template for a YouTube Playlist. # An entry in the "playlists" map: the key is the playlist id, the value is the playlist resource.
Joe Gregoriofa08c2e2012-07-23 16:52:03 -040098 "snippet": { # JSON template for the snippet part of a playlist. # Basic details about the playlist: title, description, thumbnails.
99 "title": "A String", # Title of the playlist.
100 "channelId": "A String", # Author of the playlist.
101 "description": "A String", # Description of the playlist.
102 "publishedAt": "A String", # The date and time the playlist was created.
103 "tags": [ # Textual tags associated with the playlist.
104 "A String",
105 ],
106 },
107 "kind": "youtube#playlist", # The type of this API resource.
108 "etag": "A String", # The eTag of the playlist.
109 "id": "A String", # The unique id of the playlist.
110 },
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400111 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400112 }</pre>
113</div>
114
115</body></html>