blob: 357209cd5a4b4d1e69ca73d43148ba0c6e983121 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.videos.html">videos</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#list">list(id, part, contentOwnerId=None)</a></code></p>
<p class="firstline">Browse the YouTube video collection.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="list">list(id, part, contentOwnerId=None)</code>
<pre>Browse the YouTube video collection.
Args:
id: string, YouTube IDs of the videos to be returned. (required)
part: string, Parts of the video resource to be returned. (required)
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
Returns:
An object of the form:
{ # JSON template for a VideoService.List() response.
"kind": "youtube#videoListResponse", # The type of this API response.
"etag": "A String", # The eTag of the response.
"videos": { # Map of videos matching the request criteria, keyed by video id.
"a_key": { # JSON template for a YouTube Video. # An entry in the "videos" map: the key is the video id, the value is the video resource.
"status": { # JSON template for the status part of a video. # Status of the video upload, privacy status.
"privacyStatus": "A String", # Privacy of the video.
"uploadStatus": "A String", # Status of the video upload.
"rejectionReason": "A String", # Present only if the uploadStatus indicates a rejected upload.
"failureReason": "A String", # Present only if the uploadStatus indicates a failed upload.
},
"kind": "youtube#video", # The type of this API resource.
"statistics": { # JSON template for the statistics part of a video. # Statistics about the video: number of views, ratings.
"commentCount": "A String", # Number of comments for this video.
"viewCount": "A String", # Number of times the video was viewed.
"favoriteCount": "A String", # Number of times the video was added to a user's favorites list.
"dislikeCount": "A String", # Number of times the video was disliked.
"likeCount": "A String", # Number of times the video was liked.
},
"contentDetails": { # JSON template for the content details part of a video. # Information about the video content, media file.
"duration": "A String", # Duration of the video.
"aspectRatio": "A String", # The aspect ratio of the video.
},
"snippet": { # JSON template for the snippet part of a video. # Basic details about the video: title, description, thumbnails.
"thumbnails": { # Video thumbnails.
"a_key": { # JSON template for a thumbnail. # The name of the thumbnail.
"url": "A String", # The URL for the thumbnail.
},
},
"tags": [ # Textual tags associated with the video.
"A String",
],
"channelId": "A String", # Channel the video was uploaded into.
"publishedAt": "A String", # Date time the video was uploaded.
"title": "A String", # Title of the video.
"categoryId": "A String", # Video category the video belongs to.
"description": "A String", # Description of the video.
},
"player": { # JSON template for the player part of a video. # Information used to play the video.
"embedHtml": "A String", # Iframe embed for the video.
},
"etag": "A String", # The eTag of the video.
"id": "A String", # The unique id of the video.
},
},
}</pre>
</div>
</body></html>