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