blob: b89a224a5faa6501faac5db1d615f90ac68f1a4a [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.videos.html">videos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(id, part)</a></code></p>
79<p class="firstline">Browse the YouTube video collection.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="list">list(id, part)</code>
83 <pre>Browse the YouTube video collection.
84
85Args:
86 id: string, YouTube IDs of the videos to be returned. (required)
87 part: string, Parts of the video resource to be returned. (required)
88
89Returns:
90 An object of the form:
91
92 { # JSON template for a VideoService.List() response.
93 "kind": "youtube#videoListResponse", # The type of this API response.
94 "etag": "A String", # The eTag of the response.
95 "videos": [ # List of videos matching the request criteria.
96 { # JSON template for a YouTube Video.
97 "status": { # JSON template for the status part of a video. # Status of the video upload, privacy status.
98 "privacyStatus": "A String", # Privacy of the video.
99 "uploadStatus": "A String", # Status of the video upload.
100 "rejectionReason": "A String", # Present only if the uploadStatus indicates a rejected upload.
101 "failureReason": "A String", # Present only if the uploadStatus indicates a failed upload.
102 },
103 "kind": "youtube#video", # The type of this API resource.
104 "statistics": { # JSON template for the statistics part of a video. # Statistics about the video: number of views, ratings.
105 "commentCount": "A String", # Number of comments for this video.
106 "viewCount": "A String", # Number of times the video was viewed.
107 "favoriteCount": "A String", # Number of times the video was added to a user's favorites list.
108 "dislikeCount": "A String", # Number of times the video was disliked.
109 "likeCount": "A String", # Number of times the video was liked.
110 },
111 "contentDetails": { # JSON template for the content details part of a video. # Information about the video content, media file.
112 "duration": "A String", # Duration of the video.
113 "aspectRatio": "A String", # The aspect ratio of the video.
114 },
115 "snippet": { # JSON template for the snippet part of a video. # Basic details about the video: title, description, thumbnails.
116 "thumbnails": { # Video thumbnails.
117 },
118 "title": "A String", # Title of the video.
119 "channelId": "A String", # Channel the video was uploaded to.
120 "categoryId": "A String", # Video category the video belongs to.
121 "tags": [ # Textual tags associated with the video.
122 "A String",
123 ],
124 "description": "A String", # Description of the video.
125 },
126 "player": { # JSON template for the player part of a video. # Information used to play the video.
127 "embed": "A String", # Iframe embed for the video.
128 },
129 "etag": "A String", # The eTag of the video.
130 "id": "A String", # The unique id of the video.
131 },
132 ],
133 }</pre>
134</div>
135
136</body></html>