blob: 3b8149d37533da1fd60a50fce40f8297d73d62d7 [file] [log] [blame]
Joe Gregoriod67010d2012-11-05 08:57:06 -05001<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
Joe Gregorio52a5c532013-01-24 16:19:07 -050075<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.videos.html">videos</a></h1>
Joe Gregoriod67010d2012-11-05 08:57:06 -050076<h2>Instance Methods</h2>
77<p class="toc_element">
Joe Gregorio41be8e82013-03-07 10:31:47 -050078 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -050079<p class="firstline">Deletes a YouTube video.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -050080<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -040081 <code><a href="#getRating">getRating(id, onBehalfOfContentOwner=None)</a></code></p>
82<p class="firstline">Get user ratings for videos.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(part=None, body=None, media_body=None, onBehalfOfContentOwner=None, stabilize=None, onBehalfOfContentOwnerChannel=None, autoLevels=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -050085<p class="firstline">Uploads a video to YouTube and optionally sets the video's metadata.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -050086<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -040087 <code><a href="#list">list(part=None, pageToken=None, onBehalfOfContentOwner=None, locale=None, chart=None, maxResults=None, videoCategoryId=None, myRating=None, id=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -050088<p class="firstline">Returns a list of videos that match the API request parameters.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -050089<p class="toc_element">
Joe Gregorio37802c32013-08-06 12:24:05 -040090 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#rate">rate(id, rating, onBehalfOfContentOwner=None)</a></code></p>
94<p class="firstline">Like, dislike, or remove rating from a video.</p>
95<p class="toc_element">
Joe Gregorio41be8e82013-03-07 10:31:47 -050096 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
Joe Gregorio52a5c532013-01-24 16:19:07 -050097<p class="firstline">Updates a video's metadata.</p>
Joe Gregoriod67010d2012-11-05 08:57:06 -050098<h3>Method Details</h3>
99<div class="method">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500100 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500101 <pre>Deletes a YouTube video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500102
103Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500104 id: string, The id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID. (required)
Joe Gregorio37802c32013-08-06 12:24:05 -0400105 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
Joe Gregoriod67010d2012-11-05 08:57:06 -0500106</pre>
107</div>
108
109<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400110 <code class="details" id="getRating">getRating(id, onBehalfOfContentOwner=None)</code>
111 <pre>Get user ratings for videos.
112
113Args:
114 id: string, The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID. (required)
115 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
116
117Returns:
118 An object of the form:
119
120 { # A list of video ratings returned as the response to a youtube.videos.getRating call.
121 "items": [ # A list of ratings that match the request criteria.
122 { # Basic details about rating of a video.
123 "rating": "A String", # Rating of a video.
124 "videoId": "A String", # The ID that YouTube uses to uniquely identify the video.
125 },
126 ],
127 "kind": "youtube#videoGetRatingResponse", # The type of the API response. For this operation, the value will be youtube#videoGetRatingResponse.
128 "etag": "A String", # The ETag of the response.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="insert">insert(part=None, body=None, media_body=None, onBehalfOfContentOwner=None, stabilize=None, onBehalfOfContentOwnerChannel=None, autoLevels=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500134 <pre>Uploads a video to YouTube and optionally sets the video's metadata.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500135
136Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500137 part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
138
139The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails. However, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500140 body: object, The request body.
141 The object takes the form of:
142
Joe Gregorio52a5c532013-01-24 16:19:07 -0500143{ # A video resource represents a YouTube video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400144 "status": { # Basic details about a video category, such as its localized title. # The status object contains information about the video's uploading, processing, and privacy statuses.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500145 "license": "A String", # The video's license.
146 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500147 "privacyStatus": "A String", # The video's privacy status.
Joe Gregorio37802c32013-08-06 12:24:05 -0400148 "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500149 "uploadStatus": "A String", # The status of the uploaded video.
150 "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
151 "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500152 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500153 "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
154 "description": "A String", # The video's description.
155 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500156 "A String",
157 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500158 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
159 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
160 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
161 "title": "A String", # The video's title.
162 "categoryId": "A String", # The YouTube video category associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400163 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
164 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
165 "url": "A String", # The thumbnail image's URL.
166 "width": 42, # (Optional) Width of the thumbnail image.
167 "height": 42, # (Optional) Height of the thumbnail image.
168 },
169 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
170 "url": "A String", # The thumbnail image's URL.
171 "width": 42, # (Optional) Width of the thumbnail image.
172 "height": 42, # (Optional) Height of the thumbnail image.
173 },
174 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
175 "url": "A String", # The thumbnail image's URL.
176 "width": 42, # (Optional) Width of the thumbnail image.
177 "height": 42, # (Optional) Height of the thumbnail image.
178 },
179 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
180 "url": "A String", # The thumbnail image's URL.
181 "width": 42, # (Optional) Width of the thumbnail image.
182 "height": 42, # (Optional) Height of the thumbnail image.
183 },
184 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500185 "url": "A String", # The thumbnail image's URL.
186 "width": 42, # (Optional) Width of the thumbnail image.
187 "height": 42, # (Optional) Height of the thumbnail image.
188 },
189 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500190 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400191 "kind": "youtube#video", # The kind, fixed to "youtube#video".
Joe Gregorio52a5c532013-01-24 16:19:07 -0500192 "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
193 "commentCount": "A String", # The number of comments for the video.
194 "viewCount": "A String", # The number of times the video has been viewed.
195 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
196 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
197 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500198 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500199 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400200 "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.
201 "A String",
202 ],
203 "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500204 "A String",
205 ],
206 },
207 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
208 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
209 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
210 "A String",
211 ],
212 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
213 },
214 },
215 "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
216 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
217 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
218 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
219 "A String",
220 ],
221 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
222 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400223 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. # Specifies the ratings that the video received under various rating schemes.
224 "ytRating": "A String", # Internal YouTube rating.
225 "russiaRating": "A String", # Rating system in Russia
226 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
227 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
228 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
229 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
230 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
231 "bbfcRating": "A String", # British Board of Film Classification
232 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
233 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
234 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
235 "fmocRating": "A String", # Rating system in France - French Minister of Culture
236 "chvrsRating": "A String", # Canadian Home Video Rating System
237 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
238 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
239 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
240 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500241 "caption": "A String", # The value of captions indicates whether the video has captions or not.
242 "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500243 "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500244 "A String",
245 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500246 "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500247 "A String",
248 ],
249 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500250 "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
251 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
252 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500253 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400254 "ageGating": { # Age restriction details related to a video.
255 "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
256 "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
257 "videoGameRating": "A String", # Video game rating, if any.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500258 },
259 "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
260 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
261 "container": "A String", # The uploaded video file's container format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400262 "recordingLocation": { # Geographical coordinates of a point, in WGS84. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500263 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400264 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500265 "longitude": 3.14, # Longitude in degrees.
266 },
267 "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
268 "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
269 # - Date only: YYYY-MM-DD
270 # - Naive time: YYYY-MM-DDTHH:MM:SS
271 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
272 "durationMs": "A String", # The length of the uploaded video in milliseconds.
273 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
274 "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
275 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
276 { # Information about a video stream.
277 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
278 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
279 "codec": "A String", # The video codec that the stream uses.
280 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
281 "heightPixels": 42, # The encoded video content's height in pixels.
282 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
283 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
284 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
285 },
286 ],
287 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
288 { # Information about an audio stream.
289 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
290 "codec": "A String", # The audio codec that the stream uses.
291 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
292 "channelCount": 42, # The number of audio channels that the stream contains.
293 },
294 ],
295 },
296 "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
297 #
298 # The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
299 "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
300 "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
301 "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
302 "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
303 "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
304 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
305 "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
306 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
307 "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
308 # 100 * parts_processed / parts_total
309 #
310 # Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
311 "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
312 },
313 "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500314 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500315 "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
316 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500317 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400318 "etag": "A String", # Etag of this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500319 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
320 "tags": [ # A list of project tags associated with the video during the upload.
321 "A String",
322 ],
323 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500324 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
325 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
326 "locationDescription": "A String", # The text description of the location where the video was recorded.
Joe Gregorio37802c32013-08-06 12:24:05 -0400327 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500328 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400329 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500330 "longitude": 3.14, # Longitude in degrees.
331 },
332 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400333 "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
334 "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
335 "A String",
336 ],
337 "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
338 { # A single tag suggestion with it's relevance information.
339 "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
340 "A String",
341 ],
342 "tag": "A String", # The keyword tag suggested for the video.
343 },
344 ],
345 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
346 "A String",
347 ],
348 "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
349 "A String",
350 ],
351 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
352 "A String",
353 ],
354 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500355 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400356 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
357 "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
358 {
359 "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
360 "context": "A String", # Defines the context of the ping.
361 },
362 ],
363 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500364 }
365
366 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Joe Gregorio37802c32013-08-06 12:24:05 -0400367 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
368 stabilize: boolean, The stabilize parameter specifies whether the video should be stabilized by YouTube.
369 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
370
371The onBehalfOfContentOwnerChannel parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the channel specified in the parameter value. This parameter must be used in conjunction with the onBehalfOfContentOwner parameter, and the user must be authenticated using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. In addition, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
372
373This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
374 autoLevels: boolean, The autoLevels parameter specifies whether the video should be auto-leveled by YouTube.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500375
376Returns:
377 An object of the form:
378
Joe Gregorio52a5c532013-01-24 16:19:07 -0500379 { # A video resource represents a YouTube video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400380 "status": { # Basic details about a video category, such as its localized title. # The status object contains information about the video's uploading, processing, and privacy statuses.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500381 "license": "A String", # The video's license.
382 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500383 "privacyStatus": "A String", # The video's privacy status.
Joe Gregorio37802c32013-08-06 12:24:05 -0400384 "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500385 "uploadStatus": "A String", # The status of the uploaded video.
386 "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
387 "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500388 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500389 "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
390 "description": "A String", # The video's description.
391 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500392 "A String",
393 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500394 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
395 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
396 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
397 "title": "A String", # The video's title.
398 "categoryId": "A String", # The YouTube video category associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400399 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
400 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
401 "url": "A String", # The thumbnail image's URL.
402 "width": 42, # (Optional) Width of the thumbnail image.
403 "height": 42, # (Optional) Height of the thumbnail image.
404 },
405 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
406 "url": "A String", # The thumbnail image's URL.
407 "width": 42, # (Optional) Width of the thumbnail image.
408 "height": 42, # (Optional) Height of the thumbnail image.
409 },
410 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
411 "url": "A String", # The thumbnail image's URL.
412 "width": 42, # (Optional) Width of the thumbnail image.
413 "height": 42, # (Optional) Height of the thumbnail image.
414 },
415 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
416 "url": "A String", # The thumbnail image's URL.
417 "width": 42, # (Optional) Width of the thumbnail image.
418 "height": 42, # (Optional) Height of the thumbnail image.
419 },
420 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500421 "url": "A String", # The thumbnail image's URL.
422 "width": 42, # (Optional) Width of the thumbnail image.
423 "height": 42, # (Optional) Height of the thumbnail image.
424 },
425 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500426 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400427 "kind": "youtube#video", # The kind, fixed to "youtube#video".
Joe Gregorio52a5c532013-01-24 16:19:07 -0500428 "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
429 "commentCount": "A String", # The number of comments for the video.
430 "viewCount": "A String", # The number of times the video has been viewed.
431 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
432 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
433 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500434 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500435 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400436 "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.
437 "A String",
438 ],
439 "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500440 "A String",
441 ],
442 },
443 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
444 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
445 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
446 "A String",
447 ],
448 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
449 },
450 },
451 "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
452 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
453 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
454 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
455 "A String",
456 ],
457 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
458 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400459 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. # Specifies the ratings that the video received under various rating schemes.
460 "ytRating": "A String", # Internal YouTube rating.
461 "russiaRating": "A String", # Rating system in Russia
462 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
463 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
464 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
465 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
466 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
467 "bbfcRating": "A String", # British Board of Film Classification
468 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
469 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
470 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
471 "fmocRating": "A String", # Rating system in France - French Minister of Culture
472 "chvrsRating": "A String", # Canadian Home Video Rating System
473 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
474 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
475 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
476 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500477 "caption": "A String", # The value of captions indicates whether the video has captions or not.
478 "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500479 "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500480 "A String",
481 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500482 "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500483 "A String",
484 ],
485 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500486 "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
487 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
488 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500489 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400490 "ageGating": { # Age restriction details related to a video.
491 "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
492 "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
493 "videoGameRating": "A String", # Video game rating, if any.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500494 },
495 "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
496 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
497 "container": "A String", # The uploaded video file's container format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400498 "recordingLocation": { # Geographical coordinates of a point, in WGS84. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500499 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400500 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500501 "longitude": 3.14, # Longitude in degrees.
502 },
503 "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
504 "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
505 # - Date only: YYYY-MM-DD
506 # - Naive time: YYYY-MM-DDTHH:MM:SS
507 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
508 "durationMs": "A String", # The length of the uploaded video in milliseconds.
509 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
510 "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
511 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
512 { # Information about a video stream.
513 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
514 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
515 "codec": "A String", # The video codec that the stream uses.
516 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
517 "heightPixels": 42, # The encoded video content's height in pixels.
518 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
519 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
520 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
521 },
522 ],
523 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
524 { # Information about an audio stream.
525 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
526 "codec": "A String", # The audio codec that the stream uses.
527 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
528 "channelCount": 42, # The number of audio channels that the stream contains.
529 },
530 ],
531 },
532 "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
533 #
534 # The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
535 "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
536 "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
537 "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
538 "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
539 "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
540 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
541 "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
542 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
543 "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
544 # 100 * parts_processed / parts_total
545 #
546 # Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
547 "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
548 },
549 "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500550 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500551 "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
552 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500553 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400554 "etag": "A String", # Etag of this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500555 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
556 "tags": [ # A list of project tags associated with the video during the upload.
557 "A String",
558 ],
559 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500560 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
561 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
562 "locationDescription": "A String", # The text description of the location where the video was recorded.
Joe Gregorio37802c32013-08-06 12:24:05 -0400563 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500564 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400565 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500566 "longitude": 3.14, # Longitude in degrees.
567 },
568 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400569 "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
570 "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
571 "A String",
572 ],
573 "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
574 { # A single tag suggestion with it's relevance information.
575 "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
576 "A String",
577 ],
578 "tag": "A String", # The keyword tag suggested for the video.
579 },
580 ],
581 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
582 "A String",
583 ],
584 "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
585 "A String",
586 ],
587 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
588 "A String",
589 ],
590 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500591 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400592 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
593 "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
594 {
595 "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
596 "context": "A String", # Defines the context of the ping.
597 },
598 ],
599 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500600 }</pre>
601</div>
602
603<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400604 <code class="details" id="list">list(part=None, pageToken=None, onBehalfOfContentOwner=None, locale=None, chart=None, maxResults=None, videoCategoryId=None, myRating=None, id=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500605 <pre>Returns a list of videos that match the API request parameters.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500606
607Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500608 part: string, The part parameter specifies a comma-separated list of one or more video resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, contentDetails, player, statistics, status, and topicDetails.
609
610If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties. (required)
Joe Gregorio37802c32013-08-06 12:24:05 -0400611 pageToken: string, USE_DESCRIPTION --- channels:list:pageToken
612 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
613 locale: string, The locale parameter selects a video chart available in the specified locale. If using this parameter, chart must also be set. The parameter value is an BCP 47 locale. Supported locales include ar_AE, ar_DZ, ar_EG, ar_JO, ar_MA, ar_SA, ar_TN, ar_YE, cs_CZ, de_DE, el_GR, en_AU, en_BE, en_CA, en_GB, en_GH, en_IE, en_IL, en_IN, en_KE, en_NG, en_NZ, en_SG, en_UG, en_US, en_ZA, es_AR, es_CL, es_CO, es_ES, es_MX, es_PE, fil_PH, fr_FR, hu_HU, id_ID, it_IT, ja_JP, ko_KR, ms_MY, nl_NL, pl_PL, pt_BR, ru_RU, sv_SE, tr_TR, zh_HK, zh_TW
614 chart: string, Set this parameter's value to mostPopular to instruct the API to return videos belonging to the chart of most popular videos.
615 Allowed values
616 mostPopular - Returns videos belonging to most popular video chart.
617 maxResults: integer, USE_DESCRIPTION --- channels:list:maxResults
618 videoCategoryId: string, The videoCategoryId parameter selects a video chart based on the category. If using this parameter, chart must also be set.
619 myRating: string, Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user.
620 Allowed values
621 dislike - Returns only videos disliked by the authenticated user.
622 like - Returns only video liked by the authenticated user.
623 id: string, The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500624
625Returns:
626 An object of the form:
627
628 { # A paginated list of videos returned as the response to a youtube.videos.list call.
Joe Gregorio37802c32013-08-06 12:24:05 -0400629 "eventId": "A String", # Serialized EventId of the request which produced this response.
630 "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
631 "kind": "youtube#videoListResponse", # The type of the API response. For this operation, the value will be youtube#videoListResponse.
632 "visitorId": "A String", # The visitorId identifies the visitor.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500633 "items": [ # A list of videos that match the request criteria.
634 { # A video resource represents a YouTube video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400635 "status": { # Basic details about a video category, such as its localized title. # The status object contains information about the video's uploading, processing, and privacy statuses.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500636 "license": "A String", # The video's license.
637 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500638 "privacyStatus": "A String", # The video's privacy status.
Joe Gregorio37802c32013-08-06 12:24:05 -0400639 "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500640 "uploadStatus": "A String", # The status of the uploaded video.
641 "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
642 "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500643 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500644 "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
645 "description": "A String", # The video's description.
646 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500647 "A String",
648 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500649 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
650 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
651 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
652 "title": "A String", # The video's title.
653 "categoryId": "A String", # The YouTube video category associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400654 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
655 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
656 "url": "A String", # The thumbnail image's URL.
657 "width": 42, # (Optional) Width of the thumbnail image.
658 "height": 42, # (Optional) Height of the thumbnail image.
659 },
660 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
661 "url": "A String", # The thumbnail image's URL.
662 "width": 42, # (Optional) Width of the thumbnail image.
663 "height": 42, # (Optional) Height of the thumbnail image.
664 },
665 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
666 "url": "A String", # The thumbnail image's URL.
667 "width": 42, # (Optional) Width of the thumbnail image.
668 "height": 42, # (Optional) Height of the thumbnail image.
669 },
670 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
671 "url": "A String", # The thumbnail image's URL.
672 "width": 42, # (Optional) Width of the thumbnail image.
673 "height": 42, # (Optional) Height of the thumbnail image.
674 },
675 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500676 "url": "A String", # The thumbnail image's URL.
677 "width": 42, # (Optional) Width of the thumbnail image.
678 "height": 42, # (Optional) Height of the thumbnail image.
679 },
680 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500681 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400682 "kind": "youtube#video", # The kind, fixed to "youtube#video".
Joe Gregorio52a5c532013-01-24 16:19:07 -0500683 "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
684 "commentCount": "A String", # The number of comments for the video.
685 "viewCount": "A String", # The number of times the video has been viewed.
686 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
687 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
688 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500689 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500690 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400691 "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.
692 "A String",
693 ],
694 "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500695 "A String",
696 ],
697 },
698 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
699 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
700 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
701 "A String",
702 ],
703 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
704 },
705 },
706 "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
707 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
708 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
709 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
710 "A String",
711 ],
712 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
713 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400714 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. # Specifies the ratings that the video received under various rating schemes.
715 "ytRating": "A String", # Internal YouTube rating.
716 "russiaRating": "A String", # Rating system in Russia
717 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
718 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
719 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
720 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
721 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
722 "bbfcRating": "A String", # British Board of Film Classification
723 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
724 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
725 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
726 "fmocRating": "A String", # Rating system in France - French Minister of Culture
727 "chvrsRating": "A String", # Canadian Home Video Rating System
728 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
729 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
730 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
731 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500732 "caption": "A String", # The value of captions indicates whether the video has captions or not.
733 "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500734 "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500735 "A String",
736 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500737 "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500738 "A String",
739 ],
740 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500741 "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
742 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
743 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500744 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400745 "ageGating": { # Age restriction details related to a video.
746 "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
747 "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
748 "videoGameRating": "A String", # Video game rating, if any.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500749 },
750 "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
751 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
752 "container": "A String", # The uploaded video file's container format.
Joe Gregorio37802c32013-08-06 12:24:05 -0400753 "recordingLocation": { # Geographical coordinates of a point, in WGS84. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500754 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400755 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500756 "longitude": 3.14, # Longitude in degrees.
757 },
758 "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
759 "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
760 # - Date only: YYYY-MM-DD
761 # - Naive time: YYYY-MM-DDTHH:MM:SS
762 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
763 "durationMs": "A String", # The length of the uploaded video in milliseconds.
764 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
765 "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
766 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
767 { # Information about a video stream.
768 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
769 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
770 "codec": "A String", # The video codec that the stream uses.
771 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
772 "heightPixels": 42, # The encoded video content's height in pixels.
773 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
774 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
775 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
776 },
777 ],
778 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
779 { # Information about an audio stream.
780 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
781 "codec": "A String", # The audio codec that the stream uses.
782 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
783 "channelCount": 42, # The number of audio channels that the stream contains.
784 },
785 ],
786 },
787 "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
788 #
789 # The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
790 "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
791 "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
792 "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
793 "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
794 "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
795 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
796 "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
797 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
798 "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
799 # 100 * parts_processed / parts_total
800 #
801 # Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
802 "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
803 },
804 "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500805 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500806 "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
807 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500808 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400809 "etag": "A String", # Etag of this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500810 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
811 "tags": [ # A list of project tags associated with the video during the upload.
812 "A String",
813 ],
814 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500815 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
816 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
817 "locationDescription": "A String", # The text description of the location where the video was recorded.
Joe Gregorio37802c32013-08-06 12:24:05 -0400818 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500819 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -0400820 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500821 "longitude": 3.14, # Longitude in degrees.
822 },
823 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400824 "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
825 "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
826 "A String",
827 ],
828 "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
829 { # A single tag suggestion with it's relevance information.
830 "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
831 "A String",
832 ],
833 "tag": "A String", # The keyword tag suggested for the video.
834 },
835 ],
836 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
837 "A String",
838 ],
839 "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
840 "A String",
841 ],
842 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
843 "A String",
844 ],
845 },
Joe Gregorio52a5c532013-01-24 16:19:07 -0500846 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400847 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
848 "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
849 {
850 "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
851 "context": "A String", # Defines the context of the ping.
852 },
853 ],
854 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500855 },
856 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -0500857 "etag": "A String", # The ETag of the response.
Joe Gregorio37802c32013-08-06 12:24:05 -0400858 "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set.
859 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # The pageInfo object encapsulates paging information for the result set.
860 "totalResults": 42, # The total number of results in the result set.
861 "resultsPerPage": 42, # The number of results included in the API response.
862 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500863 }</pre>
864</div>
865
866<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400867 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
868 <pre>Retrieves the next page of results.
869
870Args:
871 previous_request: The request for the previous page. (required)
872 previous_response: The response from the request for the previous page. (required)
873
874Returns:
875 A request object that you can call 'execute()' on to request the next
876 page. Returns None if there are no more items in the collection.
877 </pre>
878</div>
879
880<div class="method">
881 <code class="details" id="rate">rate(id, rating, onBehalfOfContentOwner=None)</code>
882 <pre>Like, dislike, or remove rating from a video.
883
884Args:
885 id: string, The id parameter specifies the YouTube video ID. (required)
886 rating: string, Specifies the rating to record. (required)
887 Allowed values
888 dislike - Records that the authenticated user disliked the video.
889 like - Records that the authenticated user liked the video.
890 none - Removes any vote (like or dislike) the authenticated user had for the video.
891 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
892</pre>
893</div>
894
895<div class="method">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500896 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500897 <pre>Updates a video's metadata.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500898
899Args:
Joe Gregorio52a5c532013-01-24 16:19:07 -0500900 part: string, The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.
901
902The part names that you can include in the parameter value are snippet, contentDetails, player, statistics, status, and topicDetails.
903
904Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting.
905
906In addition, not all of those parts contain properties that can be set when setting or updating a video's metadata. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required)
Joe Gregoriod67010d2012-11-05 08:57:06 -0500907 body: object, The request body. (required)
908 The object takes the form of:
909
Joe Gregorio52a5c532013-01-24 16:19:07 -0500910{ # A video resource represents a YouTube video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400911 "status": { # Basic details about a video category, such as its localized title. # The status object contains information about the video's uploading, processing, and privacy statuses.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500912 "license": "A String", # The video's license.
913 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500914 "privacyStatus": "A String", # The video's privacy status.
Joe Gregorio37802c32013-08-06 12:24:05 -0400915 "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500916 "uploadStatus": "A String", # The status of the uploaded video.
917 "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
918 "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500919 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500920 "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
921 "description": "A String", # The video's description.
922 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500923 "A String",
924 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -0500925 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
926 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
927 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
928 "title": "A String", # The video's title.
929 "categoryId": "A String", # The YouTube video category associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400930 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
931 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
932 "url": "A String", # The thumbnail image's URL.
933 "width": 42, # (Optional) Width of the thumbnail image.
934 "height": 42, # (Optional) Height of the thumbnail image.
935 },
936 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
937 "url": "A String", # The thumbnail image's URL.
938 "width": 42, # (Optional) Width of the thumbnail image.
939 "height": 42, # (Optional) Height of the thumbnail image.
940 },
941 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
942 "url": "A String", # The thumbnail image's URL.
943 "width": 42, # (Optional) Width of the thumbnail image.
944 "height": 42, # (Optional) Height of the thumbnail image.
945 },
946 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
947 "url": "A String", # The thumbnail image's URL.
948 "width": 42, # (Optional) Width of the thumbnail image.
949 "height": 42, # (Optional) Height of the thumbnail image.
950 },
951 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500952 "url": "A String", # The thumbnail image's URL.
953 "width": 42, # (Optional) Width of the thumbnail image.
954 "height": 42, # (Optional) Height of the thumbnail image.
955 },
956 },
Joe Gregoriod67010d2012-11-05 08:57:06 -0500957 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400958 "kind": "youtube#video", # The kind, fixed to "youtube#video".
Joe Gregorio52a5c532013-01-24 16:19:07 -0500959 "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
960 "commentCount": "A String", # The number of comments for the video.
961 "viewCount": "A String", # The number of times the video has been viewed.
962 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
963 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
964 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
Joe Gregoriod67010d2012-11-05 08:57:06 -0500965 },
Joe Gregorio41be8e82013-03-07 10:31:47 -0500966 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -0400967 "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.
968 "A String",
969 ],
970 "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
Joe Gregorio41be8e82013-03-07 10:31:47 -0500971 "A String",
972 ],
973 },
974 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
975 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
976 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
977 "A String",
978 ],
979 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
980 },
981 },
982 "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
983 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
984 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
985 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
986 "A String",
987 ],
988 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
989 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400990 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. # Specifies the ratings that the video received under various rating schemes.
991 "ytRating": "A String", # Internal YouTube rating.
992 "russiaRating": "A String", # Rating system in Russia
993 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
994 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
995 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
996 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
997 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
998 "bbfcRating": "A String", # British Board of Film Classification
999 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
1000 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
1001 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
1002 "fmocRating": "A String", # Rating system in France - French Minister of Culture
1003 "chvrsRating": "A String", # Canadian Home Video Rating System
1004 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
1005 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
1006 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
1007 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001008 "caption": "A String", # The value of captions indicates whether the video has captions or not.
1009 "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001010 "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001011 "A String",
1012 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -05001013 "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001014 "A String",
1015 ],
1016 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001017 "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
1018 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
1019 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001020 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001021 "ageGating": { # Age restriction details related to a video.
1022 "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
1023 "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
1024 "videoGameRating": "A String", # Video game rating, if any.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001025 },
1026 "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
1027 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
1028 "container": "A String", # The uploaded video file's container format.
Joe Gregorio37802c32013-08-06 12:24:05 -04001029 "recordingLocation": { # Geographical coordinates of a point, in WGS84. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001030 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -04001031 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001032 "longitude": 3.14, # Longitude in degrees.
1033 },
1034 "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
1035 "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
1036 # - Date only: YYYY-MM-DD
1037 # - Naive time: YYYY-MM-DDTHH:MM:SS
1038 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
1039 "durationMs": "A String", # The length of the uploaded video in milliseconds.
1040 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
1041 "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
1042 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
1043 { # Information about a video stream.
1044 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
1045 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1046 "codec": "A String", # The video codec that the stream uses.
1047 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
1048 "heightPixels": 42, # The encoded video content's height in pixels.
1049 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
1050 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
1051 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
1052 },
1053 ],
1054 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
1055 { # Information about an audio stream.
1056 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
1057 "codec": "A String", # The audio codec that the stream uses.
1058 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1059 "channelCount": 42, # The number of audio channels that the stream contains.
1060 },
1061 ],
1062 },
1063 "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
1064 #
1065 # The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
1066 "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
1067 "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
1068 "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
1069 "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
1070 "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
1071 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
1072 "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
1073 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
1074 "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
1075 # 100 * parts_processed / parts_total
1076 #
1077 # Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
1078 "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
1079 },
1080 "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001081 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001082 "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
1083 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001084 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001085 "etag": "A String", # Etag of this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001086 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
1087 "tags": [ # A list of project tags associated with the video during the upload.
1088 "A String",
1089 ],
1090 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001091 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
1092 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1093 "locationDescription": "A String", # The text description of the location where the video was recorded.
Joe Gregorio37802c32013-08-06 12:24:05 -04001094 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001095 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -04001096 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001097 "longitude": 3.14, # Longitude in degrees.
1098 },
1099 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001100 "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
1101 "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
1102 "A String",
1103 ],
1104 "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
1105 { # A single tag suggestion with it's relevance information.
1106 "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
1107 "A String",
1108 ],
1109 "tag": "A String", # The keyword tag suggested for the video.
1110 },
1111 ],
1112 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
1113 "A String",
1114 ],
1115 "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
1116 "A String",
1117 ],
1118 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
1119 "A String",
1120 ],
1121 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001122 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
Joe Gregorio37802c32013-08-06 12:24:05 -04001123 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
1124 "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
1125 {
1126 "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
1127 "context": "A String", # Defines the context of the ping.
1128 },
1129 ],
1130 },
Joe Gregoriod67010d2012-11-05 08:57:06 -05001131 }
1132
Joe Gregorio37802c32013-08-06 12:24:05 -04001133 onBehalfOfContentOwner: string, USE_DESCRIPTION --- channels:list:onBehalfOfContentOwner
Joe Gregoriod67010d2012-11-05 08:57:06 -05001134
1135Returns:
1136 An object of the form:
1137
Joe Gregorio52a5c532013-01-24 16:19:07 -05001138 { # A video resource represents a YouTube video.
Joe Gregorio37802c32013-08-06 12:24:05 -04001139 "status": { # Basic details about a video category, such as its localized title. # The status object contains information about the video's uploading, processing, and privacy statuses.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001140 "license": "A String", # The video's license.
1141 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001142 "privacyStatus": "A String", # The video's privacy status.
Joe Gregorio37802c32013-08-06 12:24:05 -04001143 "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001144 "uploadStatus": "A String", # The status of the uploaded video.
1145 "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
1146 "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001147 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001148 "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category.
1149 "description": "A String", # The video's description.
1150 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001151 "A String",
1152 ],
Joe Gregorio41be8e82013-03-07 10:31:47 -05001153 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
1154 "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1155 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
1156 "title": "A String", # The video's title.
1157 "categoryId": "A String", # The YouTube video category associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -04001158 "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.
1159 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1160 "url": "A String", # The thumbnail image's URL.
1161 "width": 42, # (Optional) Width of the thumbnail image.
1162 "height": 42, # (Optional) Height of the thumbnail image.
1163 },
1164 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1165 "url": "A String", # The thumbnail image's URL.
1166 "width": 42, # (Optional) Width of the thumbnail image.
1167 "height": 42, # (Optional) Height of the thumbnail image.
1168 },
1169 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1170 "url": "A String", # The thumbnail image's URL.
1171 "width": 42, # (Optional) Width of the thumbnail image.
1172 "height": 42, # (Optional) Height of the thumbnail image.
1173 },
1174 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1175 "url": "A String", # The thumbnail image's URL.
1176 "width": 42, # (Optional) Width of the thumbnail image.
1177 "height": 42, # (Optional) Height of the thumbnail image.
1178 },
1179 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001180 "url": "A String", # The thumbnail image's URL.
1181 "width": 42, # (Optional) Width of the thumbnail image.
1182 "height": 42, # (Optional) Height of the thumbnail image.
1183 },
1184 },
Joe Gregoriod67010d2012-11-05 08:57:06 -05001185 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001186 "kind": "youtube#video", # The kind, fixed to "youtube#video".
Joe Gregorio52a5c532013-01-24 16:19:07 -05001187 "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video.
1188 "commentCount": "A String", # The number of comments for the video.
1189 "viewCount": "A String", # The number of times the video has been viewed.
1190 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
1191 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
1192 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001193 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001194 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
Joe Gregorio37802c32013-08-06 12:24:05 -04001195 "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the Freebase Topic API.
1196 "A String",
1197 ],
1198 "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001199 "A String",
1200 ],
1201 },
1202 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
1203 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
1204 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1205 "A String",
1206 ],
1207 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1208 },
1209 },
1210 "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
1211 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
1212 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
1213 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1214 "A String",
1215 ],
1216 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1217 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001218 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. # Specifies the ratings that the video received under various rating schemes.
1219 "ytRating": "A String", # Internal YouTube rating.
1220 "russiaRating": "A String", # Rating system in Russia
1221 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
1222 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
1223 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
1224 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
1225 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
1226 "bbfcRating": "A String", # British Board of Film Classification
1227 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
1228 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
1229 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
1230 "fmocRating": "A String", # Rating system in France - French Minister of Culture
1231 "chvrsRating": "A String", # Canadian Home Video Rating System
1232 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
1233 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
1234 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
1235 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001236 "caption": "A String", # The value of captions indicates whether the video has captions or not.
1237 "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001238 "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001239 "A String",
1240 ],
Joe Gregorio52a5c532013-01-24 16:19:07 -05001241 "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001242 "A String",
1243 ],
1244 },
Joe Gregorio41be8e82013-03-07 10:31:47 -05001245 "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long.
1246 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
1247 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001248 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001249 "ageGating": { # Age restriction details related to a video.
1250 "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present.
1251 "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content.
1252 "videoGameRating": "A String", # Video game rating, if any.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001253 },
1254 "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner.
1255 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
1256 "container": "A String", # The uploaded video file's container format.
Joe Gregorio37802c32013-08-06 12:24:05 -04001257 "recordingLocation": { # Geographical coordinates of a point, in WGS84. # Geographic coordinates that identify the place where the uploaded video was recorded. Coordinates are defined using WGS 84.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001258 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -04001259 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001260 "longitude": 3.14, # Longitude in degrees.
1261 },
1262 "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded.
1263 "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported:
1264 # - Date only: YYYY-MM-DD
1265 # - Naive time: YYYY-MM-DDTHH:MM:SS
1266 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
1267 "durationMs": "A String", # The length of the uploaded video in milliseconds.
1268 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
1269 "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded.
1270 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
1271 { # Information about a video stream.
1272 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
1273 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1274 "codec": "A String", # The video codec that the stream uses.
1275 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
1276 "heightPixels": 42, # The encoded video content's height in pixels.
1277 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
1278 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
1279 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
1280 },
1281 ],
1282 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
1283 { # Information about an audio stream.
1284 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
1285 "codec": "A String", # The audio codec that the stream uses.
1286 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1287 "channelCount": 42, # The number of audio channels that the stream contains.
1288 },
1289 ],
1290 },
1291 "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingProgress object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video.
1292 #
1293 # The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner.
1294 "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.
1295 "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
1296 "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.
1297 "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
1298 "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.
1299 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
1300 "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.
1301 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
1302 "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating:
1303 # 100 * parts_processed / parts_total
1304 #
1305 # Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video.
1306 "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video.
1307 },
1308 "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001309 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001310 "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player.
1311 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
Joe Gregoriod67010d2012-11-05 08:57:06 -05001312 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001313 "etag": "A String", # Etag of this resource.
Joe Gregorio41be8e82013-03-07 10:31:47 -05001314 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
1315 "tags": [ # A list of project tags associated with the video during the upload.
1316 "A String",
1317 ],
1318 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001319 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
1320 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1321 "locationDescription": "A String", # The text description of the location where the video was recorded.
Joe Gregorio37802c32013-08-06 12:24:05 -04001322 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001323 "latitude": 3.14, # Latitude in degrees.
Joe Gregorio37802c32013-08-06 12:24:05 -04001324 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
Joe Gregorio52a5c532013-01-24 16:19:07 -05001325 "longitude": 3.14, # Longitude in degrees.
1326 },
1327 },
Joe Gregorio37802c32013-08-06 12:24:05 -04001328 "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner.
1329 "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed.
1330 "A String",
1331 ],
1332 "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube.
1333 { # A single tag suggestion with it's relevance information.
1334 "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword.
1335 "A String",
1336 ],
1337 "tag": "A String", # The keyword tag suggested for the video.
1338 },
1339 ],
1340 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
1341 "A String",
1342 ],
1343 "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track.
1344 "A String",
1345 ],
1346 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
1347 "A String",
1348 ],
1349 },
Joe Gregorio52a5c532013-01-24 16:19:07 -05001350 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
Joe Gregorio37802c32013-08-06 12:24:05 -04001351 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
1352 "pings": [ # Pings that the app shall fire for a video (authenticated by biscotti cookie). Each ping has a context, in which the app must fire the ping, and a url identifying the ping.
1353 {
1354 "conversionUrl": "A String", # The url (without the schema) that the app shall send the ping to. It's at caller's descretion to decide which schema to use (http vs https) Example of a returned url: //googleads.g.doubleclick.net/pagead/ viewthroughconversion/962985656/?data=path%3DtHe_path%3Btype%3D like%3Butuid%3DGISQtTNGYqaYl4sKxoVvKA%3Bytvid%3DUrIaJUvIQDg&labe=default The caller must append biscotti authentication (ms param in case of mobile, for example) to this ping.
1355 "context": "A String", # Defines the context of the ping.
1356 },
1357 ],
1358 },
Joe Gregoriod67010d2012-11-05 08:57:06 -05001359 }</pre>
1360</div>
1361
1362</body></html>