Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / youtube_v3.videos.html
blob: d073e429bfc7b7564805b9a80154d14929a8024d [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.videos.html">videos</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(id, onBehalfOfContentOwner=None)</a></code></p>
79<p class="firstline">Deletes a YouTube video.</p>
80<p class="toc_element">
81 <code><a href="#getRating">getRating(id, onBehalfOfContentOwner=None)</a></code></p>
82<p class="firstline">Retrieves the ratings that the authorized user gave to a list of specified 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, notifySubscribers=None, autoLevels=None)</a></code></p>
85<p class="firstline">Uploads a video to YouTube and optionally sets the video's metadata.</p>
86<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]87 <code><a href="#list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, debugProjectIdOverride=None, videoCategoryId=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Returns a list of videos that match the API request parameters.</p>
89<p class="toc_element">
90 <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">Add a like or dislike rating to a video or remove a rating from a video.</p>
95<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]96 <code><a href="#reportAbuse">reportAbuse(body, onBehalfOfContentOwner=None)</a></code></p>
97<p class="firstline">Report abuse for a video.</p>
98<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99 <code><a href="#update">update(part=None, body, onBehalfOfContentOwner=None)</a></code></p>
100<p class="firstline">Updates a video's metadata.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None)</code>
104 <pre>Deletes a YouTube video.
105
106Args:
107 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)
108 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
109
110The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
111</pre>
112</div>
113
114<div class="method">
115 <code class="details" id="getRating">getRating(id, onBehalfOfContentOwner=None)</code>
116 <pre>Retrieves the ratings that the authorized user gave to a list of specified videos.
117
118Args:
119 id: string, The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a video resource, the id property specifies the video's ID. (required)
120 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
121
122The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
123
124Returns:
125 An object of the form:
126
127 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128 "eventId": "A String", # Serialized EventId of the request which produced this response.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 "items": [ # A list of ratings that match the request criteria.
130 {
131 "rating": "A String",
132 "videoId": "A String",
133 },
134 ],
135 "kind": "youtube#videoGetRatingResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse".
136 "etag": "A String", # Etag of this resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "visitorId": "A String", # The visitorId identifies the visitor.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="insert">insert(part=None, body=None, media_body=None, onBehalfOfContentOwner=None, stabilize=None, onBehalfOfContentOwnerChannel=None, notifySubscribers=None, autoLevels=None)</code>
143 <pre>Uploads a video to YouTube and optionally sets the video's metadata.
144
145Args:
146 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.
147
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]148The part names that you can include in the parameter value are snippet, contentDetails, fileDetails, liveStreamingDetails, localizations, player, processingDetails, recordingDetails, statistics, status, suggestions, 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)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 body: object, The request body.
150 The object takes the form of:
151
152{ # A video resource represents a YouTube video.
153 "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.
154 "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.
155 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
156 "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.
157 "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.
158 "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
159 },
160 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]161 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]162 "description": "A String", # The video's description.
163 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
164 "A String",
165 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]166 "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]168 "defaultLanguage": "A String", # The language of the videos's default snippet.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
170 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
171 "title": "A String", # The video's title.
172 "categoryId": "A String", # The YouTube video category associated with the video.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)
174 "description": "A String", # Localized version of the video's description.
175 "title": "A String", # Localized version of the video's title.
176 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 "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.
178 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
179 "url": "A String", # The thumbnail image's URL.
180 "width": 42, # (Optional) Width of the thumbnail image.
181 "height": 42, # (Optional) Height of the thumbnail image.
182 },
183 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
184 "url": "A String", # The thumbnail image's URL.
185 "width": 42, # (Optional) Width of the thumbnail image.
186 "height": 42, # (Optional) Height of the thumbnail image.
187 },
188 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
189 "url": "A String", # The thumbnail image's URL.
190 "width": 42, # (Optional) Width of the thumbnail image.
191 "height": 42, # (Optional) Height of the thumbnail image.
192 },
193 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
194 "url": "A String", # The thumbnail image's URL.
195 "width": 42, # (Optional) Width of the thumbnail image.
196 "height": 42, # (Optional) Height of the thumbnail image.
197 },
198 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
199 "url": "A String", # The thumbnail image's URL.
200 "width": 42, # (Optional) Width of the thumbnail image.
201 "height": 42, # (Optional) Height of the thumbnail image.
202 },
203 },
204 },
205 "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video".
206 "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.
207 "commentCount": "A String", # The number of comments for the video.
208 "viewCount": "A String", # The number of times the video has been viewed.
209 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
210 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
211 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
212 },
213 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
214 "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.
215 "A String",
216 ],
217 "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.
218 "A String",
219 ],
220 },
221 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
222 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
223 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
224 "A String",
225 ],
226 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
227 },
228 },
229 "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.
230 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
231 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
232 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
233 "A String",
234 ],
235 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
236 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 65 # Specifies the ratings that the video received under various rating schemes.
238 "medietilsynetRating": "A String", # Rating system for Norway - Medietilsynet
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]239 "catvfrRating": "A String", # Rating system for French Canadian TV - Regie du cinema
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]241 "bfvcRating": "A String", # Rating system for Thailand - Board of Filmand Video Censors
242 "mdaRating": "A String", # Rating system for Singapore - Media Development Authority
243 "nfvcbRating": "A String", # Rating system for Nigeria - National Film and Video Censors Board
244 "bmukkRating": "A String", # Rating system for Austria - Bundesministeriums f�r Unterricht, Kunst und Kultur!
245 "chfilmRating": "A String", # Rating system for Switzerland - Switzerland Rating System
246 "resorteviolenciaRating": "A String", # Rating system for Venezuela - SiBCI
247 "rteRating": "A String", # Rating system for Ireland - Raidi� Teilif�s �ireann
248 "csaRating": "A String", # Rating system for France - Conseil sup�rieur de l?audiovisuel
249 "moctwRating": "A String", # Rating system for Taiwan - Ministry of Culture - Tawan
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]251 "pefilmRating": "A String", # Rating system for Peru - Peru Rating System
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]252 "djctqRatingReasons": [
253 "A String",
254 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]255 "incaaRating": "A String", # Rating system for Argentina - Instituto Nacional de Cine y Artes Audiovisuales
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]256 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]257 "fpbRating": "A String", # Rating system for South africa - Film & Publication Board
258 "mccaaRating": "A String", # Rating system for Malta - Film Age-Classification Board
259 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
260 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
261 "cscfRating": "A String", # Rating system for Luxembourg - Commission de surveillance de la classification des films
262 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
263 "bbfcRating": "A String", # British Board of Film Classification
264 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
265 "smsaRating": "A String", # Rating system for Sweden - Statens medier�d (National Media Council)
266 "egfilmRating": "A String", # Rating system for Egypt - Egypt Rating System
267 "cicfRating": "A String", # Rating system for Belgium - Belgium Rating System
268 "nbcplRating": "A String", # Rating system for Poland - National Broadcasting Council
269 "nbcRating": "A String", # Rating system for Maldives - National Bureau of Classification
270 "ytRating": "A String", # Internal YouTube rating.
271 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
272 "ifcoRating": "A String", # Rating system in Ireland - Irish Film Classification Office
273 "fcoRating": "A String", # Rating system for Hong kong - Office for Film, Newspaper and Article Administration
274 "eefilmRating": "A String", # Rating system for Estonia - Estonia Rating System
275 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
276 "grfilmRating": "A String", # Rating system for Greece - Greece Rating System
277 "cccRating": "A String", # Rating system for Chile - Consejo de Calificaci�n Cinematogr�fica
278 "kfcbRating": "A String", # Rating system for Kenya - Kenya Film Classification Board
279 "czfilmRating": "A String", # Rating system for Czech republic - Czech republic Rating System
280 "lsfRating": "A String", # Rating system for Indonesia - Lembaga Sensor Film
281 "fmocRating": "A String", # Rating system in France - French Minister of Culture
282 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
283 "cceRating": "A String", # Rating system for Portugal - Comiss�o de Classifica��o de Espect�culos
284 "nkclvRating": "A String", # Rating system for Latvia - National Film Center of Latvia
285 "mtrcbRating": "A String", # Rating system for Philippines - MOVIE AND TELEVISION REVIEW AND CLASSIFICATION BOARD
286 "mibacRating": "A String", # Rating system in Italy - Ministero dei Beni e delle Attivita Culturali e del Turismo
287 "anatelRating": "A String", # Rating system for Chile - Asociaci�n Nacional de Televisi�n
288 "smaisRating": "A String", # Rating system for Iceland - SMAIS
289 "ilfilmRating": "A String", # Rating system for Israel - Israel Rating System
290 "russiaRating": "A String", # Rating system in Russia
291 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
292 "agcomRating": "A String", # Rating system for Italy - Autorit� per le Garanzie nelle Comunicazioni
293 "chvrsRating": "A String", # Canadian Home Video Rating System
294 "cnaRating": "A String", # Rating system for Romania - CONSILIUL NATIONAL AL AUDIOVIZUALULUI - CNA
295 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
296 "mccypRating": "A String", # Rating system for Denmark - The Media Council for Children and Young People
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]297 "nfrcRating": "A String", # Rating system for Bulgaria - National Film Centre
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]298 "skfilmRating": "A String", # Rating system for Slovakia - Slovakia Rating System
299 "mocRating": "A String", # Rating system for Colombia - MoC
300 "rcnofRating": "A String", # Rating system for Hungary - Rating Committee of the National Office of Film
301 "mekuRating": "A String", # Rating system for Finland - Finnish Centre for Media Education and Audiovisual Media
302 "fcbmRating": "A String", # Rating system for Malaysia - Film Censorship Board of Malaysia
303 "kijkwijzerRating": "A String", # Rating system for Netherlands - Nederlands Instituut voor de Classificatie van Audiovisuele Media
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304 },
305 "caption": "A String", # The value of captions indicates whether the video has captions or not.
306 "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.
307 "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.
308 "A String",
309 ],
310 "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.
311 "A String",
312 ],
313 },
314 "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.
315 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
316 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
317 },
318 "ageGating": { # Age restriction details related to a video.
319 "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.
320 "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.
321 "videoGameRating": "A String", # Video game rating, if any.
322 },
323 "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.
324 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
325 "container": "A String", # The uploaded video file's container format.
326 "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.
327 "latitude": 3.14, # Latitude in degrees.
328 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
329 "longitude": 3.14, # Longitude in degrees.
330 },
331 "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.
332 "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:
333 # - Date only: YYYY-MM-DD
334 # - Naive time: YYYY-MM-DDTHH:MM:SS
335 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
336 "durationMs": "A String", # The length of the uploaded video in milliseconds.
337 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
338 "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.
339 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
340 { # Information about a video stream.
341 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
342 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
343 "codec": "A String", # The video codec that the stream uses.
344 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
345 "heightPixels": 42, # The encoded video content's height in pixels.
346 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
347 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
348 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
349 },
350 ],
351 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
352 { # Information about an audio stream.
353 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
354 "codec": "A String", # The audio codec that the stream uses.
355 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
356 "channelCount": 42, # The number of audio channels that the stream contains.
357 },
358 ],
359 },
360 "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.
361 #
362 # 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.
363 "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.
364 "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.
365 "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.
366 "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.
367 "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.
368 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
369 "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.
370 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
371 "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:
372 # 100 * parts_processed / parts_total
373 #
374 # 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.
375 "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.
376 },
377 "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.
378 },
379 "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.
380 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
381 },
382 "etag": "A String", # Etag of this resource.
383 "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.
384 "license": "A String", # The video's license.
385 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
386 "privacyStatus": "A String", # The video's privacy status.
387 "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
388 "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.
389 "uploadStatus": "A String", # The status of the uploaded video.
390 "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.
391 "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.
392 },
393 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
394 "tags": [ # A list of project tags associated with the video during the upload.
395 "A String",
396 ],
397 },
398 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]399 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]400 "locationDescription": "A String", # The text description of the location where the video was recorded.
401 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
402 "latitude": 3.14, # Latitude in degrees.
403 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
404 "longitude": 3.14, # Longitude in degrees.
405 },
406 },
407 "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.
408 "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.
409 "A String",
410 ],
411 "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.
412 { # A single tag suggestion with it's relevance information.
413 "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.
414 "A String",
415 ],
416 "tag": "A String", # The keyword tag suggested for the video.
417 },
418 ],
419 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
420 "A String",
421 ],
422 "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.
423 "A String",
424 ],
425 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
426 "A String",
427 ],
428 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]429 "localizations": { # List with all localizations.
430 "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types.
431 "description": "A String", # Localized version of the video's description.
432 "title": "A String", # Localized version of the video's title.
433 },
434 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]435 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
436 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
437 "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.
438 {
439 "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.
440 "context": "A String", # Defines the context of the ping.
441 },
442 ],
443 },
444 }
445
446 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
447 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
448
449The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
450 stabilize: boolean, The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions.
451 onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.
452
453The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
454
455This 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.
456 notifySubscribers: boolean, The notifySubscribers parameter indicates whether YouTube should send notification to subscribers about the inserted video.
457 autoLevels: boolean, The autoLevels parameter indicates whether YouTube should automatically enhance the video's lighting and color.
458
459Returns:
460 An object of the form:
461
462 { # A video resource represents a YouTube video.
463 "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.
464 "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.
465 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
466 "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.
467 "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.
468 "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
469 },
470 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]471 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]472 "description": "A String", # The video's description.
473 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
474 "A String",
475 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]476 "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]477 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]478 "defaultLanguage": "A String", # The language of the videos's default snippet.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]479 "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
480 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
481 "title": "A String", # The video's title.
482 "categoryId": "A String", # The YouTube video category associated with the video.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]483 "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)
484 "description": "A String", # Localized version of the video's description.
485 "title": "A String", # Localized version of the video's title.
486 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]487 "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.
488 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
489 "url": "A String", # The thumbnail image's URL.
490 "width": 42, # (Optional) Width of the thumbnail image.
491 "height": 42, # (Optional) Height of the thumbnail image.
492 },
493 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
494 "url": "A String", # The thumbnail image's URL.
495 "width": 42, # (Optional) Width of the thumbnail image.
496 "height": 42, # (Optional) Height of the thumbnail image.
497 },
498 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
499 "url": "A String", # The thumbnail image's URL.
500 "width": 42, # (Optional) Width of the thumbnail image.
501 "height": 42, # (Optional) Height of the thumbnail image.
502 },
503 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
504 "url": "A String", # The thumbnail image's URL.
505 "width": 42, # (Optional) Width of the thumbnail image.
506 "height": 42, # (Optional) Height of the thumbnail image.
507 },
508 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
509 "url": "A String", # The thumbnail image's URL.
510 "width": 42, # (Optional) Width of the thumbnail image.
511 "height": 42, # (Optional) Height of the thumbnail image.
512 },
513 },
514 },
515 "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video".
516 "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.
517 "commentCount": "A String", # The number of comments for the video.
518 "viewCount": "A String", # The number of times the video has been viewed.
519 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
520 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
521 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
522 },
523 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
524 "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.
525 "A String",
526 ],
527 "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.
528 "A String",
529 ],
530 },
531 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
532 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
533 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
534 "A String",
535 ],
536 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
537 },
538 },
539 "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.
540 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
541 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
542 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
543 "A String",
544 ],
545 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
546 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]547 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 65 # Specifies the ratings that the video received under various rating schemes.
548 "medietilsynetRating": "A String", # Rating system for Norway - Medietilsynet
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]549 "catvfrRating": "A String", # Rating system for French Canadian TV - Regie du cinema
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]550 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]551 "bfvcRating": "A String", # Rating system for Thailand - Board of Filmand Video Censors
552 "mdaRating": "A String", # Rating system for Singapore - Media Development Authority
553 "nfvcbRating": "A String", # Rating system for Nigeria - National Film and Video Censors Board
554 "bmukkRating": "A String", # Rating system for Austria - Bundesministeriums f�r Unterricht, Kunst und Kultur!
555 "chfilmRating": "A String", # Rating system for Switzerland - Switzerland Rating System
556 "resorteviolenciaRating": "A String", # Rating system for Venezuela - SiBCI
557 "rteRating": "A String", # Rating system for Ireland - Raidi� Teilif�s �ireann
558 "csaRating": "A String", # Rating system for France - Conseil sup�rieur de l?audiovisuel
559 "moctwRating": "A String", # Rating system for Taiwan - Ministry of Culture - Tawan
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]560 "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]561 "pefilmRating": "A String", # Rating system for Peru - Peru Rating System
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]562 "djctqRatingReasons": [
563 "A String",
564 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]565 "incaaRating": "A String", # Rating system for Argentina - Instituto Nacional de Cine y Artes Audiovisuales
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]566 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]567 "fpbRating": "A String", # Rating system for South africa - Film & Publication Board
568 "mccaaRating": "A String", # Rating system for Malta - Film Age-Classification Board
569 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
570 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
571 "cscfRating": "A String", # Rating system for Luxembourg - Commission de surveillance de la classification des films
572 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
573 "bbfcRating": "A String", # British Board of Film Classification
574 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
575 "smsaRating": "A String", # Rating system for Sweden - Statens medier�d (National Media Council)
576 "egfilmRating": "A String", # Rating system for Egypt - Egypt Rating System
577 "cicfRating": "A String", # Rating system for Belgium - Belgium Rating System
578 "nbcplRating": "A String", # Rating system for Poland - National Broadcasting Council
579 "nbcRating": "A String", # Rating system for Maldives - National Bureau of Classification
580 "ytRating": "A String", # Internal YouTube rating.
581 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
582 "ifcoRating": "A String", # Rating system in Ireland - Irish Film Classification Office
583 "fcoRating": "A String", # Rating system for Hong kong - Office for Film, Newspaper and Article Administration
584 "eefilmRating": "A String", # Rating system for Estonia - Estonia Rating System
585 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
586 "grfilmRating": "A String", # Rating system for Greece - Greece Rating System
587 "cccRating": "A String", # Rating system for Chile - Consejo de Calificaci�n Cinematogr�fica
588 "kfcbRating": "A String", # Rating system for Kenya - Kenya Film Classification Board
589 "czfilmRating": "A String", # Rating system for Czech republic - Czech republic Rating System
590 "lsfRating": "A String", # Rating system for Indonesia - Lembaga Sensor Film
591 "fmocRating": "A String", # Rating system in France - French Minister of Culture
592 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
593 "cceRating": "A String", # Rating system for Portugal - Comiss�o de Classifica��o de Espect�culos
594 "nkclvRating": "A String", # Rating system for Latvia - National Film Center of Latvia
595 "mtrcbRating": "A String", # Rating system for Philippines - MOVIE AND TELEVISION REVIEW AND CLASSIFICATION BOARD
596 "mibacRating": "A String", # Rating system in Italy - Ministero dei Beni e delle Attivita Culturali e del Turismo
597 "anatelRating": "A String", # Rating system for Chile - Asociaci�n Nacional de Televisi�n
598 "smaisRating": "A String", # Rating system for Iceland - SMAIS
599 "ilfilmRating": "A String", # Rating system for Israel - Israel Rating System
600 "russiaRating": "A String", # Rating system in Russia
601 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
602 "agcomRating": "A String", # Rating system for Italy - Autorit� per le Garanzie nelle Comunicazioni
603 "chvrsRating": "A String", # Canadian Home Video Rating System
604 "cnaRating": "A String", # Rating system for Romania - CONSILIUL NATIONAL AL AUDIOVIZUALULUI - CNA
605 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
606 "mccypRating": "A String", # Rating system for Denmark - The Media Council for Children and Young People
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]607 "nfrcRating": "A String", # Rating system for Bulgaria - National Film Centre
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]608 "skfilmRating": "A String", # Rating system for Slovakia - Slovakia Rating System
609 "mocRating": "A String", # Rating system for Colombia - MoC
610 "rcnofRating": "A String", # Rating system for Hungary - Rating Committee of the National Office of Film
611 "mekuRating": "A String", # Rating system for Finland - Finnish Centre for Media Education and Audiovisual Media
612 "fcbmRating": "A String", # Rating system for Malaysia - Film Censorship Board of Malaysia
613 "kijkwijzerRating": "A String", # Rating system for Netherlands - Nederlands Instituut voor de Classificatie van Audiovisuele Media
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]614 },
615 "caption": "A String", # The value of captions indicates whether the video has captions or not.
616 "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.
617 "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.
618 "A String",
619 ],
620 "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.
621 "A String",
622 ],
623 },
624 "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.
625 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
626 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
627 },
628 "ageGating": { # Age restriction details related to a video.
629 "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.
630 "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.
631 "videoGameRating": "A String", # Video game rating, if any.
632 },
633 "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.
634 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
635 "container": "A String", # The uploaded video file's container format.
636 "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.
637 "latitude": 3.14, # Latitude in degrees.
638 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
639 "longitude": 3.14, # Longitude in degrees.
640 },
641 "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.
642 "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:
643 # - Date only: YYYY-MM-DD
644 # - Naive time: YYYY-MM-DDTHH:MM:SS
645 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
646 "durationMs": "A String", # The length of the uploaded video in milliseconds.
647 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
648 "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.
649 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
650 { # Information about a video stream.
651 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
652 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
653 "codec": "A String", # The video codec that the stream uses.
654 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
655 "heightPixels": 42, # The encoded video content's height in pixels.
656 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
657 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
658 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
659 },
660 ],
661 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
662 { # Information about an audio stream.
663 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
664 "codec": "A String", # The audio codec that the stream uses.
665 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
666 "channelCount": 42, # The number of audio channels that the stream contains.
667 },
668 ],
669 },
670 "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.
671 #
672 # 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.
673 "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.
674 "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.
675 "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.
676 "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.
677 "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.
678 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
679 "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.
680 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
681 "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:
682 # 100 * parts_processed / parts_total
683 #
684 # 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.
685 "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.
686 },
687 "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.
688 },
689 "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.
690 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
691 },
692 "etag": "A String", # Etag of this resource.
693 "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.
694 "license": "A String", # The video's license.
695 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
696 "privacyStatus": "A String", # The video's privacy status.
697 "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
698 "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.
699 "uploadStatus": "A String", # The status of the uploaded video.
700 "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.
701 "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.
702 },
703 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
704 "tags": [ # A list of project tags associated with the video during the upload.
705 "A String",
706 ],
707 },
708 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]709 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]710 "locationDescription": "A String", # The text description of the location where the video was recorded.
711 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
712 "latitude": 3.14, # Latitude in degrees.
713 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
714 "longitude": 3.14, # Longitude in degrees.
715 },
716 },
717 "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.
718 "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.
719 "A String",
720 ],
721 "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.
722 { # A single tag suggestion with it's relevance information.
723 "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.
724 "A String",
725 ],
726 "tag": "A String", # The keyword tag suggested for the video.
727 },
728 ],
729 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
730 "A String",
731 ],
732 "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.
733 "A String",
734 ],
735 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
736 "A String",
737 ],
738 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]739 "localizations": { # List with all localizations.
740 "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types.
741 "description": "A String", # Localized version of the video's description.
742 "title": "A String", # Localized version of the video's title.
743 },
744 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]745 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
746 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
747 "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.
748 {
749 "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.
750 "context": "A String", # Defines the context of the ping.
751 },
752 ],
753 },
754 }</pre>
755</div>
756
757<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]758 <code class="details" id="list">list(part=None, hl=None, locale=None, id=None, onBehalfOfContentOwner=None, regionCode=None, pageToken=None, maxResults=None, chart=None, myRating=None, debugProjectIdOverride=None, videoCategoryId=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]759 <pre>Returns a list of videos that match the API request parameters.
760
761Args:
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]762 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, fileDetails, liveStreamingDetails, localizations, player, processingDetails, recordingDetails, statistics, status, suggestions, and topicDetails.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]763
764If 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)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]765 hl: string, The hl parameter instructs the API to return a localized version of the video details. If localized text is nor available for the requested language, the localizations object in the API response will contain the requested information in the default language instead. The parameter value is a BCP-47 language code. Your application can determine whether the requested localization was returned by checking the value of the snippet.localized.language property in the API response.
766 locale: string, DEPRECATED
767 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]768 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
769
770The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]771 regionCode: string, The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code.
772 pageToken: string, The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.
773
774Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]775 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set.
776
777Note: This parameter is supported for use in conjunction with the myRating parameter, but it is not supported for use in conjunction with the id parameter.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]778 chart: string, The chart parameter identifies the chart that you want to retrieve.
779 Allowed values
780 mostPopular - Return the most popular videos for the specified content region and video category.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]781 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.
782 Allowed values
783 dislike - Returns only videos disliked by the authenticated user.
784 like - Returns only video liked by the authenticated user.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]785 debugProjectIdOverride: string, The debugProjectIdOverride parameter should be used for mimicking a request for a certain project ID
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]786 videoCategoryId: string, The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]787
788Returns:
789 An object of the form:
790
791 {
792 "eventId": "A String", # Serialized EventId of the request which produced this response.
793 "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.
794 "kind": "youtube#videoListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse".
795 "visitorId": "A String", # The visitorId identifies the visitor.
796 "items": [ # A list of videos that match the request criteria.
797 { # A video resource represents a YouTube video.
798 "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.
799 "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.
800 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
801 "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.
802 "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.
803 "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
804 },
805 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]806 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]807 "description": "A String", # The video's description.
808 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
809 "A String",
810 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]811 "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]812 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]813 "defaultLanguage": "A String", # The language of the videos's default snippet.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]814 "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
815 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
816 "title": "A String", # The video's title.
817 "categoryId": "A String", # The YouTube video category associated with the video.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]818 "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)
819 "description": "A String", # Localized version of the video's description.
820 "title": "A String", # Localized version of the video's title.
821 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]822 "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.
823 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
824 "url": "A String", # The thumbnail image's URL.
825 "width": 42, # (Optional) Width of the thumbnail image.
826 "height": 42, # (Optional) Height of the thumbnail image.
827 },
828 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
829 "url": "A String", # The thumbnail image's URL.
830 "width": 42, # (Optional) Width of the thumbnail image.
831 "height": 42, # (Optional) Height of the thumbnail image.
832 },
833 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
834 "url": "A String", # The thumbnail image's URL.
835 "width": 42, # (Optional) Width of the thumbnail image.
836 "height": 42, # (Optional) Height of the thumbnail image.
837 },
838 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
839 "url": "A String", # The thumbnail image's URL.
840 "width": 42, # (Optional) Width of the thumbnail image.
841 "height": 42, # (Optional) Height of the thumbnail image.
842 },
843 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
844 "url": "A String", # The thumbnail image's URL.
845 "width": 42, # (Optional) Width of the thumbnail image.
846 "height": 42, # (Optional) Height of the thumbnail image.
847 },
848 },
849 },
850 "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video".
851 "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.
852 "commentCount": "A String", # The number of comments for the video.
853 "viewCount": "A String", # The number of times the video has been viewed.
854 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
855 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
856 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
857 },
858 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
859 "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.
860 "A String",
861 ],
862 "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.
863 "A String",
864 ],
865 },
866 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
867 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
868 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
869 "A String",
870 ],
871 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
872 },
873 },
874 "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.
875 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
876 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
877 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
878 "A String",
879 ],
880 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
881 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]882 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 65 # Specifies the ratings that the video received under various rating schemes.
883 "medietilsynetRating": "A String", # Rating system for Norway - Medietilsynet
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]884 "catvfrRating": "A String", # Rating system for French Canadian TV - Regie du cinema
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]885 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]886 "bfvcRating": "A String", # Rating system for Thailand - Board of Filmand Video Censors
887 "mdaRating": "A String", # Rating system for Singapore - Media Development Authority
888 "nfvcbRating": "A String", # Rating system for Nigeria - National Film and Video Censors Board
889 "bmukkRating": "A String", # Rating system for Austria - Bundesministeriums f�r Unterricht, Kunst und Kultur!
890 "chfilmRating": "A String", # Rating system for Switzerland - Switzerland Rating System
891 "resorteviolenciaRating": "A String", # Rating system for Venezuela - SiBCI
892 "rteRating": "A String", # Rating system for Ireland - Raidi� Teilif�s �ireann
893 "csaRating": "A String", # Rating system for France - Conseil sup�rieur de l?audiovisuel
894 "moctwRating": "A String", # Rating system for Taiwan - Ministry of Culture - Tawan
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]895 "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]896 "pefilmRating": "A String", # Rating system for Peru - Peru Rating System
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]897 "djctqRatingReasons": [
898 "A String",
899 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]900 "incaaRating": "A String", # Rating system for Argentina - Instituto Nacional de Cine y Artes Audiovisuales
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]901 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]902 "fpbRating": "A String", # Rating system for South africa - Film & Publication Board
903 "mccaaRating": "A String", # Rating system for Malta - Film Age-Classification Board
904 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
905 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
906 "cscfRating": "A String", # Rating system for Luxembourg - Commission de surveillance de la classification des films
907 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
908 "bbfcRating": "A String", # British Board of Film Classification
909 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
910 "smsaRating": "A String", # Rating system for Sweden - Statens medier�d (National Media Council)
911 "egfilmRating": "A String", # Rating system for Egypt - Egypt Rating System
912 "cicfRating": "A String", # Rating system for Belgium - Belgium Rating System
913 "nbcplRating": "A String", # Rating system for Poland - National Broadcasting Council
914 "nbcRating": "A String", # Rating system for Maldives - National Bureau of Classification
915 "ytRating": "A String", # Internal YouTube rating.
916 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
917 "ifcoRating": "A String", # Rating system in Ireland - Irish Film Classification Office
918 "fcoRating": "A String", # Rating system for Hong kong - Office for Film, Newspaper and Article Administration
919 "eefilmRating": "A String", # Rating system for Estonia - Estonia Rating System
920 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
921 "grfilmRating": "A String", # Rating system for Greece - Greece Rating System
922 "cccRating": "A String", # Rating system for Chile - Consejo de Calificaci�n Cinematogr�fica
923 "kfcbRating": "A String", # Rating system for Kenya - Kenya Film Classification Board
924 "czfilmRating": "A String", # Rating system for Czech republic - Czech republic Rating System
925 "lsfRating": "A String", # Rating system for Indonesia - Lembaga Sensor Film
926 "fmocRating": "A String", # Rating system in France - French Minister of Culture
927 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
928 "cceRating": "A String", # Rating system for Portugal - Comiss�o de Classifica��o de Espect�culos
929 "nkclvRating": "A String", # Rating system for Latvia - National Film Center of Latvia
930 "mtrcbRating": "A String", # Rating system for Philippines - MOVIE AND TELEVISION REVIEW AND CLASSIFICATION BOARD
931 "mibacRating": "A String", # Rating system in Italy - Ministero dei Beni e delle Attivita Culturali e del Turismo
932 "anatelRating": "A String", # Rating system for Chile - Asociaci�n Nacional de Televisi�n
933 "smaisRating": "A String", # Rating system for Iceland - SMAIS
934 "ilfilmRating": "A String", # Rating system for Israel - Israel Rating System
935 "russiaRating": "A String", # Rating system in Russia
936 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
937 "agcomRating": "A String", # Rating system for Italy - Autorit� per le Garanzie nelle Comunicazioni
938 "chvrsRating": "A String", # Canadian Home Video Rating System
939 "cnaRating": "A String", # Rating system for Romania - CONSILIUL NATIONAL AL AUDIOVIZUALULUI - CNA
940 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
941 "mccypRating": "A String", # Rating system for Denmark - The Media Council for Children and Young People
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]942 "nfrcRating": "A String", # Rating system for Bulgaria - National Film Centre
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]943 "skfilmRating": "A String", # Rating system for Slovakia - Slovakia Rating System
944 "mocRating": "A String", # Rating system for Colombia - MoC
945 "rcnofRating": "A String", # Rating system for Hungary - Rating Committee of the National Office of Film
946 "mekuRating": "A String", # Rating system for Finland - Finnish Centre for Media Education and Audiovisual Media
947 "fcbmRating": "A String", # Rating system for Malaysia - Film Censorship Board of Malaysia
948 "kijkwijzerRating": "A String", # Rating system for Netherlands - Nederlands Instituut voor de Classificatie van Audiovisuele Media
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]949 },
950 "caption": "A String", # The value of captions indicates whether the video has captions or not.
951 "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.
952 "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.
953 "A String",
954 ],
955 "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.
956 "A String",
957 ],
958 },
959 "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.
960 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
961 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
962 },
963 "ageGating": { # Age restriction details related to a video.
964 "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.
965 "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.
966 "videoGameRating": "A String", # Video game rating, if any.
967 },
968 "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.
969 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
970 "container": "A String", # The uploaded video file's container format.
971 "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.
972 "latitude": 3.14, # Latitude in degrees.
973 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
974 "longitude": 3.14, # Longitude in degrees.
975 },
976 "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.
977 "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:
978 # - Date only: YYYY-MM-DD
979 # - Naive time: YYYY-MM-DDTHH:MM:SS
980 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
981 "durationMs": "A String", # The length of the uploaded video in milliseconds.
982 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
983 "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.
984 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
985 { # Information about a video stream.
986 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
987 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
988 "codec": "A String", # The video codec that the stream uses.
989 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
990 "heightPixels": 42, # The encoded video content's height in pixels.
991 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
992 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
993 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
994 },
995 ],
996 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
997 { # Information about an audio stream.
998 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
999 "codec": "A String", # The audio codec that the stream uses.
1000 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1001 "channelCount": 42, # The number of audio channels that the stream contains.
1002 },
1003 ],
1004 },
1005 "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.
1006 #
1007 # 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.
1008 "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.
1009 "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.
1010 "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.
1011 "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.
1012 "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.
1013 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
1014 "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.
1015 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
1016 "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:
1017 # 100 * parts_processed / parts_total
1018 #
1019 # 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.
1020 "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.
1021 },
1022 "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.
1023 },
1024 "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.
1025 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
1026 },
1027 "etag": "A String", # Etag of this resource.
1028 "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.
1029 "license": "A String", # The video's license.
1030 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
1031 "privacyStatus": "A String", # The video's privacy status.
1032 "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1033 "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.
1034 "uploadStatus": "A String", # The status of the uploaded video.
1035 "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.
1036 "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.
1037 },
1038 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
1039 "tags": [ # A list of project tags associated with the video during the upload.
1040 "A String",
1041 ],
1042 },
1043 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1044 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1045 "locationDescription": "A String", # The text description of the location where the video was recorded.
1046 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
1047 "latitude": 3.14, # Latitude in degrees.
1048 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
1049 "longitude": 3.14, # Longitude in degrees.
1050 },
1051 },
1052 "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.
1053 "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.
1054 "A String",
1055 ],
1056 "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.
1057 { # A single tag suggestion with it's relevance information.
1058 "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.
1059 "A String",
1060 ],
1061 "tag": "A String", # The keyword tag suggested for the video.
1062 },
1063 ],
1064 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
1065 "A String",
1066 ],
1067 "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.
1068 "A String",
1069 ],
1070 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
1071 "A String",
1072 ],
1073 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1074 "localizations": { # List with all localizations.
1075 "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types.
1076 "description": "A String", # Localized version of the video's description.
1077 "title": "A String", # Localized version of the video's title.
1078 },
1079 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1080 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
1081 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
1082 "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.
1083 {
1084 "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.
1085 "context": "A String", # Defines the context of the ping.
1086 },
1087 ],
1088 },
1089 },
1090 ],
1091 "tokenPagination": { # Stub token pagination template to suppress results.
1092 },
1093 "etag": "A String", # Etag of this resource.
1094 "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.
1095 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page.
1096 "totalResults": 42, # The total number of results in the result set.
1097 "resultsPerPage": 42, # The number of results included in the API response.
1098 },
1099 }</pre>
1100</div>
1101
1102<div class="method">
1103 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1104 <pre>Retrieves the next page of results.
1105
1106Args:
1107 previous_request: The request for the previous page. (required)
1108 previous_response: The response from the request for the previous page. (required)
1109
1110Returns:
1111 A request object that you can call 'execute()' on to request the next
1112 page. Returns None if there are no more items in the collection.
1113 </pre>
1114</div>
1115
1116<div class="method">
1117 <code class="details" id="rate">rate(id, rating, onBehalfOfContentOwner=None)</code>
1118 <pre>Add a like or dislike rating to a video or remove a rating from a video.
1119
1120Args:
1121 id: string, The id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed. (required)
1122 rating: string, Specifies the rating to record. (required)
1123 Allowed values
1124 dislike - Records that the authenticated user disliked the video.
1125 like - Records that the authenticated user liked the video.
1126 none - Removes any rating that the authenticated user had previously set for the video.
1127 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
1128
1129The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
1130</pre>
1131</div>
1132
1133<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1134 <code class="details" id="reportAbuse">reportAbuse(body, onBehalfOfContentOwner=None)</code>
1135 <pre>Report abuse for a video.
1136
1137Args:
1138 body: object, The request body. (required)
1139 The object takes the form of:
1140
1141{
1142 "secondaryReasonId": "A String", # The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason.
1143 "reasonId": "A String", # The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID.
1144 "language": "A String", # The language that the content was viewed in.
1145 "comments": "A String", # Additional comments regarding the abuse report.
1146 "videoId": "A String", # The ID that YouTube uses to uniquely identify the video.
1147 }
1148
1149 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
1150
1151The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
1152</pre>
1153</div>
1154
1155<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1156 <code class="details" id="update">update(part=None, body, onBehalfOfContentOwner=None)</code>
1157 <pre>Updates a video's metadata.
1158
1159Args:
1160 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.
1161
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1162The part names that you can include in the parameter value are snippet, contentDetails, fileDetails, liveStreamingDetails, localizations, player, processingDetails, recordingDetails, statistics, status, suggestions, and topicDetails.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1163
1164Note 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.
1165
1166In 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)
1167 body: object, The request body. (required)
1168 The object takes the form of:
1169
1170{ # A video resource represents a YouTube video.
1171 "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.
1172 "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.
1173 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
1174 "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.
1175 "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.
1176 "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1177 },
1178 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1179 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1180 "description": "A String", # The video's description.
1181 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
1182 "A String",
1183 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1184 "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1185 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1186 "defaultLanguage": "A String", # The language of the videos's default snippet.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1187 "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
1188 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
1189 "title": "A String", # The video's title.
1190 "categoryId": "A String", # The YouTube video category associated with the video.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1191 "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)
1192 "description": "A String", # Localized version of the video's description.
1193 "title": "A String", # Localized version of the video's title.
1194 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1195 "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.
1196 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1197 "url": "A String", # The thumbnail image's URL.
1198 "width": 42, # (Optional) Width of the thumbnail image.
1199 "height": 42, # (Optional) Height of the thumbnail image.
1200 },
1201 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1202 "url": "A String", # The thumbnail image's URL.
1203 "width": 42, # (Optional) Width of the thumbnail image.
1204 "height": 42, # (Optional) Height of the thumbnail image.
1205 },
1206 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1207 "url": "A String", # The thumbnail image's URL.
1208 "width": 42, # (Optional) Width of the thumbnail image.
1209 "height": 42, # (Optional) Height of the thumbnail image.
1210 },
1211 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1212 "url": "A String", # The thumbnail image's URL.
1213 "width": 42, # (Optional) Width of the thumbnail image.
1214 "height": 42, # (Optional) Height of the thumbnail image.
1215 },
1216 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
1217 "url": "A String", # The thumbnail image's URL.
1218 "width": 42, # (Optional) Width of the thumbnail image.
1219 "height": 42, # (Optional) Height of the thumbnail image.
1220 },
1221 },
1222 },
1223 "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video".
1224 "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.
1225 "commentCount": "A String", # The number of comments for the video.
1226 "viewCount": "A String", # The number of times the video has been viewed.
1227 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
1228 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
1229 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
1230 },
1231 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
1232 "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.
1233 "A String",
1234 ],
1235 "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.
1236 "A String",
1237 ],
1238 },
1239 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
1240 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
1241 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1242 "A String",
1243 ],
1244 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1245 },
1246 },
1247 "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.
1248 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
1249 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
1250 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1251 "A String",
1252 ],
1253 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1254 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1255 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 65 # Specifies the ratings that the video received under various rating schemes.
1256 "medietilsynetRating": "A String", # Rating system for Norway - Medietilsynet
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1257 "catvfrRating": "A String", # Rating system for French Canadian TV - Regie du cinema
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1258 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1259 "bfvcRating": "A String", # Rating system for Thailand - Board of Filmand Video Censors
1260 "mdaRating": "A String", # Rating system for Singapore - Media Development Authority
1261 "nfvcbRating": "A String", # Rating system for Nigeria - National Film and Video Censors Board
1262 "bmukkRating": "A String", # Rating system for Austria - Bundesministeriums f�r Unterricht, Kunst und Kultur!
1263 "chfilmRating": "A String", # Rating system for Switzerland - Switzerland Rating System
1264 "resorteviolenciaRating": "A String", # Rating system for Venezuela - SiBCI
1265 "rteRating": "A String", # Rating system for Ireland - Raidi� Teilif�s �ireann
1266 "csaRating": "A String", # Rating system for France - Conseil sup�rieur de l?audiovisuel
1267 "moctwRating": "A String", # Rating system for Taiwan - Ministry of Culture - Tawan
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1268 "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1269 "pefilmRating": "A String", # Rating system for Peru - Peru Rating System
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1270 "djctqRatingReasons": [
1271 "A String",
1272 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1273 "incaaRating": "A String", # Rating system for Argentina - Instituto Nacional de Cine y Artes Audiovisuales
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1274 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1275 "fpbRating": "A String", # Rating system for South africa - Film & Publication Board
1276 "mccaaRating": "A String", # Rating system for Malta - Film Age-Classification Board
1277 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
1278 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
1279 "cscfRating": "A String", # Rating system for Luxembourg - Commission de surveillance de la classification des films
1280 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
1281 "bbfcRating": "A String", # British Board of Film Classification
1282 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
1283 "smsaRating": "A String", # Rating system for Sweden - Statens medier�d (National Media Council)
1284 "egfilmRating": "A String", # Rating system for Egypt - Egypt Rating System
1285 "cicfRating": "A String", # Rating system for Belgium - Belgium Rating System
1286 "nbcplRating": "A String", # Rating system for Poland - National Broadcasting Council
1287 "nbcRating": "A String", # Rating system for Maldives - National Bureau of Classification
1288 "ytRating": "A String", # Internal YouTube rating.
1289 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
1290 "ifcoRating": "A String", # Rating system in Ireland - Irish Film Classification Office
1291 "fcoRating": "A String", # Rating system for Hong kong - Office for Film, Newspaper and Article Administration
1292 "eefilmRating": "A String", # Rating system for Estonia - Estonia Rating System
1293 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
1294 "grfilmRating": "A String", # Rating system for Greece - Greece Rating System
1295 "cccRating": "A String", # Rating system for Chile - Consejo de Calificaci�n Cinematogr�fica
1296 "kfcbRating": "A String", # Rating system for Kenya - Kenya Film Classification Board
1297 "czfilmRating": "A String", # Rating system for Czech republic - Czech republic Rating System
1298 "lsfRating": "A String", # Rating system for Indonesia - Lembaga Sensor Film
1299 "fmocRating": "A String", # Rating system in France - French Minister of Culture
1300 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
1301 "cceRating": "A String", # Rating system for Portugal - Comiss�o de Classifica��o de Espect�culos
1302 "nkclvRating": "A String", # Rating system for Latvia - National Film Center of Latvia
1303 "mtrcbRating": "A String", # Rating system for Philippines - MOVIE AND TELEVISION REVIEW AND CLASSIFICATION BOARD
1304 "mibacRating": "A String", # Rating system in Italy - Ministero dei Beni e delle Attivita Culturali e del Turismo
1305 "anatelRating": "A String", # Rating system for Chile - Asociaci�n Nacional de Televisi�n
1306 "smaisRating": "A String", # Rating system for Iceland - SMAIS
1307 "ilfilmRating": "A String", # Rating system for Israel - Israel Rating System
1308 "russiaRating": "A String", # Rating system in Russia
1309 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
1310 "agcomRating": "A String", # Rating system for Italy - Autorit� per le Garanzie nelle Comunicazioni
1311 "chvrsRating": "A String", # Canadian Home Video Rating System
1312 "cnaRating": "A String", # Rating system for Romania - CONSILIUL NATIONAL AL AUDIOVIZUALULUI - CNA
1313 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
1314 "mccypRating": "A String", # Rating system for Denmark - The Media Council for Children and Young People
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1315 "nfrcRating": "A String", # Rating system for Bulgaria - National Film Centre
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1316 "skfilmRating": "A String", # Rating system for Slovakia - Slovakia Rating System
1317 "mocRating": "A String", # Rating system for Colombia - MoC
1318 "rcnofRating": "A String", # Rating system for Hungary - Rating Committee of the National Office of Film
1319 "mekuRating": "A String", # Rating system for Finland - Finnish Centre for Media Education and Audiovisual Media
1320 "fcbmRating": "A String", # Rating system for Malaysia - Film Censorship Board of Malaysia
1321 "kijkwijzerRating": "A String", # Rating system for Netherlands - Nederlands Instituut voor de Classificatie van Audiovisuele Media
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1322 },
1323 "caption": "A String", # The value of captions indicates whether the video has captions or not.
1324 "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.
1325 "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.
1326 "A String",
1327 ],
1328 "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.
1329 "A String",
1330 ],
1331 },
1332 "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.
1333 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
1334 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
1335 },
1336 "ageGating": { # Age restriction details related to a video.
1337 "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.
1338 "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.
1339 "videoGameRating": "A String", # Video game rating, if any.
1340 },
1341 "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.
1342 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
1343 "container": "A String", # The uploaded video file's container format.
1344 "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.
1345 "latitude": 3.14, # Latitude in degrees.
1346 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
1347 "longitude": 3.14, # Longitude in degrees.
1348 },
1349 "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.
1350 "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:
1351 # - Date only: YYYY-MM-DD
1352 # - Naive time: YYYY-MM-DDTHH:MM:SS
1353 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
1354 "durationMs": "A String", # The length of the uploaded video in milliseconds.
1355 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
1356 "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.
1357 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
1358 { # Information about a video stream.
1359 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
1360 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1361 "codec": "A String", # The video codec that the stream uses.
1362 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
1363 "heightPixels": 42, # The encoded video content's height in pixels.
1364 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
1365 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
1366 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
1367 },
1368 ],
1369 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
1370 { # Information about an audio stream.
1371 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
1372 "codec": "A String", # The audio codec that the stream uses.
1373 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1374 "channelCount": 42, # The number of audio channels that the stream contains.
1375 },
1376 ],
1377 },
1378 "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.
1379 #
1380 # 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.
1381 "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.
1382 "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.
1383 "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.
1384 "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.
1385 "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.
1386 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
1387 "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.
1388 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
1389 "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:
1390 # 100 * parts_processed / parts_total
1391 #
1392 # 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.
1393 "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.
1394 },
1395 "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.
1396 },
1397 "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.
1398 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
1399 },
1400 "etag": "A String", # Etag of this resource.
1401 "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.
1402 "license": "A String", # The video's license.
1403 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
1404 "privacyStatus": "A String", # The video's privacy status.
1405 "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1406 "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.
1407 "uploadStatus": "A String", # The status of the uploaded video.
1408 "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.
1409 "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.
1410 },
1411 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
1412 "tags": [ # A list of project tags associated with the video during the upload.
1413 "A String",
1414 ],
1415 },
1416 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1417 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1418 "locationDescription": "A String", # The text description of the location where the video was recorded.
1419 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
1420 "latitude": 3.14, # Latitude in degrees.
1421 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
1422 "longitude": 3.14, # Longitude in degrees.
1423 },
1424 },
1425 "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.
1426 "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.
1427 "A String",
1428 ],
1429 "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.
1430 { # A single tag suggestion with it's relevance information.
1431 "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.
1432 "A String",
1433 ],
1434 "tag": "A String", # The keyword tag suggested for the video.
1435 },
1436 ],
1437 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
1438 "A String",
1439 ],
1440 "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.
1441 "A String",
1442 ],
1443 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
1444 "A String",
1445 ],
1446 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1447 "localizations": { # List with all localizations.
1448 "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types.
1449 "description": "A String", # Localized version of the video's description.
1450 "title": "A String", # Localized version of the video's title.
1451 },
1452 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1453 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
1454 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
1455 "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.
1456 {
1457 "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.
1458 "context": "A String", # Defines the context of the ping.
1459 },
1460 ],
1461 },
1462 }
1463
1464 onBehalfOfContentOwner: string, Note: This parameter is intended exclusively for YouTube content partners.
1465
1466The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
1467
1468Returns:
1469 An object of the form:
1470
1471 { # A video resource represents a YouTube video.
1472 "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast.
1473 "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely.
1474 "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended.
1475 "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins.
1476 "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over.
1477 "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1478 },
1479 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1480 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1481 "description": "A String", # The video's description.
1482 "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. This field is only visible to the video's uploader.
1483 "A String",
1484 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]1485 "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1486 "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1487 "defaultLanguage": "A String", # The language of the videos's default snippet.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1488 "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast.
1489 "channelTitle": "A String", # Channel title for the channel that the video belongs to.
1490 "title": "A String", # The video's title.
1491 "categoryId": "A String", # The YouTube video category associated with the video.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1492 "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)
1493 "description": "A String", # Localized version of the video's description.
1494 "title": "A String", # Localized version of the video's title.
1495 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1496 "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.
1497 "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.
1498 "url": "A String", # The thumbnail image's URL.
1499 "width": 42, # (Optional) Width of the thumbnail image.
1500 "height": 42, # (Optional) Height of the thumbnail image.
1501 },
1502 "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.
1503 "url": "A String", # The thumbnail image's URL.
1504 "width": 42, # (Optional) Width of the thumbnail image.
1505 "height": 42, # (Optional) Height of the thumbnail image.
1506 },
1507 "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.
1508 "url": "A String", # The thumbnail image's URL.
1509 "width": 42, # (Optional) Width of the thumbnail image.
1510 "height": 42, # (Optional) Height of the thumbnail image.
1511 },
1512 "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.
1513 "url": "A String", # The thumbnail image's URL.
1514 "width": 42, # (Optional) Width of the thumbnail image.
1515 "height": 42, # (Optional) Height of the thumbnail image.
1516 },
1517 "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.
1518 "url": "A String", # The thumbnail image's URL.
1519 "width": 42, # (Optional) Width of the thumbnail image.
1520 "height": 42, # (Optional) Height of the thumbnail image.
1521 },
1522 },
1523 },
1524 "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video".
1525 "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.
1526 "commentCount": "A String", # The number of comments for the video.
1527 "viewCount": "A String", # The number of times the video has been viewed.
1528 "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video.
1529 "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating.
1530 "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating.
1531 },
1532 "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video.
1533 "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.
1534 "A String",
1535 ],
1536 "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.
1537 "A String",
1538 ],
1539 },
1540 "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video.
1541 "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not.
1542 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1543 "A String",
1544 ],
1545 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1546 },
1547 },
1548 "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.
1549 "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition.
1550 "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable.
1551 "exception": [ # A list of region codes that identify countries where the default policy do not apply.
1552 "A String",
1553 ],
1554 "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default.
1555 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1556 "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 65 # Specifies the ratings that the video received under various rating schemes.
1557 "medietilsynetRating": "A String", # Rating system for Norway - Medietilsynet
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1558 "catvfrRating": "A String", # Rating system for French Canadian TV - Regie du cinema
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1559 "cbfcRating": "A String", # Rating system in India - Central Board of Film Certification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1560 "bfvcRating": "A String", # Rating system for Thailand - Board of Filmand Video Censors
1561 "mdaRating": "A String", # Rating system for Singapore - Media Development Authority
1562 "nfvcbRating": "A String", # Rating system for Nigeria - National Film and Video Censors Board
1563 "bmukkRating": "A String", # Rating system for Austria - Bundesministeriums f�r Unterricht, Kunst und Kultur!
1564 "chfilmRating": "A String", # Rating system for Switzerland - Switzerland Rating System
1565 "resorteviolenciaRating": "A String", # Rating system for Venezuela - SiBCI
1566 "rteRating": "A String", # Rating system for Ireland - Raidi� Teilif�s �ireann
1567 "csaRating": "A String", # Rating system for France - Conseil sup�rieur de l?audiovisuel
1568 "moctwRating": "A String", # Rating system for Taiwan - Ministry of Culture - Tawan
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1569 "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1570 "pefilmRating": "A String", # Rating system for Peru - Peru Rating System
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1571 "djctqRatingReasons": [
1572 "A String",
1573 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1574 "incaaRating": "A String", # Rating system for Argentina - Instituto Nacional de Cine y Artes Audiovisuales
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1575 "oflcRating": "A String", # Rating system in New Zealand - Office of Film and Literature Classification
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1576 "fpbRating": "A String", # Rating system for South africa - Film & Publication Board
1577 "mccaaRating": "A String", # Rating system for Malta - Film Age-Classification Board
1578 "tvpgRating": "A String", # TV Parental Guidelines rating of the content.
1579 "rtcRating": "A String", # Rating system in Mexico - General Directorate of Radio, Television and Cinematography
1580 "cscfRating": "A String", # Rating system for Luxembourg - Commission de surveillance de la classification des films
1581 "fskRating": "A String", # Rating system in Germany - Voluntary Self Regulation of the Movie Industry
1582 "bbfcRating": "A String", # British Board of Film Classification
1583 "kmrbRating": "A String", # Rating system in South Korea - Korea Media Rating Board
1584 "smsaRating": "A String", # Rating system for Sweden - Statens medier�d (National Media Council)
1585 "egfilmRating": "A String", # Rating system for Egypt - Egypt Rating System
1586 "cicfRating": "A String", # Rating system for Belgium - Belgium Rating System
1587 "nbcplRating": "A String", # Rating system for Poland - National Broadcasting Council
1588 "nbcRating": "A String", # Rating system for Maldives - National Bureau of Classification
1589 "ytRating": "A String", # Internal YouTube rating.
1590 "djctqRating": "A String", # Rating system in Brazil - Department of Justice, Rating, Titles and Qualification
1591 "ifcoRating": "A String", # Rating system in Ireland - Irish Film Classification Office
1592 "fcoRating": "A String", # Rating system for Hong kong - Office for Film, Newspaper and Article Administration
1593 "eefilmRating": "A String", # Rating system for Estonia - Estonia Rating System
1594 "acbRating": "A String", # Rating system in Australia - Australian Classification Board
1595 "grfilmRating": "A String", # Rating system for Greece - Greece Rating System
1596 "cccRating": "A String", # Rating system for Chile - Consejo de Calificaci�n Cinematogr�fica
1597 "kfcbRating": "A String", # Rating system for Kenya - Kenya Film Classification Board
1598 "czfilmRating": "A String", # Rating system for Czech republic - Czech republic Rating System
1599 "lsfRating": "A String", # Rating system for Indonesia - Lembaga Sensor Film
1600 "fmocRating": "A String", # Rating system in France - French Minister of Culture
1601 "eirinRating": "A String", # Rating system in Japan - Eiga Rinri Kanri Iinkai
1602 "cceRating": "A String", # Rating system for Portugal - Comiss�o de Classifica��o de Espect�culos
1603 "nkclvRating": "A String", # Rating system for Latvia - National Film Center of Latvia
1604 "mtrcbRating": "A String", # Rating system for Philippines - MOVIE AND TELEVISION REVIEW AND CLASSIFICATION BOARD
1605 "mibacRating": "A String", # Rating system in Italy - Ministero dei Beni e delle Attivita Culturali e del Turismo
1606 "anatelRating": "A String", # Rating system for Chile - Asociaci�n Nacional de Televisi�n
1607 "smaisRating": "A String", # Rating system for Iceland - SMAIS
1608 "ilfilmRating": "A String", # Rating system for Israel - Israel Rating System
1609 "russiaRating": "A String", # Rating system in Russia
1610 "mpaaRating": "A String", # Motion Picture Association of America rating for the content.
1611 "agcomRating": "A String", # Rating system for Italy - Autorit� per le Garanzie nelle Comunicazioni
1612 "chvrsRating": "A String", # Canadian Home Video Rating System
1613 "cnaRating": "A String", # Rating system for Romania - CONSILIUL NATIONAL AL AUDIOVIZUALULUI - CNA
1614 "icaaRating": "A String", # Rating system in Spain - Instituto de Cinematografia y de las Artes Audiovisuales
1615 "mccypRating": "A String", # Rating system for Denmark - The Media Council for Children and Young People
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1616 "nfrcRating": "A String", # Rating system for Bulgaria - National Film Centre
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1617 "skfilmRating": "A String", # Rating system for Slovakia - Slovakia Rating System
1618 "mocRating": "A String", # Rating system for Colombia - MoC
1619 "rcnofRating": "A String", # Rating system for Hungary - Rating Committee of the National Office of Film
1620 "mekuRating": "A String", # Rating system for Finland - Finnish Centre for Media Education and Audiovisual Media
1621 "fcbmRating": "A String", # Rating system for Malaysia - Film Censorship Board of Malaysia
1622 "kijkwijzerRating": "A String", # Rating system for Netherlands - Nederlands Instituut voor de Classificatie van Audiovisuele Media
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1623 },
1624 "caption": "A String", # The value of captions indicates whether the video has captions or not.
1625 "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.
1626 "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.
1627 "A String",
1628 ],
1629 "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.
1630 "A String",
1631 ],
1632 },
1633 "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.
1634 "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content.
1635 "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D.
1636 },
1637 "ageGating": { # Age restriction details related to a video.
1638 "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.
1639 "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.
1640 "videoGameRating": "A String", # Video game rating, if any.
1641 },
1642 "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.
1643 "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second.
1644 "container": "A String", # The uploaded video file's container format.
1645 "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.
1646 "latitude": 3.14, # Latitude in degrees.
1647 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
1648 "longitude": 3.14, # Longitude in degrees.
1649 },
1650 "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.
1651 "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:
1652 # - Date only: YYYY-MM-DD
1653 # - Naive time: YYYY-MM-DDTHH:MM:SS
1654 # - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM
1655 "durationMs": "A String", # The length of the uploaded video in milliseconds.
1656 "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded.
1657 "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.
1658 "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream.
1659 { # Information about a video stream.
1660 "bitrateBps": "A String", # The video stream's bitrate, in bits per second.
1661 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1662 "codec": "A String", # The video codec that the stream uses.
1663 "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels.
1664 "heightPixels": 42, # The encoded video content's height in pixels.
1665 "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed.
1666 "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video.
1667 "frameRateFps": 3.14, # The video stream's frame rate, in frames per second.
1668 },
1669 ],
1670 "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream.
1671 { # Information about an audio stream.
1672 "bitrateBps": "A String", # The audio stream's bitrate, in bits per second.
1673 "codec": "A String", # The audio codec that the stream uses.
1674 "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code.
1675 "channelCount": 42, # The number of audio channels that the stream contains.
1676 },
1677 ],
1678 },
1679 "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.
1680 #
1681 # 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.
1682 "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.
1683 "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.
1684 "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.
1685 "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.
1686 "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.
1687 "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video.
1688 "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.
1689 "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video.
1690 "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:
1691 # 100 * parts_processed / parts_total
1692 #
1693 # 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.
1694 "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.
1695 },
1696 "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.
1697 },
1698 "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.
1699 "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video.
1700 },
1701 "etag": "A String", # Etag of this resource.
1702 "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.
1703 "license": "A String", # The video's license.
1704 "embeddable": True or False, # This value indicates if the video can be embedded on another website.
1705 "privacyStatus": "A String", # The video's privacy status.
1706 "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.
1707 "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.
1708 "uploadStatus": "A String", # The status of the uploaded video.
1709 "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.
1710 "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.
1711 },
1712 "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata.
1713 "tags": [ # A list of project tags associated with the video during the upload.
1714 "A String",
1715 ],
1716 },
1717 "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1718 "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1719 "locationDescription": "A String", # The text description of the location where the video was recorded.
1720 "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video.
1721 "latitude": 3.14, # Latitude in degrees.
1722 "altitude": 3.14, # Altitude above the reference ellipsoid, in meters.
1723 "longitude": 3.14, # Longitude in degrees.
1724 },
1725 },
1726 "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.
1727 "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.
1728 "A String",
1729 ],
1730 "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.
1731 { # A single tag suggestion with it's relevance information.
1732 "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.
1733 "A String",
1734 ],
1735 "tag": "A String", # The keyword tag suggested for the video.
1736 },
1737 ],
1738 "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video.
1739 "A String",
1740 ],
1741 "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.
1742 "A String",
1743 ],
1744 "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video.
1745 "A String",
1746 ],
1747 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1748 "localizations": { # List with all localizations.
1749 "a_key": { # Localized versions of certain video properties (e.g. title). # The language tag, using string since map_key require simple types.
1750 "description": "A String", # Localized version of the video's description.
1751 "title": "A String", # Localized version of the video's title.
1752 },
1753 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1754 "id": "A String", # The ID that YouTube uses to uniquely identify the video.
1755 "conversionPings": { # The conversionPings object encapsulates information about url pings that need to be respected by the App in different video contexts.
1756 "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.
1757 {
1758 "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.
1759 "context": "A String", # Defines the context of the ping.
1760 },
1761 ],
1762 },
1763 }</pre>
1764</div>
1765
1766</body></html>