John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.videos.html">videos</a></h1> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 78 | <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Deletes a resource.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 80 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 81 | <code><a href="#getRating">getRating(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Retrieves the ratings that the authorized user gave to a list of specified</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 84 | <code><a href="#insert">insert(part, body=None, autoLevels=None, stabilize=None, onBehalfOfContentOwnerChannel=None, notifySubscribers=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p> |
| 85 | <p class="firstline">Inserts a new resource into this collection.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(part, myRating=None, locale=None, chart=None, videoCategoryId=None, maxWidth=None, regionCode=None, maxHeight=None, id=None, maxResults=None, onBehalfOfContentOwner=None, hl=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 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"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 93 | <code><a href="#rate">rate(id, rating, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Adds a like or dislike rating to a video or removes a rating from a video.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 95 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 96 | <code><a href="#reportAbuse">reportAbuse(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 97 | <p class="firstline">Report abuse for a video.</p> |
| 98 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 99 | <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Updates an existing resource.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 103 | <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 104 | <pre>Deletes a resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 105 | |
| 106 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 107 | id: string, A parameter (required) |
| 108 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 109 | content partners.<br><br>The |
| 110 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 111 | that the |
| 112 | request's authorization credentials identify a YouTube CMS user who is |
| 113 | acting on behalf of the content owner specified in the parameter value. |
| 114 | This parameter is intended for YouTube content partners that own and manage |
| 115 | many different YouTube channels. It allows content owners to authenticate |
| 116 | once and get access to all their video and channel data, without having to |
| 117 | provide authentication credentials for each individual channel. The actual |
| 118 | CMS account that the user authenticates with must be linked to the |
| 119 | specified YouTube content owner. |
| 120 | x__xgafv: string, V1 error format. |
| 121 | Allowed values |
| 122 | 1 - v1 error format |
| 123 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 124 | </pre> |
| 125 | </div> |
| 126 | |
| 127 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 128 | <code class="details" id="getRating">getRating(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 129 | <pre>Retrieves the ratings that the authorized user gave to a list of specified |
| 130 | videos. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 131 | |
| 132 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 133 | id: string, A parameter (required) (repeated) |
| 134 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 135 | content partners.<br><br>The |
| 136 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 137 | that the |
| 138 | request's authorization credentials identify a YouTube CMS user who is |
| 139 | acting on behalf of the content owner specified in the parameter value. |
| 140 | This parameter is intended for YouTube content partners that own and manage |
| 141 | many different YouTube channels. It allows content owners to authenticate |
| 142 | once and get access to all their video and channel data, without having to |
| 143 | provide authentication credentials for each individual channel. The CMS |
| 144 | account that the user authenticates with must be linked to the specified |
| 145 | YouTube content owner. |
| 146 | x__xgafv: string, V1 error format. |
| 147 | Allowed values |
| 148 | 1 - v1 error format |
| 149 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 155 | "items": [ # A list of ratings that match the request criteria. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 156 | { # Basic details about rating of a video. |
| 157 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 158 | "rating": "A String", # Rating of a video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 159 | }, |
| 160 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 161 | "etag": "A String", # Etag of this resource. |
| 162 | "kind": "youtube#videoGetRatingResponse", # Identifies what kind of resource this is. Value: the fixed string |
| 163 | # <code>"youtube#videoGetRatingResponse"</code>. |
| 164 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| 165 | "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 166 | }</pre> |
| 167 | </div> |
| 168 | |
| 169 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 170 | <code class="details" id="insert">insert(part, body=None, autoLevels=None, stabilize=None, onBehalfOfContentOwnerChannel=None, notifySubscribers=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code> |
| 171 | <pre>Inserts a new resource into this collection. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 172 | |
| 173 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 174 | part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| 175 | this operation. It identifies the properties that the write operation will |
| 176 | set as well as the properties that the API response will |
| 177 | include.<br/><br/>Note that not all parts contain properties that can be |
| 178 | set when inserting or updating a video. For example, the |
| 179 | <code>statistics</code> object encapsulates statistics that YouTube |
| 180 | calculates for a video and does not contain values that you can set or |
| 181 | modify. If the parameter value specifies a <code>part</code> that does not |
| 182 | contain mutable values, that <code>part</code> will still be included in |
| 183 | the API response. (required) (repeated) |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 184 | body: object, The request body. |
| 185 | The object takes the form of: |
| 186 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 187 | { # A <code><strong>video</strong></code> resource represents a YouTube video. |
| 188 | "recordingDetails": { # Recording information associated with the video. # The <code>recordingDetails</code> object encapsulates information about the |
| 189 | # location, date and address where the video was recorded. |
| 190 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 191 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in <a |
| 192 | # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 193 | # (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>) format. |
| 194 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 195 | "latitude": 3.14, # Latitude in degrees. |
| 196 | "longitude": 3.14, # Longitude in degrees. |
| 197 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 198 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 199 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 200 | "contentDetails": { # Details about the content of a YouTube Video. # The <code>contentDetails</code> object contains information about the video |
| 201 | # content, including the length of the video and its aspect ratio. |
| 202 | "dimension": "A String", # The value of <code>dimension</code> indicates whether the video is |
| 203 | # available in 3D or in 2D. |
| 204 | "caption": "A String", # The value of <code>captions</code> indicates whether the video |
| 205 | # has captions or not. |
| 206 | "duration": "A String", # The length of the video. The tag value is an <a |
| 207 | # href="//en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> duration in |
| 208 | # the format <code>PT#M#S</code>, in which the letters <code>PT</code> |
| 209 | # indicate that the value specifies a period of time, and the letters |
| 210 | # <code>M</code> and <code>S</code> refer to length in minutes and seconds, |
| 211 | # respectively. The <code>#</code> characters preceding the <code>M</code> |
| 212 | # and <code>S</code> letters are both integers that specify the number of |
| 213 | # minutes (or seconds) of the video. For example, a value of |
| 214 | # <code>PT15M51S</code> indicates that the video is 15 minutes and 51 seconds |
| 215 | # long. |
| 216 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom |
| 217 | # thumbnail image for the video. |
| 218 | # This property is only visible to the video uploader. |
| 219 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The <code>regionRestriction</code> object contains information about the |
| 220 | # countries where a video is (or is not) viewable. The object will contain |
| 221 | # either the <code>contentDetails.regionRestriction.allowed</code> property |
| 222 | # or the <code>contentDetails.regionRestriction.blocked</code> property. |
| 223 | "allowed": [ # A list of region codes that identify countries where the video is |
| 224 | # viewable. If this property is present and a country is not listed |
| 225 | # in its value, then the video is blocked from appearing in that |
| 226 | # country. If this property is present and contains an empty list, |
| 227 | # the video is blocked in all countries. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 228 | "A String", |
| 229 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 230 | "blocked": [ # A list of region codes that identify countries where the video is |
| 231 | # blocked. If this property is present and a country is not listed in |
| 232 | # its value, then the video is viewable in that country. If this |
| 233 | # property is present and contains an empty list, the video is |
| 234 | # viewable in all countries. |
| 235 | "A String", |
| 236 | ], |
| 237 | }, |
| 238 | "licensedContent": True or False, # The value of <code>is_license_content</code> indicates whether the video is |
| 239 | # licensed content. |
| 240 | "countryRestriction": { # Rights management policy for YouTube resources. # The <code>countryRestriction</code> object contains information about the |
| 241 | # countries where a video is (or is not) viewable. |
| 242 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 243 | # not apply. |
| 244 | "A String", |
| 245 | ], |
| 246 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 247 | # policy is allowed or denied by default. |
| 248 | }, |
| 249 | "definition": "A String", # The value of <code>definition</code> indicates whether the video is |
| 250 | # available in high definition or only in standard definition. |
| 251 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for # Specifies the ratings that the video received under various rating schemes. |
| 252 | # movies and shows. |
| 253 | # LINT.IfChange |
| 254 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance |
| 255 | # de la classification des films (CSCF). |
| 256 | "icaaRating": "A String", # The video's Instituto de la Cinematograf&iacute;a y de las Artes |
| 257 | # Audiovisuales (ICAA - Spain) rating. |
| 258 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 259 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 260 | "oflcRating": "A String", # The video's Office of Film and Literature Classification |
| 261 | # (OFLC - New Zealand) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 262 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 264 | "djctqRating": "A String", # The video's Departamento de Justi&ccedil;a, Classifica&ccedil;&atilde;o, |
| 265 | # Qualifica&ccedil;&atilde;o e T&iacute;tulos (DJCQT - Brazil) rating. |
| 266 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See |
| 267 | # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 268 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 269 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 270 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian |
| 271 | # Communications and Media Authority (ACMA) rating. ACMA ratings are used |
| 272 | # to classify children's television programming. |
| 273 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 274 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attivit&agrave; |
| 275 | # Culturali e del Turismo (Italy). |
| 276 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and |
| 277 | # Telecommunications Commission (CRTC) for Canadian French-language |
| 278 | # broadcasts. For more information, see the |
| 279 | # <a href="http://www.cbsc.ca/english/agvot/frenchsystem.php">Canadian |
| 280 | # Broadcast Standards Council</a> website. |
| 281 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture |
| 282 | # (&#25991;&#21270;&#37096;). |
| 283 | "nkclvRating": "A String", # The video's rating from the Nacion&atilde;lais Kino centrs (National Film |
| 284 | # Centre of Latvia). |
| 285 | "csaRating": "A String", # The video's rating from France's Conseil sup&eacute;rieur de |
| 286 | # l’audiovisuel, which rates broadcast content. |
| 287 | "rteRating": "A String", # The video's rating from Ireland's Raidi&oacute; Teilif&iacute;s |
| 288 | # &Eacute;ireann. |
| 289 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. |
| 290 | # See the <a |
| 291 | # href="http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro">IFCO</a> |
| 292 | # website for more information. |
| 293 | "cceRating": "A String", # The video's rating from Portugal's Comiss&atilde;o de |
| 294 | # Classifica&ccedil;&atilde;o de Espect&acute;culos. |
| 295 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the |
| 296 | # Ministry of Culture and Tourism |
| 297 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 298 | "eirinRating": "A String", # The video's Eirin (&#26144;&#20523;) rating. |
| 299 | # Eirin is the Japanese rating system. |
| 300 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 301 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification |
| 302 | # (Bundesministerium f&uuml;r Unterricht, Kunst und Kultur). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 303 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 304 | "A String", |
| 305 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 306 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 307 | "smaisRating": "A String", # The video's rating in Iceland. |
| 308 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti |
| 309 | # (National Audiovisual Institute). |
| 310 | "smsaRating": "A String", # The video's rating from Statens medier&aring;d (Sweden's National Media |
| 311 | # Council). |
| 312 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 313 | "nbcplRating": "A String", # The video's rating in Poland. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 314 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 315 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 316 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut |
| 317 | # voor de Classificatie van Audiovisuele Media (Netherlands). |
| 318 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating |
| 319 | # Committee of the National Office of Film. |
| 320 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 321 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 322 | "cicfRating": "A String", # The video's rating from the Commission de Contr&ocirc;le des Films |
| 323 | # (Belgium). |
| 324 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper |
| 325 | # and Article Administration. |
| 326 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System |
| 327 | # The video's rating from the Canadian Radio-Television and |
| 328 | # Telecommunications Commission (CRTC) for Canadian English-language |
| 329 | # broadcasts. For more information, see the |
| 330 | # <a href="http://www.cbsc.ca/english/agvot/englishsystem.php">Canadian |
| 331 | # Broadcast Standards Council</a> website. |
| 332 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 333 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation |
| 334 | # (MKRF - Russia) rating. |
| 335 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 336 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 337 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 338 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 339 | "A String", |
| 340 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 341 | "agcomRating": "A String", # The video's rating from Italy's Autorit&agrave; per le Garanzie nelle |
| 342 | # Comunicazioni (AGCOM). |
| 343 | "pefilmRating": "A String", # The video's rating in Peru. |
| 344 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 345 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske |
| 346 | # Filminstitut) Media Council for Children and Young People. |
| 347 | "grfilmRating": "A String", # The video's rating in Greece. |
| 348 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 349 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to |
| 350 | # prevent titles go live w/o additional QC check, since some of them can be |
| 351 | # inappropriate for the countries at all. See b/33408548 for more details. |
| 352 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 353 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, |
| 354 | # specifically, it's Board of Film Censors (BFC). |
| 355 | "kmrbRating": "A String", # The video's Korea Media Rating Board |
| 356 | # (&#50689;&#49345;&#47932;&#46321;&#44553;&#50948;&#50896;&#54924;) rating. |
| 357 | # The KMRB rates videos in South Korea. |
| 358 | "nfrcRating": "A String", # The video's rating from the <a href="http://www.nfc.bg/">Bulgarian |
| 359 | # National Film Center</a>. |
| 360 | "fmocRating": "A String", # <span class="deprecated">This property has been deprecated. Use the |
| 361 | # <code><a |
| 362 | # href="#contentDetails.contentRating.cncRating">contentDetails.contentRating.cncRating</a></code> |
| 363 | # instead.</span> |
| 364 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 365 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI |
| 366 | # (CNA). |
| 367 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft |
| 368 | # (FSK - Germany) rating. |
| 369 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 370 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - |
| 371 | # Argentina) rating. |
| 372 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 373 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography |
| 374 | # (Mexico) rating. |
| 375 | "anatelRating": "A String", # The video's Anatel (Asociaci&oacute;n Nacional de Televisi&oacute;n) |
| 376 | # rating for Chilean television. |
| 377 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and |
| 378 | # Classification Board (Philippines). |
| 379 | "cccRating": "A String", # The video's Consejo de Calificaci&oacute;n Cinematogr&aacute;fica (Chile) |
| 380 | # rating. |
| 381 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 382 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 383 | "projection": "A String", # Specifies the projection format of the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 385 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The <code>projectDetails</code> object contains information about the |
| 386 | # project specific video metadata. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | "tags": [ # A list of project tags associated with the video during the upload. |
| 388 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 389 | ], |
| 390 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 391 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 392 | "localizations": { # The <code>localizations</code> object contains localized versions of the |
| 393 | # basic details about the video, such as its title and description. |
| 394 | "a_key": { # Localized versions of certain video properties (e.g. title). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 395 | "title": "A String", # Localized version of the video's title. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 396 | "description": "A String", # Localized version of the video's description. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 397 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 398 | }, |
| 399 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The <code>monetizationDetails</code> object encapsulates information |
| 400 | # about the monetization status of the video. |
| 401 | "access": { # Rights management policy for YouTube resources. # The value of <code>access</code> indicates whether the video can be |
| 402 | # monetized or not. |
| 403 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 404 | # not apply. |
| 405 | "A String", |
| 406 | ], |
| 407 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 408 | # policy is allowed or denied by default. |
| 409 | }, |
| 410 | }, |
| 411 | "status": { # Basic details about a video category, such as its localized title. # The <code>status</code> object contains information about the video's |
| 412 | # uploading, processing, and privacy statuses. |
| 413 | # Next Id: 17 |
| 414 | "failureReason": "A String", # This value explains why a video failed to upload. This property is |
| 415 | # only present if the <code>uploadStatus</code> property indicates that |
| 416 | # the upload failed. |
| 417 | "privacyStatus": "A String", # The video's privacy status. |
| 418 | "selfDeclaredMadeForKids": True or False, |
| 419 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This |
| 420 | # property is only present if the <code>uploadStatus</code> property |
| 421 | # indicates that the upload was rejected. |
| 422 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. |
| 423 | # @mutable youtube.videos.insert youtube.videos.update |
| 424 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set |
| 425 | # only if the privacy status of the video is private. The value is specified |
| 426 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 427 | # format. |
| 428 | "madeForKids": True or False, |
| 429 | "license": "A String", # The video's license. |
| 430 | # @mutable youtube.videos.insert youtube.videos.update |
| 431 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page |
| 432 | # can be viewed by everyone. Note that the view count, likes, etc will still |
| 433 | # be visible if this is disabled. |
| 434 | # @mutable youtube.videos.insert youtube.videos.update |
| 435 | "uploadStatus": "A String", # The status of the uploaded video. |
| 436 | }, |
| 437 | "statistics": { # Statistics about the video, such as the number of times the video was viewed # The <code>statistics</code> object contains statistics about the video. |
| 438 | # or liked. |
| 439 | "likeCount": "A String", # The number of users who have indicated that they liked the video by |
| 440 | # giving it a positive rating. |
| 441 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by |
| 442 | # giving it a negative rating. |
| 443 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite |
| 444 | # video. |
| 445 | "commentCount": "A String", # The number of comments for the video. |
| 446 | "viewCount": "A String", # The number of times the video has been viewed. |
| 447 | }, |
| 448 | "snippet": { # Basic details about a video, including title, description, uploader, # The <code>snippet</code> object contains basic details about the video, |
| 449 | # such as its title, description, and category. |
| 450 | # thumbnails and category. |
| 451 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization |
| 452 | # exists, this field is populated with the default snippet. (Read-only) |
| 453 | "title": "A String", # Localized version of the video's title. |
| 454 | "description": "A String", # Localized version of the video's description. |
| 455 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 456 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
| 457 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 458 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 459 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 460 | "title": "A String", # The video's title. |
| 461 | # @mutable youtube.videos.insert youtube.videos.update |
| 462 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. |
| 463 | # Or it's "none" if the video is not an upcoming/active live broadcast. |
| 464 | "description": "A String", # The video's description. |
| 465 | # @mutable youtube.videos.insert youtube.videos.update |
| 466 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 467 | "defaultAudioLanguage": "A String", # The <code>default_audio_language</code> property specifies the language |
| 468 | # spoken in the video's default audio track. |
| 469 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the |
| 470 | # video was uploaded to. |
| 471 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the |
| 472 | # map, the key is the name of the thumbnail image, and the value is an object |
| 473 | # that contains other information about the thumbnail. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 474 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 475 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 476 | "url": "A String", # The thumbnail image's URL. |
| 477 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 478 | }, |
| 479 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 481 | "url": "A String", # The thumbnail image's URL. |
| 482 | "height": 42, # (Optional) Height of the thumbnail image. |
| 483 | }, |
| 484 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 485 | "width": 42, # (Optional) Width of the thumbnail image. |
| 486 | "url": "A String", # The thumbnail image's URL. |
| 487 | "height": 42, # (Optional) Height of the thumbnail image. |
| 488 | }, |
| 489 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 490 | "width": 42, # (Optional) Width of the thumbnail image. |
| 491 | "url": "A String", # The thumbnail image's URL. |
| 492 | "height": 42, # (Optional) Height of the thumbnail image. |
| 493 | }, |
| 494 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 495 | "width": 42, # (Optional) Width of the thumbnail image. |
| 496 | "url": "A String", # The thumbnail image's URL. |
| 497 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 498 | }, |
| 499 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 500 | "categoryId": "A String", # The YouTube <a href="/youtube/v3/docs/videoCategories/list">video |
| 501 | # category</a> associated with the video. |
| 502 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified |
| 503 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 504 | # format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 505 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 506 | "processingDetails": { # Describes processing status and progress and availability of some other Video # The <code>processingDetails</code> object encapsulates information about |
| 507 | # YouTube's progress in processing the uploaded video file. The properties |
| 508 | # in the object identify the current processing status and an estimate of |
| 509 | # the time remaining until YouTube finishes processing the video. This part |
| 510 | # also indicates whether different types of data or content, such as file |
| 511 | # details or thumbnail images, are available for the video.<br><br> |
| 512 | # The <code>processingProgress</code> object is designed to be polled so |
| 513 | # that the video uploaded can track the progress that YouTube has made in |
| 514 | # processing the uploaded video file. This data can only be retrieved by |
| 515 | # the video owner. |
| 516 | # resource parts. |
| 517 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded |
| 518 | # video. You can retrieve a video's file details by requesting the |
| 519 | # <code>fileDetails</code> part in your <code>videos.list()</code> request. |
| 520 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will |
| 521 | # only have a value if the <code>processingStatus</code> |
| 522 | # property's value is <code>failed</code>. |
| 523 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might |
| 524 | # improve video quality or the playback experience, are available for |
| 525 | # the video. You can retrieve these suggestions by requesting the |
| 526 | # <code>suggestions</code> part in your <code>videos.list()</code> request. |
| 527 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for |
| 528 | # the video. Tags can be added to a video's metadata to make it easier for |
| 529 | # other users to find the video. You can retrieve these suggestions by |
| 530 | # requesting the <code>suggestions</code> part in your |
| 531 | # <code>videos.list()</code> request. |
| 532 | "processingProgress": { # Video processing progress and completion time estimate. # The <code>processingProgress</code> object contains information about the |
| 533 | # progress YouTube has made in processing the video. The values are really |
| 534 | # only relevant if the video's processing status is <code>processing</code>. |
| 535 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs |
| 536 | # to finish processing the video. |
| 537 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. |
| 538 | # You can estimate the percentage of the video that YouTube has already |
| 539 | # processed by calculating:<br> |
| 540 | # <code>100 * parts_processed / parts_total</code><br><br> |
| 541 | # Note that since the estimated number of parts could increase without |
| 542 | # a corresponding increase in the number of parts that have already been |
| 543 | # processed, it is possible that the calculated progress could |
| 544 | # periodically decrease while YouTube processes a video. |
| 545 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed |
| 546 | # for the video. The number may be updated with more precise estimates |
| 547 | # while YouTube processes the video. |
| 548 | }, |
| 549 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for |
| 550 | # the video. |
| 551 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated |
| 552 | # suggestions that might improve YouTube's ability to process the |
| 553 | # the video, warnings that explain video processing problems, or |
| 554 | # errors that cause video processing problems. You can retrieve these |
| 555 | # suggestions by requesting the <code>suggestions</code> part in your |
| 556 | # <code>videos.list()</code> request. |
| 557 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was |
| 558 | # able to process the video or if the video is still being processed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 559 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 560 | "etag": "A String", # Etag of this resource. |
| 561 | "player": { # Player to be used for a video playback. # The <code>player</code> object contains information that you would use to |
| 562 | # play the video in an embedded player. |
| 563 | "embedWidth": "A String", # The embed width |
| 564 | "embedHeight": "A String", |
| 565 | "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| 566 | # play the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 567 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 568 | "liveStreamingDetails": { # Details about the live streaming metadata. # The <code>liveStreamingDetails</code> object contains metadata about a live |
| 569 | # video broadcast. The object will only be present in a <code>video</code> |
| 570 | # resource if the video is an upcoming, live, or completed live broadcast. |
| 571 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This |
| 572 | # field is filled only if the video is a currently live broadcast that has |
| 573 | # live chat. Once the broadcast transitions to complete this field will be |
| 574 | # removed and the live chat closed down. For persistent broadcasts that live |
| 575 | # chat id will no longer be tied to this video but rather to the new video |
| 576 | # being displayed at the persistent page. |
| 577 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and |
| 578 | # its value will be present if the broadcast has current viewers and the |
| 579 | # broadcast owner has not hidden the viewcount for the video. Note that |
| 580 | # YouTube stops tracking the number of concurrent viewers for a broadcast |
| 581 | # when the broadcast ends. So, this property would not identify the number |
| 582 | # of viewers watching an archived video of a live broadcast that already |
| 583 | # ended. |
| 584 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified |
| 585 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 586 | # format. If the value is empty or |
| 587 | # the property is not present, then the broadcast is scheduled to continue |
| 588 | # indefinitely. |
| 589 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified |
| 590 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 591 | # format. This value will not be |
| 592 | # available until the broadcast begins. |
| 593 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified |
| 594 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 595 | # format. This value will not be |
| 596 | # available until the broadcast is over. |
| 597 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified |
| 598 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 599 | # format. |
| 600 | }, |
| 601 | "topicDetails": { # Freebase topic information related to the video. # The <code>topicDetails</code> object encapsulates information about <a |
| 602 | # href="http://www.freebase.com">Freebase</a> topics associated with the |
| 603 | # video. |
| 604 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the |
| 605 | # video's content. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 606 | "A String", |
| 607 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 608 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the |
| 609 | # video. These are topics that may be mentioned in, or appear in the video. |
| 610 | # You can retrieve information about each topic using <a |
| 611 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 612 | "A String", |
| 613 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 614 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. |
| 615 | # These are topics that are centrally featured in the video, and it can be |
| 616 | # said that the video is mainly about each of these. You can retrieve |
| 617 | # information about each topic using the < a |
| 618 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 619 | "A String", |
| 620 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 621 | }, |
| 622 | "fileDetails": { # Describes original video file properties, including technical details about # The <code>fileDetails</code> object encapsulates information about the |
| 623 | # video file that was uploaded to YouTube, including the file's resolution, |
| 624 | # duration, audio and video codecs, stream bitrates, and more. This data can |
| 625 | # only be retrieved by the video owner. |
| 626 | # audio and video streams, but also metadata information like content length, |
| 627 | # digitization time, or geotagging information. |
| 628 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or |
| 629 | # another type of file was uploaded. |
| 630 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item |
| 631 | # in the list contains detailed metadata about a video stream. |
| 632 | { # Information about a video stream. |
| 633 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
| 634 | "heightPixels": 42, # The encoded video content's height in pixels. |
| 635 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is |
| 636 | # a four-letter vendor code. |
| 637 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content |
| 638 | # to properly display the video. |
| 639 | "codec": "A String", # The video codec that the stream uses. |
| 640 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 641 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect |
| 642 | # ratio in which the video should be displayed. |
| 643 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the |
| 644 | # video's encoding aspect ratio as |
| 645 | # <code>width_pixels</code>&nbsp;/&nbsp;<code>height_pixels</code>. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 646 | }, |
| 647 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 648 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item |
| 649 | # in the list contains detailed metadata about an audio stream. |
| 650 | { # Information about an audio stream. |
| 651 | "codec": "A String", # The audio codec that the stream uses. |
| 652 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 653 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value |
| 654 | # is a four-letter vendor code. |
| 655 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 656 | }, |
| 657 | ], |
| 658 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits |
| 659 | # per second. |
| 660 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
| 661 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing |
| 662 | # engine. Currently, YouTube only processes video files, but this field |
| 663 | # is present whether a video file or another type of file was uploaded. |
| 664 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether |
| 665 | # a video file or another type of file was uploaded. |
| 666 | "container": "A String", # The uploaded video file's container format. |
| 667 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is |
| 668 | # specified in <a href="http://www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 669 | # format. Currently, the following ISO 8601 formats are supported: |
| 670 | # <ul> |
| 671 | # <li>Date only: <code>YYYY-MM-DD</code></li> |
| 672 | # <li>Naive time: <code>YYYY-MM-DDTHH:MM:SS</code></li> |
| 673 | # <li>Time with timezone: <code>YYYY-MM-DDTHH:MM:SS+HH:MM</code></li> |
| 674 | # </ul> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 675 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 676 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved |
| 677 | # by the video owner. |
| 678 | "videoGameRating": "A String", # Video game rating, if any. |
| 679 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only |
| 680 | # users of legal purchasing age in a particular country, as identified by |
| 681 | # ICAP, can view the content. |
| 682 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. |
| 683 | # Only users aged 18+ can view the content. The the field is |
| 684 | # <code>true</code> the content is restricted to viewers aged 18+. Otherwise |
| 685 | # The field won't be present. |
| 686 | }, |
| 687 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string |
| 688 | # <code>"youtube#video"</code>. |
| 689 | "suggestions": { # Specifies suggestions on how to improve video content, # The <code>suggestions</code> object encapsulates suggestions that identify |
| 690 | # opportunities to improve the video quality or the metadata for the uploaded |
| 691 | # video. This data can only be retrieved by the video owner. |
| 692 | # including encoding hints, tag suggestions, and editor suggestions. |
| 693 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the |
| 694 | # video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 695 | "A String", |
| 696 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 697 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to |
| 698 | # increase the likelihood that users will locate your video when searching |
| 699 | # or browsing on YouTube. |
| 700 | { # A single tag suggestion with it's relevance information. |
| 701 | "tag": "A String", # The keyword tag suggested for the video. |
| 702 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this |
| 703 | # information to display appropriate tag suggestions based on the video |
| 704 | # category that the video uploader associates with the video. By default, |
| 705 | # tag suggestions are relevant for all categories if there are no restricts |
| 706 | # defined for the keyword. |
| 707 | "A String", |
| 708 | ], |
| 709 | }, |
| 710 | ], |
| 711 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing |
| 712 | # the uploaded video video. These errors indicate that, regardless of the |
| 713 | # video's current <a href="#processingProgress.processingStatus">processing |
| 714 | # status</a>, eventually, that status will almost certainly be |
| 715 | # <code>failed</code>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | "A String", |
| 717 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 718 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality |
| 719 | # or playback experience of the uploaded video. |
| 720 | "A String", |
| 721 | ], |
| 722 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the |
| 723 | # uploaded video or that might result in an erroneous transcoding. |
| 724 | # These warnings are generated before YouTube actually processes the |
| 725 | # uploaded video file. In addition, they identify issues that are unlikely |
| 726 | # to cause the video processing to fail but that might cause problems |
| 727 | # such as sync issues, video artifacts, or a missing audio track. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 728 | "A String", |
| 729 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 730 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 731 | } |
| 732 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 733 | autoLevels: boolean, Should auto-levels be applied to the upload. |
| 734 | stabilize: boolean, Should stabilize be applied to the upload. |
| 735 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly <a |
| 736 | href="/youtube/v3/guides/authentication">authorized request</a>. |
| 737 | <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 738 | content partners.<br><br>The |
| 739 | <code><strong>onBehalfOfContentOwnerChannel</strong></code> parameter |
| 740 | specifies the YouTube channel ID of the channel to which a video is being |
| 741 | added. This parameter is required when a request specifies a value for the |
| 742 | <code>onBehalfOfContentOwner</code> parameter, and it can only be used in |
| 743 | conjunction with that parameter. In addition, the request must be |
| 744 | authorized using a CMS account that is linked to the content owner that the |
| 745 | <code>onBehalfOfContentOwner</code> parameter specifies. Finally, the |
| 746 | channel that the <code>onBehalfOfContentOwnerChannel</code> parameter value |
| 747 | specifies must be linked to the content owner that the |
| 748 | <code>onBehalfOfContentOwner</code> parameter specifies.<br><br>This |
| 749 | parameter is intended for YouTube content partners that own and manage many |
| 750 | different YouTube channels. It allows content owners to authenticate once |
| 751 | and perform actions on behalf of the channel specified in the parameter |
| 752 | value, without having to provide authentication credentials for each |
| 753 | separate channel. |
| 754 | notifySubscribers: boolean, Notify the channel subscribers about the new video. As default, the |
| 755 | notification is enabled. |
| 756 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 757 | content partners.<br><br>The |
| 758 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 759 | that the |
| 760 | request's authorization credentials identify a YouTube CMS user who is |
| 761 | acting on behalf of the content owner specified in the parameter value. |
| 762 | This parameter is intended for YouTube content partners that own and manage |
| 763 | many different YouTube channels. It allows content owners to authenticate |
| 764 | once and get access to all their video and channel data, without having to |
| 765 | provide authentication credentials for each individual channel. The CMS |
| 766 | account that the user authenticates with must be linked to the specified |
| 767 | YouTube content owner. |
| 768 | x__xgafv: string, V1 error format. |
| 769 | Allowed values |
| 770 | 1 - v1 error format |
| 771 | 2 - v2 error format |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 772 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| 773 | media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 774 | |
| 775 | Returns: |
| 776 | An object of the form: |
| 777 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 778 | { # A <code><strong>video</strong></code> resource represents a YouTube video. |
| 779 | "recordingDetails": { # Recording information associated with the video. # The <code>recordingDetails</code> object encapsulates information about the |
| 780 | # location, date and address where the video was recorded. |
| 781 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 782 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in <a |
| 783 | # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 784 | # (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>) format. |
| 785 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 786 | "latitude": 3.14, # Latitude in degrees. |
| 787 | "longitude": 3.14, # Longitude in degrees. |
| 788 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 789 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 790 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 791 | "contentDetails": { # Details about the content of a YouTube Video. # The <code>contentDetails</code> object contains information about the video |
| 792 | # content, including the length of the video and its aspect ratio. |
| 793 | "dimension": "A String", # The value of <code>dimension</code> indicates whether the video is |
| 794 | # available in 3D or in 2D. |
| 795 | "caption": "A String", # The value of <code>captions</code> indicates whether the video |
| 796 | # has captions or not. |
| 797 | "duration": "A String", # The length of the video. The tag value is an <a |
| 798 | # href="//en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> duration in |
| 799 | # the format <code>PT#M#S</code>, in which the letters <code>PT</code> |
| 800 | # indicate that the value specifies a period of time, and the letters |
| 801 | # <code>M</code> and <code>S</code> refer to length in minutes and seconds, |
| 802 | # respectively. The <code>#</code> characters preceding the <code>M</code> |
| 803 | # and <code>S</code> letters are both integers that specify the number of |
| 804 | # minutes (or seconds) of the video. For example, a value of |
| 805 | # <code>PT15M51S</code> indicates that the video is 15 minutes and 51 seconds |
| 806 | # long. |
| 807 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom |
| 808 | # thumbnail image for the video. |
| 809 | # This property is only visible to the video uploader. |
| 810 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The <code>regionRestriction</code> object contains information about the |
| 811 | # countries where a video is (or is not) viewable. The object will contain |
| 812 | # either the <code>contentDetails.regionRestriction.allowed</code> property |
| 813 | # or the <code>contentDetails.regionRestriction.blocked</code> property. |
| 814 | "allowed": [ # A list of region codes that identify countries where the video is |
| 815 | # viewable. If this property is present and a country is not listed |
| 816 | # in its value, then the video is blocked from appearing in that |
| 817 | # country. If this property is present and contains an empty list, |
| 818 | # the video is blocked in all countries. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 819 | "A String", |
| 820 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 821 | "blocked": [ # A list of region codes that identify countries where the video is |
| 822 | # blocked. If this property is present and a country is not listed in |
| 823 | # its value, then the video is viewable in that country. If this |
| 824 | # property is present and contains an empty list, the video is |
| 825 | # viewable in all countries. |
| 826 | "A String", |
| 827 | ], |
| 828 | }, |
| 829 | "licensedContent": True or False, # The value of <code>is_license_content</code> indicates whether the video is |
| 830 | # licensed content. |
| 831 | "countryRestriction": { # Rights management policy for YouTube resources. # The <code>countryRestriction</code> object contains information about the |
| 832 | # countries where a video is (or is not) viewable. |
| 833 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 834 | # not apply. |
| 835 | "A String", |
| 836 | ], |
| 837 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 838 | # policy is allowed or denied by default. |
| 839 | }, |
| 840 | "definition": "A String", # The value of <code>definition</code> indicates whether the video is |
| 841 | # available in high definition or only in standard definition. |
| 842 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for # Specifies the ratings that the video received under various rating schemes. |
| 843 | # movies and shows. |
| 844 | # LINT.IfChange |
| 845 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance |
| 846 | # de la classification des films (CSCF). |
| 847 | "icaaRating": "A String", # The video's Instituto de la Cinematograf&iacute;a y de las Artes |
| 848 | # Audiovisuales (ICAA - Spain) rating. |
| 849 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 850 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 851 | "oflcRating": "A String", # The video's Office of Film and Literature Classification |
| 852 | # (OFLC - New Zealand) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 853 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 854 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 855 | "djctqRating": "A String", # The video's Departamento de Justi&ccedil;a, Classifica&ccedil;&atilde;o, |
| 856 | # Qualifica&ccedil;&atilde;o e T&iacute;tulos (DJCQT - Brazil) rating. |
| 857 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See |
| 858 | # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 859 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 860 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 861 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian |
| 862 | # Communications and Media Authority (ACMA) rating. ACMA ratings are used |
| 863 | # to classify children's television programming. |
| 864 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 865 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attivit&agrave; |
| 866 | # Culturali e del Turismo (Italy). |
| 867 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and |
| 868 | # Telecommunications Commission (CRTC) for Canadian French-language |
| 869 | # broadcasts. For more information, see the |
| 870 | # <a href="http://www.cbsc.ca/english/agvot/frenchsystem.php">Canadian |
| 871 | # Broadcast Standards Council</a> website. |
| 872 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture |
| 873 | # (&#25991;&#21270;&#37096;). |
| 874 | "nkclvRating": "A String", # The video's rating from the Nacion&atilde;lais Kino centrs (National Film |
| 875 | # Centre of Latvia). |
| 876 | "csaRating": "A String", # The video's rating from France's Conseil sup&eacute;rieur de |
| 877 | # l’audiovisuel, which rates broadcast content. |
| 878 | "rteRating": "A String", # The video's rating from Ireland's Raidi&oacute; Teilif&iacute;s |
| 879 | # &Eacute;ireann. |
| 880 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. |
| 881 | # See the <a |
| 882 | # href="http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro">IFCO</a> |
| 883 | # website for more information. |
| 884 | "cceRating": "A String", # The video's rating from Portugal's Comiss&atilde;o de |
| 885 | # Classifica&ccedil;&atilde;o de Espect&acute;culos. |
| 886 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the |
| 887 | # Ministry of Culture and Tourism |
| 888 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 889 | "eirinRating": "A String", # The video's Eirin (&#26144;&#20523;) rating. |
| 890 | # Eirin is the Japanese rating system. |
| 891 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 892 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification |
| 893 | # (Bundesministerium f&uuml;r Unterricht, Kunst und Kultur). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 894 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 895 | "A String", |
| 896 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 897 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 898 | "smaisRating": "A String", # The video's rating in Iceland. |
| 899 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti |
| 900 | # (National Audiovisual Institute). |
| 901 | "smsaRating": "A String", # The video's rating from Statens medier&aring;d (Sweden's National Media |
| 902 | # Council). |
| 903 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 904 | "nbcplRating": "A String", # The video's rating in Poland. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 905 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 906 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 907 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut |
| 908 | # voor de Classificatie van Audiovisuele Media (Netherlands). |
| 909 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating |
| 910 | # Committee of the National Office of Film. |
| 911 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 912 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 913 | "cicfRating": "A String", # The video's rating from the Commission de Contr&ocirc;le des Films |
| 914 | # (Belgium). |
| 915 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper |
| 916 | # and Article Administration. |
| 917 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System |
| 918 | # The video's rating from the Canadian Radio-Television and |
| 919 | # Telecommunications Commission (CRTC) for Canadian English-language |
| 920 | # broadcasts. For more information, see the |
| 921 | # <a href="http://www.cbsc.ca/english/agvot/englishsystem.php">Canadian |
| 922 | # Broadcast Standards Council</a> website. |
| 923 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 924 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation |
| 925 | # (MKRF - Russia) rating. |
| 926 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 927 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 928 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 929 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | "A String", |
| 931 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 932 | "agcomRating": "A String", # The video's rating from Italy's Autorit&agrave; per le Garanzie nelle |
| 933 | # Comunicazioni (AGCOM). |
| 934 | "pefilmRating": "A String", # The video's rating in Peru. |
| 935 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 936 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske |
| 937 | # Filminstitut) Media Council for Children and Young People. |
| 938 | "grfilmRating": "A String", # The video's rating in Greece. |
| 939 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 940 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to |
| 941 | # prevent titles go live w/o additional QC check, since some of them can be |
| 942 | # inappropriate for the countries at all. See b/33408548 for more details. |
| 943 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 944 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, |
| 945 | # specifically, it's Board of Film Censors (BFC). |
| 946 | "kmrbRating": "A String", # The video's Korea Media Rating Board |
| 947 | # (&#50689;&#49345;&#47932;&#46321;&#44553;&#50948;&#50896;&#54924;) rating. |
| 948 | # The KMRB rates videos in South Korea. |
| 949 | "nfrcRating": "A String", # The video's rating from the <a href="http://www.nfc.bg/">Bulgarian |
| 950 | # National Film Center</a>. |
| 951 | "fmocRating": "A String", # <span class="deprecated">This property has been deprecated. Use the |
| 952 | # <code><a |
| 953 | # href="#contentDetails.contentRating.cncRating">contentDetails.contentRating.cncRating</a></code> |
| 954 | # instead.</span> |
| 955 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 956 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI |
| 957 | # (CNA). |
| 958 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft |
| 959 | # (FSK - Germany) rating. |
| 960 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 961 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - |
| 962 | # Argentina) rating. |
| 963 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 964 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography |
| 965 | # (Mexico) rating. |
| 966 | "anatelRating": "A String", # The video's Anatel (Asociaci&oacute;n Nacional de Televisi&oacute;n) |
| 967 | # rating for Chilean television. |
| 968 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and |
| 969 | # Classification Board (Philippines). |
| 970 | "cccRating": "A String", # The video's Consejo de Calificaci&oacute;n Cinematogr&aacute;fica (Chile) |
| 971 | # rating. |
| 972 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 973 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 974 | "projection": "A String", # Specifies the projection format of the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 975 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 976 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The <code>projectDetails</code> object contains information about the |
| 977 | # project specific video metadata. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 978 | "tags": [ # A list of project tags associated with the video during the upload. |
| 979 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 980 | ], |
| 981 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 982 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 983 | "localizations": { # The <code>localizations</code> object contains localized versions of the |
| 984 | # basic details about the video, such as its title and description. |
| 985 | "a_key": { # Localized versions of certain video properties (e.g. title). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 986 | "title": "A String", # Localized version of the video's title. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 987 | "description": "A String", # Localized version of the video's description. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 988 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 989 | }, |
| 990 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The <code>monetizationDetails</code> object encapsulates information |
| 991 | # about the monetization status of the video. |
| 992 | "access": { # Rights management policy for YouTube resources. # The value of <code>access</code> indicates whether the video can be |
| 993 | # monetized or not. |
| 994 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 995 | # not apply. |
| 996 | "A String", |
| 997 | ], |
| 998 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 999 | # policy is allowed or denied by default. |
| 1000 | }, |
| 1001 | }, |
| 1002 | "status": { # Basic details about a video category, such as its localized title. # The <code>status</code> object contains information about the video's |
| 1003 | # uploading, processing, and privacy statuses. |
| 1004 | # Next Id: 17 |
| 1005 | "failureReason": "A String", # This value explains why a video failed to upload. This property is |
| 1006 | # only present if the <code>uploadStatus</code> property indicates that |
| 1007 | # the upload failed. |
| 1008 | "privacyStatus": "A String", # The video's privacy status. |
| 1009 | "selfDeclaredMadeForKids": True or False, |
| 1010 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This |
| 1011 | # property is only present if the <code>uploadStatus</code> property |
| 1012 | # indicates that the upload was rejected. |
| 1013 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. |
| 1014 | # @mutable youtube.videos.insert youtube.videos.update |
| 1015 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set |
| 1016 | # only if the privacy status of the video is private. The value is specified |
| 1017 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1018 | # format. |
| 1019 | "madeForKids": True or False, |
| 1020 | "license": "A String", # The video's license. |
| 1021 | # @mutable youtube.videos.insert youtube.videos.update |
| 1022 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page |
| 1023 | # can be viewed by everyone. Note that the view count, likes, etc will still |
| 1024 | # be visible if this is disabled. |
| 1025 | # @mutable youtube.videos.insert youtube.videos.update |
| 1026 | "uploadStatus": "A String", # The status of the uploaded video. |
| 1027 | }, |
| 1028 | "statistics": { # Statistics about the video, such as the number of times the video was viewed # The <code>statistics</code> object contains statistics about the video. |
| 1029 | # or liked. |
| 1030 | "likeCount": "A String", # The number of users who have indicated that they liked the video by |
| 1031 | # giving it a positive rating. |
| 1032 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by |
| 1033 | # giving it a negative rating. |
| 1034 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite |
| 1035 | # video. |
| 1036 | "commentCount": "A String", # The number of comments for the video. |
| 1037 | "viewCount": "A String", # The number of times the video has been viewed. |
| 1038 | }, |
| 1039 | "snippet": { # Basic details about a video, including title, description, uploader, # The <code>snippet</code> object contains basic details about the video, |
| 1040 | # such as its title, description, and category. |
| 1041 | # thumbnails and category. |
| 1042 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization |
| 1043 | # exists, this field is populated with the default snippet. (Read-only) |
| 1044 | "title": "A String", # Localized version of the video's title. |
| 1045 | "description": "A String", # Localized version of the video's description. |
| 1046 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1047 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
| 1048 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1049 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1050 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 1051 | "title": "A String", # The video's title. |
| 1052 | # @mutable youtube.videos.insert youtube.videos.update |
| 1053 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. |
| 1054 | # Or it's "none" if the video is not an upcoming/active live broadcast. |
| 1055 | "description": "A String", # The video's description. |
| 1056 | # @mutable youtube.videos.insert youtube.videos.update |
| 1057 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 1058 | "defaultAudioLanguage": "A String", # The <code>default_audio_language</code> property specifies the language |
| 1059 | # spoken in the video's default audio track. |
| 1060 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the |
| 1061 | # video was uploaded to. |
| 1062 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the |
| 1063 | # map, the key is the name of the thumbnail image, and the value is an object |
| 1064 | # that contains other information about the thumbnail. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1065 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1066 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1067 | "url": "A String", # The thumbnail image's URL. |
| 1068 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1069 | }, |
| 1070 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1071 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1072 | "url": "A String", # The thumbnail image's URL. |
| 1073 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1074 | }, |
| 1075 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1076 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1077 | "url": "A String", # The thumbnail image's URL. |
| 1078 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1079 | }, |
| 1080 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1081 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1082 | "url": "A String", # The thumbnail image's URL. |
| 1083 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1084 | }, |
| 1085 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1086 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1087 | "url": "A String", # The thumbnail image's URL. |
| 1088 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1089 | }, |
| 1090 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1091 | "categoryId": "A String", # The YouTube <a href="/youtube/v3/docs/videoCategories/list">video |
| 1092 | # category</a> associated with the video. |
| 1093 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified |
| 1094 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1095 | # format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1096 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1097 | "processingDetails": { # Describes processing status and progress and availability of some other Video # The <code>processingDetails</code> object encapsulates information about |
| 1098 | # YouTube's progress in processing the uploaded video file. The properties |
| 1099 | # in the object identify the current processing status and an estimate of |
| 1100 | # the time remaining until YouTube finishes processing the video. This part |
| 1101 | # also indicates whether different types of data or content, such as file |
| 1102 | # details or thumbnail images, are available for the video.<br><br> |
| 1103 | # The <code>processingProgress</code> object is designed to be polled so |
| 1104 | # that the video uploaded can track the progress that YouTube has made in |
| 1105 | # processing the uploaded video file. This data can only be retrieved by |
| 1106 | # the video owner. |
| 1107 | # resource parts. |
| 1108 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded |
| 1109 | # video. You can retrieve a video's file details by requesting the |
| 1110 | # <code>fileDetails</code> part in your <code>videos.list()</code> request. |
| 1111 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will |
| 1112 | # only have a value if the <code>processingStatus</code> |
| 1113 | # property's value is <code>failed</code>. |
| 1114 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might |
| 1115 | # improve video quality or the playback experience, are available for |
| 1116 | # the video. You can retrieve these suggestions by requesting the |
| 1117 | # <code>suggestions</code> part in your <code>videos.list()</code> request. |
| 1118 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for |
| 1119 | # the video. Tags can be added to a video's metadata to make it easier for |
| 1120 | # other users to find the video. You can retrieve these suggestions by |
| 1121 | # requesting the <code>suggestions</code> part in your |
| 1122 | # <code>videos.list()</code> request. |
| 1123 | "processingProgress": { # Video processing progress and completion time estimate. # The <code>processingProgress</code> object contains information about the |
| 1124 | # progress YouTube has made in processing the video. The values are really |
| 1125 | # only relevant if the video's processing status is <code>processing</code>. |
| 1126 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs |
| 1127 | # to finish processing the video. |
| 1128 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. |
| 1129 | # You can estimate the percentage of the video that YouTube has already |
| 1130 | # processed by calculating:<br> |
| 1131 | # <code>100 * parts_processed / parts_total</code><br><br> |
| 1132 | # Note that since the estimated number of parts could increase without |
| 1133 | # a corresponding increase in the number of parts that have already been |
| 1134 | # processed, it is possible that the calculated progress could |
| 1135 | # periodically decrease while YouTube processes a video. |
| 1136 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed |
| 1137 | # for the video. The number may be updated with more precise estimates |
| 1138 | # while YouTube processes the video. |
| 1139 | }, |
| 1140 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for |
| 1141 | # the video. |
| 1142 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated |
| 1143 | # suggestions that might improve YouTube's ability to process the |
| 1144 | # the video, warnings that explain video processing problems, or |
| 1145 | # errors that cause video processing problems. You can retrieve these |
| 1146 | # suggestions by requesting the <code>suggestions</code> part in your |
| 1147 | # <code>videos.list()</code> request. |
| 1148 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was |
| 1149 | # able to process the video or if the video is still being processed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1150 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1151 | "etag": "A String", # Etag of this resource. |
| 1152 | "player": { # Player to be used for a video playback. # The <code>player</code> object contains information that you would use to |
| 1153 | # play the video in an embedded player. |
| 1154 | "embedWidth": "A String", # The embed width |
| 1155 | "embedHeight": "A String", |
| 1156 | "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| 1157 | # play the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1158 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1159 | "liveStreamingDetails": { # Details about the live streaming metadata. # The <code>liveStreamingDetails</code> object contains metadata about a live |
| 1160 | # video broadcast. The object will only be present in a <code>video</code> |
| 1161 | # resource if the video is an upcoming, live, or completed live broadcast. |
| 1162 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This |
| 1163 | # field is filled only if the video is a currently live broadcast that has |
| 1164 | # live chat. Once the broadcast transitions to complete this field will be |
| 1165 | # removed and the live chat closed down. For persistent broadcasts that live |
| 1166 | # chat id will no longer be tied to this video but rather to the new video |
| 1167 | # being displayed at the persistent page. |
| 1168 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and |
| 1169 | # its value will be present if the broadcast has current viewers and the |
| 1170 | # broadcast owner has not hidden the viewcount for the video. Note that |
| 1171 | # YouTube stops tracking the number of concurrent viewers for a broadcast |
| 1172 | # when the broadcast ends. So, this property would not identify the number |
| 1173 | # of viewers watching an archived video of a live broadcast that already |
| 1174 | # ended. |
| 1175 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified |
| 1176 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1177 | # format. If the value is empty or |
| 1178 | # the property is not present, then the broadcast is scheduled to continue |
| 1179 | # indefinitely. |
| 1180 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified |
| 1181 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1182 | # format. This value will not be |
| 1183 | # available until the broadcast begins. |
| 1184 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified |
| 1185 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1186 | # format. This value will not be |
| 1187 | # available until the broadcast is over. |
| 1188 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified |
| 1189 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1190 | # format. |
| 1191 | }, |
| 1192 | "topicDetails": { # Freebase topic information related to the video. # The <code>topicDetails</code> object encapsulates information about <a |
| 1193 | # href="http://www.freebase.com">Freebase</a> topics associated with the |
| 1194 | # video. |
| 1195 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the |
| 1196 | # video's content. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1197 | "A String", |
| 1198 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1199 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the |
| 1200 | # video. These are topics that may be mentioned in, or appear in the video. |
| 1201 | # You can retrieve information about each topic using <a |
| 1202 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1203 | "A String", |
| 1204 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1205 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. |
| 1206 | # These are topics that are centrally featured in the video, and it can be |
| 1207 | # said that the video is mainly about each of these. You can retrieve |
| 1208 | # information about each topic using the < a |
| 1209 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1210 | "A String", |
| 1211 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1212 | }, |
| 1213 | "fileDetails": { # Describes original video file properties, including technical details about # The <code>fileDetails</code> object encapsulates information about the |
| 1214 | # video file that was uploaded to YouTube, including the file's resolution, |
| 1215 | # duration, audio and video codecs, stream bitrates, and more. This data can |
| 1216 | # only be retrieved by the video owner. |
| 1217 | # audio and video streams, but also metadata information like content length, |
| 1218 | # digitization time, or geotagging information. |
| 1219 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or |
| 1220 | # another type of file was uploaded. |
| 1221 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item |
| 1222 | # in the list contains detailed metadata about a video stream. |
| 1223 | { # Information about a video stream. |
| 1224 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
| 1225 | "heightPixels": 42, # The encoded video content's height in pixels. |
| 1226 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is |
| 1227 | # a four-letter vendor code. |
| 1228 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content |
| 1229 | # to properly display the video. |
| 1230 | "codec": "A String", # The video codec that the stream uses. |
| 1231 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 1232 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect |
| 1233 | # ratio in which the video should be displayed. |
| 1234 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the |
| 1235 | # video's encoding aspect ratio as |
| 1236 | # <code>width_pixels</code>&nbsp;/&nbsp;<code>height_pixels</code>. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1237 | }, |
| 1238 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1239 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item |
| 1240 | # in the list contains detailed metadata about an audio stream. |
| 1241 | { # Information about an audio stream. |
| 1242 | "codec": "A String", # The audio codec that the stream uses. |
| 1243 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 1244 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value |
| 1245 | # is a four-letter vendor code. |
| 1246 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 1247 | }, |
| 1248 | ], |
| 1249 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits |
| 1250 | # per second. |
| 1251 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
| 1252 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing |
| 1253 | # engine. Currently, YouTube only processes video files, but this field |
| 1254 | # is present whether a video file or another type of file was uploaded. |
| 1255 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether |
| 1256 | # a video file or another type of file was uploaded. |
| 1257 | "container": "A String", # The uploaded video file's container format. |
| 1258 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is |
| 1259 | # specified in <a href="http://www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1260 | # format. Currently, the following ISO 8601 formats are supported: |
| 1261 | # <ul> |
| 1262 | # <li>Date only: <code>YYYY-MM-DD</code></li> |
| 1263 | # <li>Naive time: <code>YYYY-MM-DDTHH:MM:SS</code></li> |
| 1264 | # <li>Time with timezone: <code>YYYY-MM-DDTHH:MM:SS+HH:MM</code></li> |
| 1265 | # </ul> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1266 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1267 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved |
| 1268 | # by the video owner. |
| 1269 | "videoGameRating": "A String", # Video game rating, if any. |
| 1270 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only |
| 1271 | # users of legal purchasing age in a particular country, as identified by |
| 1272 | # ICAP, can view the content. |
| 1273 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. |
| 1274 | # Only users aged 18+ can view the content. The the field is |
| 1275 | # <code>true</code> the content is restricted to viewers aged 18+. Otherwise |
| 1276 | # The field won't be present. |
| 1277 | }, |
| 1278 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string |
| 1279 | # <code>"youtube#video"</code>. |
| 1280 | "suggestions": { # Specifies suggestions on how to improve video content, # The <code>suggestions</code> object encapsulates suggestions that identify |
| 1281 | # opportunities to improve the video quality or the metadata for the uploaded |
| 1282 | # video. This data can only be retrieved by the video owner. |
| 1283 | # including encoding hints, tag suggestions, and editor suggestions. |
| 1284 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the |
| 1285 | # video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1286 | "A String", |
| 1287 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1288 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to |
| 1289 | # increase the likelihood that users will locate your video when searching |
| 1290 | # or browsing on YouTube. |
| 1291 | { # A single tag suggestion with it's relevance information. |
| 1292 | "tag": "A String", # The keyword tag suggested for the video. |
| 1293 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this |
| 1294 | # information to display appropriate tag suggestions based on the video |
| 1295 | # category that the video uploader associates with the video. By default, |
| 1296 | # tag suggestions are relevant for all categories if there are no restricts |
| 1297 | # defined for the keyword. |
| 1298 | "A String", |
| 1299 | ], |
| 1300 | }, |
| 1301 | ], |
| 1302 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing |
| 1303 | # the uploaded video video. These errors indicate that, regardless of the |
| 1304 | # video's current <a href="#processingProgress.processingStatus">processing |
| 1305 | # status</a>, eventually, that status will almost certainly be |
| 1306 | # <code>failed</code>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1307 | "A String", |
| 1308 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1309 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality |
| 1310 | # or playback experience of the uploaded video. |
| 1311 | "A String", |
| 1312 | ], |
| 1313 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the |
| 1314 | # uploaded video or that might result in an erroneous transcoding. |
| 1315 | # These warnings are generated before YouTube actually processes the |
| 1316 | # uploaded video file. In addition, they identify issues that are unlikely |
| 1317 | # to cause the video processing to fail but that might cause problems |
| 1318 | # such as sync issues, video artifacts, or a missing audio track. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1319 | "A String", |
| 1320 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1321 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1322 | }</pre> |
| 1323 | </div> |
| 1324 | |
| 1325 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1326 | <code class="details" id="list">list(part, myRating=None, locale=None, chart=None, videoCategoryId=None, maxWidth=None, regionCode=None, maxHeight=None, id=None, maxResults=None, onBehalfOfContentOwner=None, hl=None, pageToken=None, x__xgafv=None)</code> |
| 1327 | <pre>Retrieves a list of resources, possibly filtered. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1328 | |
| 1329 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1330 | part: string, The <code><strong>part</strong></code> parameter specifies a |
| 1331 | comma-separated list of one or more <code>video</code> resource properties |
| 1332 | that the API response will include.<br><br>If the parameter identifies a |
| 1333 | property that contains child properties, the child properties will be |
| 1334 | included in the response. For example, in a <code>video</code> resource, |
| 1335 | the <code>snippet</code> property contains the <code>channelId</code>, |
| 1336 | <code>title</code>, <code>description</code>, <code>tags</code>, and |
| 1337 | <code>categoryId</code> properties. As such, if you set |
| 1338 | <code><strong>part=snippet</strong></code>, the API response will contain |
| 1339 | all of those properties. (required) (repeated) |
| 1340 | myRating: string, Return videos liked/disliked by the authenticated user. |
| 1341 | Does not support RateType.RATED_TYPE_NONE. |
| 1342 | locale: string, A parameter |
| 1343 | chart: string, Return the videos that are in the specified chart. |
| 1344 | videoCategoryId: string, Use chart that is specific to the specified video category |
| 1345 | maxWidth: integer, Return the player with maximum height specified in |
| 1346 | regionCode: string, Use a chart that is specific to the specified region |
| 1347 | maxHeight: integer, A parameter |
| 1348 | id: string, Return videos with the given ids. (repeated) |
| 1349 | maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| 1350 | maximum number of items that should be returned in the result |
| 1351 | set.<br><br><strong>Note:</strong> This parameter is supported for use in |
| 1352 | conjunction with the <code><a href="#myRating">myRating</a></code> and |
| 1353 | <code><a href="#chart">chart</a></code> parameters, but it is not supported |
| 1354 | for use in conjunction with the <code><a href="#id">id</a></code> |
| 1355 | parameter. |
| 1356 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 1357 | content partners.<br><br>The |
| 1358 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 1359 | that the |
| 1360 | request's authorization credentials identify a YouTube CMS user who is |
| 1361 | acting on behalf of the content owner specified in the parameter value. |
| 1362 | This parameter is intended for YouTube content partners that own and manage |
| 1363 | many different YouTube channels. It allows content owners to authenticate |
| 1364 | once and get access to all their video and channel data, without having to |
| 1365 | provide authentication credentials for each individual channel. The CMS |
| 1366 | account that the user authenticates with must be linked to the specified |
| 1367 | YouTube content owner. |
| 1368 | hl: string, Stands for "host language". Specifies the localization language of the |
| 1369 | metadata to be filled into snippet.localized. The field is filled with the |
| 1370 | default metadata if there is no localization in the specified language. |
| 1371 | The parameter value must be a language code included in the list returned |
| 1372 | by the i18nLanguages.list method (e.g. en_US, es_MX). |
| 1373 | pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| 1374 | page in the result set that should be returned. In an API response, the |
| 1375 | <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| 1376 | identify other pages that could be retrieved.<br><br><strong>Note:</strong> |
| 1377 | This parameter is supported for use in conjunction with the <code><a |
| 1378 | href="#myRating">myRating</a></code> and <code><a |
| 1379 | href="#chart">chart</a></code> parameters, but it is not supported for use |
| 1380 | in conjunction with the <code><a href="#id">id</a></code> parameter. |
| 1381 | x__xgafv: string, V1 error format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1382 | Allowed values |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1383 | 1 - v1 error format |
| 1384 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1385 | |
| 1386 | Returns: |
| 1387 | An object of the form: |
| 1388 | |
| 1389 | { |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1390 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 1391 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1392 | "etag": "A String", # Etag of this resource. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1393 | "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 1394 | # parameter to retrieve the next page in the result set. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1395 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1396 | "kind": "youtube#videoListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| 1397 | # <code>"youtube#videoListResponse"</code>. |
| 1398 | "items": [ |
| 1399 | { # A <code><strong>video</strong></code> resource represents a YouTube video. |
| 1400 | "recordingDetails": { # Recording information associated with the video. # The <code>recordingDetails</code> object encapsulates information about the |
| 1401 | # location, date and address where the video was recorded. |
| 1402 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 1403 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in <a |
| 1404 | # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1405 | # (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>) format. |
| 1406 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 1407 | "latitude": 3.14, # Latitude in degrees. |
| 1408 | "longitude": 3.14, # Longitude in degrees. |
| 1409 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 1410 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1411 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1412 | "contentDetails": { # Details about the content of a YouTube Video. # The <code>contentDetails</code> object contains information about the video |
| 1413 | # content, including the length of the video and its aspect ratio. |
| 1414 | "dimension": "A String", # The value of <code>dimension</code> indicates whether the video is |
| 1415 | # available in 3D or in 2D. |
| 1416 | "caption": "A String", # The value of <code>captions</code> indicates whether the video |
| 1417 | # has captions or not. |
| 1418 | "duration": "A String", # The length of the video. The tag value is an <a |
| 1419 | # href="//en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> duration in |
| 1420 | # the format <code>PT#M#S</code>, in which the letters <code>PT</code> |
| 1421 | # indicate that the value specifies a period of time, and the letters |
| 1422 | # <code>M</code> and <code>S</code> refer to length in minutes and seconds, |
| 1423 | # respectively. The <code>#</code> characters preceding the <code>M</code> |
| 1424 | # and <code>S</code> letters are both integers that specify the number of |
| 1425 | # minutes (or seconds) of the video. For example, a value of |
| 1426 | # <code>PT15M51S</code> indicates that the video is 15 minutes and 51 seconds |
| 1427 | # long. |
| 1428 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom |
| 1429 | # thumbnail image for the video. |
| 1430 | # This property is only visible to the video uploader. |
| 1431 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The <code>regionRestriction</code> object contains information about the |
| 1432 | # countries where a video is (or is not) viewable. The object will contain |
| 1433 | # either the <code>contentDetails.regionRestriction.allowed</code> property |
| 1434 | # or the <code>contentDetails.regionRestriction.blocked</code> property. |
| 1435 | "allowed": [ # A list of region codes that identify countries where the video is |
| 1436 | # viewable. If this property is present and a country is not listed |
| 1437 | # in its value, then the video is blocked from appearing in that |
| 1438 | # country. If this property is present and contains an empty list, |
| 1439 | # the video is blocked in all countries. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1440 | "A String", |
| 1441 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1442 | "blocked": [ # A list of region codes that identify countries where the video is |
| 1443 | # blocked. If this property is present and a country is not listed in |
| 1444 | # its value, then the video is viewable in that country. If this |
| 1445 | # property is present and contains an empty list, the video is |
| 1446 | # viewable in all countries. |
| 1447 | "A String", |
| 1448 | ], |
| 1449 | }, |
| 1450 | "licensedContent": True or False, # The value of <code>is_license_content</code> indicates whether the video is |
| 1451 | # licensed content. |
| 1452 | "countryRestriction": { # Rights management policy for YouTube resources. # The <code>countryRestriction</code> object contains information about the |
| 1453 | # countries where a video is (or is not) viewable. |
| 1454 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 1455 | # not apply. |
| 1456 | "A String", |
| 1457 | ], |
| 1458 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 1459 | # policy is allowed or denied by default. |
| 1460 | }, |
| 1461 | "definition": "A String", # The value of <code>definition</code> indicates whether the video is |
| 1462 | # available in high definition or only in standard definition. |
| 1463 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for # Specifies the ratings that the video received under various rating schemes. |
| 1464 | # movies and shows. |
| 1465 | # LINT.IfChange |
| 1466 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance |
| 1467 | # de la classification des films (CSCF). |
| 1468 | "icaaRating": "A String", # The video's Instituto de la Cinematograf&iacute;a y de las Artes |
| 1469 | # Audiovisuales (ICAA - Spain) rating. |
| 1470 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 1471 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 1472 | "oflcRating": "A String", # The video's Office of Film and Literature Classification |
| 1473 | # (OFLC - New Zealand) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1474 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1475 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1476 | "djctqRating": "A String", # The video's Departamento de Justi&ccedil;a, Classifica&ccedil;&atilde;o, |
| 1477 | # Qualifica&ccedil;&atilde;o e T&iacute;tulos (DJCQT - Brazil) rating. |
| 1478 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See |
| 1479 | # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 1480 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 1481 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 1482 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian |
| 1483 | # Communications and Media Authority (ACMA) rating. ACMA ratings are used |
| 1484 | # to classify children's television programming. |
| 1485 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 1486 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attivit&agrave; |
| 1487 | # Culturali e del Turismo (Italy). |
| 1488 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and |
| 1489 | # Telecommunications Commission (CRTC) for Canadian French-language |
| 1490 | # broadcasts. For more information, see the |
| 1491 | # <a href="http://www.cbsc.ca/english/agvot/frenchsystem.php">Canadian |
| 1492 | # Broadcast Standards Council</a> website. |
| 1493 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture |
| 1494 | # (&#25991;&#21270;&#37096;). |
| 1495 | "nkclvRating": "A String", # The video's rating from the Nacion&atilde;lais Kino centrs (National Film |
| 1496 | # Centre of Latvia). |
| 1497 | "csaRating": "A String", # The video's rating from France's Conseil sup&eacute;rieur de |
| 1498 | # l’audiovisuel, which rates broadcast content. |
| 1499 | "rteRating": "A String", # The video's rating from Ireland's Raidi&oacute; Teilif&iacute;s |
| 1500 | # &Eacute;ireann. |
| 1501 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. |
| 1502 | # See the <a |
| 1503 | # href="http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro">IFCO</a> |
| 1504 | # website for more information. |
| 1505 | "cceRating": "A String", # The video's rating from Portugal's Comiss&atilde;o de |
| 1506 | # Classifica&ccedil;&atilde;o de Espect&acute;culos. |
| 1507 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the |
| 1508 | # Ministry of Culture and Tourism |
| 1509 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 1510 | "eirinRating": "A String", # The video's Eirin (&#26144;&#20523;) rating. |
| 1511 | # Eirin is the Japanese rating system. |
| 1512 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 1513 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification |
| 1514 | # (Bundesministerium f&uuml;r Unterricht, Kunst und Kultur). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1515 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 1516 | "A String", |
| 1517 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1518 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1519 | "smaisRating": "A String", # The video's rating in Iceland. |
| 1520 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti |
| 1521 | # (National Audiovisual Institute). |
| 1522 | "smsaRating": "A String", # The video's rating from Statens medier&aring;d (Sweden's National Media |
| 1523 | # Council). |
| 1524 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 1525 | "nbcplRating": "A String", # The video's rating in Poland. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1526 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1527 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 1528 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut |
| 1529 | # voor de Classificatie van Audiovisuele Media (Netherlands). |
| 1530 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating |
| 1531 | # Committee of the National Office of Film. |
| 1532 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 1533 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 1534 | "cicfRating": "A String", # The video's rating from the Commission de Contr&ocirc;le des Films |
| 1535 | # (Belgium). |
| 1536 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper |
| 1537 | # and Article Administration. |
| 1538 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System |
| 1539 | # The video's rating from the Canadian Radio-Television and |
| 1540 | # Telecommunications Commission (CRTC) for Canadian English-language |
| 1541 | # broadcasts. For more information, see the |
| 1542 | # <a href="http://www.cbsc.ca/english/agvot/englishsystem.php">Canadian |
| 1543 | # Broadcast Standards Council</a> website. |
| 1544 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 1545 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation |
| 1546 | # (MKRF - Russia) rating. |
| 1547 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 1548 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 1549 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 1550 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1551 | "A String", |
| 1552 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1553 | "agcomRating": "A String", # The video's rating from Italy's Autorit&agrave; per le Garanzie nelle |
| 1554 | # Comunicazioni (AGCOM). |
| 1555 | "pefilmRating": "A String", # The video's rating in Peru. |
| 1556 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 1557 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske |
| 1558 | # Filminstitut) Media Council for Children and Young People. |
| 1559 | "grfilmRating": "A String", # The video's rating in Greece. |
| 1560 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 1561 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to |
| 1562 | # prevent titles go live w/o additional QC check, since some of them can be |
| 1563 | # inappropriate for the countries at all. See b/33408548 for more details. |
| 1564 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 1565 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, |
| 1566 | # specifically, it's Board of Film Censors (BFC). |
| 1567 | "kmrbRating": "A String", # The video's Korea Media Rating Board |
| 1568 | # (&#50689;&#49345;&#47932;&#46321;&#44553;&#50948;&#50896;&#54924;) rating. |
| 1569 | # The KMRB rates videos in South Korea. |
| 1570 | "nfrcRating": "A String", # The video's rating from the <a href="http://www.nfc.bg/">Bulgarian |
| 1571 | # National Film Center</a>. |
| 1572 | "fmocRating": "A String", # <span class="deprecated">This property has been deprecated. Use the |
| 1573 | # <code><a |
| 1574 | # href="#contentDetails.contentRating.cncRating">contentDetails.contentRating.cncRating</a></code> |
| 1575 | # instead.</span> |
| 1576 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 1577 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI |
| 1578 | # (CNA). |
| 1579 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft |
| 1580 | # (FSK - Germany) rating. |
| 1581 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 1582 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - |
| 1583 | # Argentina) rating. |
| 1584 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 1585 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography |
| 1586 | # (Mexico) rating. |
| 1587 | "anatelRating": "A String", # The video's Anatel (Asociaci&oacute;n Nacional de Televisi&oacute;n) |
| 1588 | # rating for Chilean television. |
| 1589 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and |
| 1590 | # Classification Board (Philippines). |
| 1591 | "cccRating": "A String", # The video's Consejo de Calificaci&oacute;n Cinematogr&aacute;fica (Chile) |
| 1592 | # rating. |
| 1593 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1594 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1595 | "projection": "A String", # Specifies the projection format of the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1596 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1597 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The <code>projectDetails</code> object contains information about the |
| 1598 | # project specific video metadata. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1599 | "tags": [ # A list of project tags associated with the video during the upload. |
| 1600 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1601 | ], |
| 1602 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1603 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 1604 | "localizations": { # The <code>localizations</code> object contains localized versions of the |
| 1605 | # basic details about the video, such as its title and description. |
| 1606 | "a_key": { # Localized versions of certain video properties (e.g. title). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1607 | "title": "A String", # Localized version of the video's title. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1608 | "description": "A String", # Localized version of the video's description. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1609 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1610 | }, |
| 1611 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The <code>monetizationDetails</code> object encapsulates information |
| 1612 | # about the monetization status of the video. |
| 1613 | "access": { # Rights management policy for YouTube resources. # The value of <code>access</code> indicates whether the video can be |
| 1614 | # monetized or not. |
| 1615 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 1616 | # not apply. |
| 1617 | "A String", |
| 1618 | ], |
| 1619 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 1620 | # policy is allowed or denied by default. |
| 1621 | }, |
| 1622 | }, |
| 1623 | "status": { # Basic details about a video category, such as its localized title. # The <code>status</code> object contains information about the video's |
| 1624 | # uploading, processing, and privacy statuses. |
| 1625 | # Next Id: 17 |
| 1626 | "failureReason": "A String", # This value explains why a video failed to upload. This property is |
| 1627 | # only present if the <code>uploadStatus</code> property indicates that |
| 1628 | # the upload failed. |
| 1629 | "privacyStatus": "A String", # The video's privacy status. |
| 1630 | "selfDeclaredMadeForKids": True or False, |
| 1631 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This |
| 1632 | # property is only present if the <code>uploadStatus</code> property |
| 1633 | # indicates that the upload was rejected. |
| 1634 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. |
| 1635 | # @mutable youtube.videos.insert youtube.videos.update |
| 1636 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set |
| 1637 | # only if the privacy status of the video is private. The value is specified |
| 1638 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1639 | # format. |
| 1640 | "madeForKids": True or False, |
| 1641 | "license": "A String", # The video's license. |
| 1642 | # @mutable youtube.videos.insert youtube.videos.update |
| 1643 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page |
| 1644 | # can be viewed by everyone. Note that the view count, likes, etc will still |
| 1645 | # be visible if this is disabled. |
| 1646 | # @mutable youtube.videos.insert youtube.videos.update |
| 1647 | "uploadStatus": "A String", # The status of the uploaded video. |
| 1648 | }, |
| 1649 | "statistics": { # Statistics about the video, such as the number of times the video was viewed # The <code>statistics</code> object contains statistics about the video. |
| 1650 | # or liked. |
| 1651 | "likeCount": "A String", # The number of users who have indicated that they liked the video by |
| 1652 | # giving it a positive rating. |
| 1653 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by |
| 1654 | # giving it a negative rating. |
| 1655 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite |
| 1656 | # video. |
| 1657 | "commentCount": "A String", # The number of comments for the video. |
| 1658 | "viewCount": "A String", # The number of times the video has been viewed. |
| 1659 | }, |
| 1660 | "snippet": { # Basic details about a video, including title, description, uploader, # The <code>snippet</code> object contains basic details about the video, |
| 1661 | # such as its title, description, and category. |
| 1662 | # thumbnails and category. |
| 1663 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization |
| 1664 | # exists, this field is populated with the default snippet. (Read-only) |
| 1665 | "title": "A String", # Localized version of the video's title. |
| 1666 | "description": "A String", # Localized version of the video's description. |
| 1667 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1668 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
| 1669 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1670 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1671 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 1672 | "title": "A String", # The video's title. |
| 1673 | # @mutable youtube.videos.insert youtube.videos.update |
| 1674 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. |
| 1675 | # Or it's "none" if the video is not an upcoming/active live broadcast. |
| 1676 | "description": "A String", # The video's description. |
| 1677 | # @mutable youtube.videos.insert youtube.videos.update |
| 1678 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 1679 | "defaultAudioLanguage": "A String", # The <code>default_audio_language</code> property specifies the language |
| 1680 | # spoken in the video's default audio track. |
| 1681 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the |
| 1682 | # video was uploaded to. |
| 1683 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the |
| 1684 | # map, the key is the name of the thumbnail image, and the value is an object |
| 1685 | # that contains other information about the thumbnail. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1686 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1687 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1688 | "url": "A String", # The thumbnail image's URL. |
| 1689 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1690 | }, |
| 1691 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1692 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1693 | "url": "A String", # The thumbnail image's URL. |
| 1694 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1695 | }, |
| 1696 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1697 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1698 | "url": "A String", # The thumbnail image's URL. |
| 1699 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1700 | }, |
| 1701 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1702 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1703 | "url": "A String", # The thumbnail image's URL. |
| 1704 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1705 | }, |
| 1706 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1707 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1708 | "url": "A String", # The thumbnail image's URL. |
| 1709 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1710 | }, |
| 1711 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1712 | "categoryId": "A String", # The YouTube <a href="/youtube/v3/docs/videoCategories/list">video |
| 1713 | # category</a> associated with the video. |
| 1714 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified |
| 1715 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1716 | # format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1717 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1718 | "processingDetails": { # Describes processing status and progress and availability of some other Video # The <code>processingDetails</code> object encapsulates information about |
| 1719 | # YouTube's progress in processing the uploaded video file. The properties |
| 1720 | # in the object identify the current processing status and an estimate of |
| 1721 | # the time remaining until YouTube finishes processing the video. This part |
| 1722 | # also indicates whether different types of data or content, such as file |
| 1723 | # details or thumbnail images, are available for the video.<br><br> |
| 1724 | # The <code>processingProgress</code> object is designed to be polled so |
| 1725 | # that the video uploaded can track the progress that YouTube has made in |
| 1726 | # processing the uploaded video file. This data can only be retrieved by |
| 1727 | # the video owner. |
| 1728 | # resource parts. |
| 1729 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded |
| 1730 | # video. You can retrieve a video's file details by requesting the |
| 1731 | # <code>fileDetails</code> part in your <code>videos.list()</code> request. |
| 1732 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will |
| 1733 | # only have a value if the <code>processingStatus</code> |
| 1734 | # property's value is <code>failed</code>. |
| 1735 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might |
| 1736 | # improve video quality or the playback experience, are available for |
| 1737 | # the video. You can retrieve these suggestions by requesting the |
| 1738 | # <code>suggestions</code> part in your <code>videos.list()</code> request. |
| 1739 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for |
| 1740 | # the video. Tags can be added to a video's metadata to make it easier for |
| 1741 | # other users to find the video. You can retrieve these suggestions by |
| 1742 | # requesting the <code>suggestions</code> part in your |
| 1743 | # <code>videos.list()</code> request. |
| 1744 | "processingProgress": { # Video processing progress and completion time estimate. # The <code>processingProgress</code> object contains information about the |
| 1745 | # progress YouTube has made in processing the video. The values are really |
| 1746 | # only relevant if the video's processing status is <code>processing</code>. |
| 1747 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs |
| 1748 | # to finish processing the video. |
| 1749 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. |
| 1750 | # You can estimate the percentage of the video that YouTube has already |
| 1751 | # processed by calculating:<br> |
| 1752 | # <code>100 * parts_processed / parts_total</code><br><br> |
| 1753 | # Note that since the estimated number of parts could increase without |
| 1754 | # a corresponding increase in the number of parts that have already been |
| 1755 | # processed, it is possible that the calculated progress could |
| 1756 | # periodically decrease while YouTube processes a video. |
| 1757 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed |
| 1758 | # for the video. The number may be updated with more precise estimates |
| 1759 | # while YouTube processes the video. |
| 1760 | }, |
| 1761 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for |
| 1762 | # the video. |
| 1763 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated |
| 1764 | # suggestions that might improve YouTube's ability to process the |
| 1765 | # the video, warnings that explain video processing problems, or |
| 1766 | # errors that cause video processing problems. You can retrieve these |
| 1767 | # suggestions by requesting the <code>suggestions</code> part in your |
| 1768 | # <code>videos.list()</code> request. |
| 1769 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was |
| 1770 | # able to process the video or if the video is still being processed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1771 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1772 | "etag": "A String", # Etag of this resource. |
| 1773 | "player": { # Player to be used for a video playback. # The <code>player</code> object contains information that you would use to |
| 1774 | # play the video in an embedded player. |
| 1775 | "embedWidth": "A String", # The embed width |
| 1776 | "embedHeight": "A String", |
| 1777 | "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| 1778 | # play the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1779 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1780 | "liveStreamingDetails": { # Details about the live streaming metadata. # The <code>liveStreamingDetails</code> object contains metadata about a live |
| 1781 | # video broadcast. The object will only be present in a <code>video</code> |
| 1782 | # resource if the video is an upcoming, live, or completed live broadcast. |
| 1783 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This |
| 1784 | # field is filled only if the video is a currently live broadcast that has |
| 1785 | # live chat. Once the broadcast transitions to complete this field will be |
| 1786 | # removed and the live chat closed down. For persistent broadcasts that live |
| 1787 | # chat id will no longer be tied to this video but rather to the new video |
| 1788 | # being displayed at the persistent page. |
| 1789 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and |
| 1790 | # its value will be present if the broadcast has current viewers and the |
| 1791 | # broadcast owner has not hidden the viewcount for the video. Note that |
| 1792 | # YouTube stops tracking the number of concurrent viewers for a broadcast |
| 1793 | # when the broadcast ends. So, this property would not identify the number |
| 1794 | # of viewers watching an archived video of a live broadcast that already |
| 1795 | # ended. |
| 1796 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified |
| 1797 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1798 | # format. If the value is empty or |
| 1799 | # the property is not present, then the broadcast is scheduled to continue |
| 1800 | # indefinitely. |
| 1801 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified |
| 1802 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1803 | # format. This value will not be |
| 1804 | # available until the broadcast begins. |
| 1805 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified |
| 1806 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1807 | # format. This value will not be |
| 1808 | # available until the broadcast is over. |
| 1809 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified |
| 1810 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1811 | # format. |
| 1812 | }, |
| 1813 | "topicDetails": { # Freebase topic information related to the video. # The <code>topicDetails</code> object encapsulates information about <a |
| 1814 | # href="http://www.freebase.com">Freebase</a> topics associated with the |
| 1815 | # video. |
| 1816 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the |
| 1817 | # video's content. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1818 | "A String", |
| 1819 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1820 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the |
| 1821 | # video. These are topics that may be mentioned in, or appear in the video. |
| 1822 | # You can retrieve information about each topic using <a |
| 1823 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1824 | "A String", |
| 1825 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1826 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. |
| 1827 | # These are topics that are centrally featured in the video, and it can be |
| 1828 | # said that the video is mainly about each of these. You can retrieve |
| 1829 | # information about each topic using the < a |
| 1830 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1831 | "A String", |
| 1832 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1833 | }, |
| 1834 | "fileDetails": { # Describes original video file properties, including technical details about # The <code>fileDetails</code> object encapsulates information about the |
| 1835 | # video file that was uploaded to YouTube, including the file's resolution, |
| 1836 | # duration, audio and video codecs, stream bitrates, and more. This data can |
| 1837 | # only be retrieved by the video owner. |
| 1838 | # audio and video streams, but also metadata information like content length, |
| 1839 | # digitization time, or geotagging information. |
| 1840 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or |
| 1841 | # another type of file was uploaded. |
| 1842 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item |
| 1843 | # in the list contains detailed metadata about a video stream. |
| 1844 | { # Information about a video stream. |
| 1845 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
| 1846 | "heightPixels": 42, # The encoded video content's height in pixels. |
| 1847 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is |
| 1848 | # a four-letter vendor code. |
| 1849 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content |
| 1850 | # to properly display the video. |
| 1851 | "codec": "A String", # The video codec that the stream uses. |
| 1852 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 1853 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect |
| 1854 | # ratio in which the video should be displayed. |
| 1855 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the |
| 1856 | # video's encoding aspect ratio as |
| 1857 | # <code>width_pixels</code>&nbsp;/&nbsp;<code>height_pixels</code>. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1858 | }, |
| 1859 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1860 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item |
| 1861 | # in the list contains detailed metadata about an audio stream. |
| 1862 | { # Information about an audio stream. |
| 1863 | "codec": "A String", # The audio codec that the stream uses. |
| 1864 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 1865 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value |
| 1866 | # is a four-letter vendor code. |
| 1867 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 1868 | }, |
| 1869 | ], |
| 1870 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits |
| 1871 | # per second. |
| 1872 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
| 1873 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing |
| 1874 | # engine. Currently, YouTube only processes video files, but this field |
| 1875 | # is present whether a video file or another type of file was uploaded. |
| 1876 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether |
| 1877 | # a video file or another type of file was uploaded. |
| 1878 | "container": "A String", # The uploaded video file's container format. |
| 1879 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is |
| 1880 | # specified in <a href="http://www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 1881 | # format. Currently, the following ISO 8601 formats are supported: |
| 1882 | # <ul> |
| 1883 | # <li>Date only: <code>YYYY-MM-DD</code></li> |
| 1884 | # <li>Naive time: <code>YYYY-MM-DDTHH:MM:SS</code></li> |
| 1885 | # <li>Time with timezone: <code>YYYY-MM-DDTHH:MM:SS+HH:MM</code></li> |
| 1886 | # </ul> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1887 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1888 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved |
| 1889 | # by the video owner. |
| 1890 | "videoGameRating": "A String", # Video game rating, if any. |
| 1891 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only |
| 1892 | # users of legal purchasing age in a particular country, as identified by |
| 1893 | # ICAP, can view the content. |
| 1894 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. |
| 1895 | # Only users aged 18+ can view the content. The the field is |
| 1896 | # <code>true</code> the content is restricted to viewers aged 18+. Otherwise |
| 1897 | # The field won't be present. |
| 1898 | }, |
| 1899 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string |
| 1900 | # <code>"youtube#video"</code>. |
| 1901 | "suggestions": { # Specifies suggestions on how to improve video content, # The <code>suggestions</code> object encapsulates suggestions that identify |
| 1902 | # opportunities to improve the video quality or the metadata for the uploaded |
| 1903 | # video. This data can only be retrieved by the video owner. |
| 1904 | # including encoding hints, tag suggestions, and editor suggestions. |
| 1905 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the |
| 1906 | # video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1907 | "A String", |
| 1908 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1909 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to |
| 1910 | # increase the likelihood that users will locate your video when searching |
| 1911 | # or browsing on YouTube. |
| 1912 | { # A single tag suggestion with it's relevance information. |
| 1913 | "tag": "A String", # The keyword tag suggested for the video. |
| 1914 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this |
| 1915 | # information to display appropriate tag suggestions based on the video |
| 1916 | # category that the video uploader associates with the video. By default, |
| 1917 | # tag suggestions are relevant for all categories if there are no restricts |
| 1918 | # defined for the keyword. |
| 1919 | "A String", |
| 1920 | ], |
| 1921 | }, |
| 1922 | ], |
| 1923 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing |
| 1924 | # the uploaded video video. These errors indicate that, regardless of the |
| 1925 | # video's current <a href="#processingProgress.processingStatus">processing |
| 1926 | # status</a>, eventually, that status will almost certainly be |
| 1927 | # <code>failed</code>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1928 | "A String", |
| 1929 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1930 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality |
| 1931 | # or playback experience of the uploaded video. |
| 1932 | "A String", |
| 1933 | ], |
| 1934 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the |
| 1935 | # uploaded video or that might result in an erroneous transcoding. |
| 1936 | # These warnings are generated before YouTube actually processes the |
| 1937 | # uploaded video file. In addition, they identify issues that are unlikely |
| 1938 | # to cause the video processing to fail but that might cause problems |
| 1939 | # such as sync issues, video artifacts, or a missing audio track. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1940 | "A String", |
| 1941 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1942 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1943 | }, |
| 1944 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1945 | "pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information. |
| 1946 | # available and number of resources returned in a single page. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1947 | "resultsPerPage": 42, # The number of results included in the API response. |
| 1948 | "totalResults": 42, # The total number of results in the result set. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1949 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1950 | "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 1951 | # parameter to retrieve the previous page in the result set. |
| 1952 | "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1953 | }</pre> |
| 1954 | </div> |
| 1955 | |
| 1956 | <div class="method"> |
| 1957 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1958 | <pre>Retrieves the next page of results. |
| 1959 | |
| 1960 | Args: |
| 1961 | previous_request: The request for the previous page. (required) |
| 1962 | previous_response: The response from the request for the previous page. (required) |
| 1963 | |
| 1964 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1965 | A request object that you can call 'execute()' on to request the next |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1966 | page. Returns None if there are no more items in the collection. |
| 1967 | </pre> |
| 1968 | </div> |
| 1969 | |
| 1970 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1971 | <code class="details" id="rate">rate(id, rating, x__xgafv=None)</code> |
| 1972 | <pre>Adds a like or dislike rating to a video or removes a rating from a video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1973 | |
| 1974 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1975 | id: string, A parameter (required) |
| 1976 | rating: string, A parameter (required) |
| 1977 | x__xgafv: string, V1 error format. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1978 | Allowed values |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1979 | 1 - v1 error format |
| 1980 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1981 | </pre> |
| 1982 | </div> |
| 1983 | |
| 1984 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1985 | <code class="details" id="reportAbuse">reportAbuse(body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1986 | <pre>Report abuse for a video. |
| 1987 | |
| 1988 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1989 | body: object, The request body. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1990 | The object takes the form of: |
| 1991 | |
| 1992 | { |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1993 | "secondaryReasonId": "A String", # The specific, or secondary, reason that this content is abusive (if |
| 1994 | # available). The value is an abuse report reason ID that is a valid |
| 1995 | # secondary reason for the primary reason. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1996 | "language": "A String", # The language that the content was viewed in. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1997 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 1998 | "reasonId": "A String", # The high-level, or primary, reason that the content is abusive. The value |
| 1999 | # is an abuse report reason ID. |
| 2000 | "comments": "A String", # Additional comments regarding the abuse report. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2001 | } |
| 2002 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2003 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 2004 | content partners.<br><br>The |
| 2005 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 2006 | that the |
| 2007 | request's authorization credentials identify a YouTube CMS user who is |
| 2008 | acting on behalf of the content owner specified in the parameter value. |
| 2009 | This parameter is intended for YouTube content partners that own and manage |
| 2010 | many different YouTube channels. It allows content owners to authenticate |
| 2011 | once and get access to all their video and channel data, without having to |
| 2012 | provide authentication credentials for each individual channel. The CMS |
| 2013 | account that the user authenticates with must be linked to the specified |
| 2014 | YouTube content owner. |
| 2015 | x__xgafv: string, V1 error format. |
| 2016 | Allowed values |
| 2017 | 1 - v1 error format |
| 2018 | 2 - v2 error format |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2019 | </pre> |
| 2020 | </div> |
| 2021 | |
| 2022 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2023 | <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 2024 | <pre>Updates an existing resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2025 | |
| 2026 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2027 | part: string, The <code><strong>part</strong></code> parameter serves two purposes in |
| 2028 | this operation. It identifies the properties that the write operation will |
| 2029 | set as well as the properties that the API response will |
| 2030 | include.<br/><br/>Note that this method will override the existing values |
| 2031 | for all of the mutable properties that are contained in any parts that the |
| 2032 | parameter value specifies. For example, a |
| 2033 | video's privacy setting is contained in the <code>status</code> part. As |
| 2034 | such, if your request is updating a private video, and the request's |
| 2035 | <code>part</code> parameter value includes the <code>status</code> part, |
| 2036 | the |
| 2037 | video's privacy setting will be updated to whatever value the request body |
| 2038 | specifies. If the request body does not specify a value, the existing |
| 2039 | privacy setting will be removed and the video will revert to the default |
| 2040 | privacy setting.<br/><br/>In addition, not all parts contain properties |
| 2041 | that can be set when inserting or updating a video. For example, the |
| 2042 | <code>statistics</code> object encapsulates statistics that YouTube |
| 2043 | calculates for a video and does not contain values that you can set or |
| 2044 | modify. If the parameter value specifies a <code>part</code> that does not |
| 2045 | contain mutable values, that <code>part</code> will still be included in |
| 2046 | the API response. (required) (repeated) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 2047 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2048 | The object takes the form of: |
| 2049 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2050 | { # A <code><strong>video</strong></code> resource represents a YouTube video. |
| 2051 | "recordingDetails": { # Recording information associated with the video. # The <code>recordingDetails</code> object encapsulates information about the |
| 2052 | # location, date and address where the video was recorded. |
| 2053 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 2054 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in <a |
| 2055 | # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2056 | # (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>) format. |
| 2057 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 2058 | "latitude": 3.14, # Latitude in degrees. |
| 2059 | "longitude": 3.14, # Longitude in degrees. |
| 2060 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 2061 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2062 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2063 | "contentDetails": { # Details about the content of a YouTube Video. # The <code>contentDetails</code> object contains information about the video |
| 2064 | # content, including the length of the video and its aspect ratio. |
| 2065 | "dimension": "A String", # The value of <code>dimension</code> indicates whether the video is |
| 2066 | # available in 3D or in 2D. |
| 2067 | "caption": "A String", # The value of <code>captions</code> indicates whether the video |
| 2068 | # has captions or not. |
| 2069 | "duration": "A String", # The length of the video. The tag value is an <a |
| 2070 | # href="//en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> duration in |
| 2071 | # the format <code>PT#M#S</code>, in which the letters <code>PT</code> |
| 2072 | # indicate that the value specifies a period of time, and the letters |
| 2073 | # <code>M</code> and <code>S</code> refer to length in minutes and seconds, |
| 2074 | # respectively. The <code>#</code> characters preceding the <code>M</code> |
| 2075 | # and <code>S</code> letters are both integers that specify the number of |
| 2076 | # minutes (or seconds) of the video. For example, a value of |
| 2077 | # <code>PT15M51S</code> indicates that the video is 15 minutes and 51 seconds |
| 2078 | # long. |
| 2079 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom |
| 2080 | # thumbnail image for the video. |
| 2081 | # This property is only visible to the video uploader. |
| 2082 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The <code>regionRestriction</code> object contains information about the |
| 2083 | # countries where a video is (or is not) viewable. The object will contain |
| 2084 | # either the <code>contentDetails.regionRestriction.allowed</code> property |
| 2085 | # or the <code>contentDetails.regionRestriction.blocked</code> property. |
| 2086 | "allowed": [ # A list of region codes that identify countries where the video is |
| 2087 | # viewable. If this property is present and a country is not listed |
| 2088 | # in its value, then the video is blocked from appearing in that |
| 2089 | # country. If this property is present and contains an empty list, |
| 2090 | # the video is blocked in all countries. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2091 | "A String", |
| 2092 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2093 | "blocked": [ # A list of region codes that identify countries where the video is |
| 2094 | # blocked. If this property is present and a country is not listed in |
| 2095 | # its value, then the video is viewable in that country. If this |
| 2096 | # property is present and contains an empty list, the video is |
| 2097 | # viewable in all countries. |
| 2098 | "A String", |
| 2099 | ], |
| 2100 | }, |
| 2101 | "licensedContent": True or False, # The value of <code>is_license_content</code> indicates whether the video is |
| 2102 | # licensed content. |
| 2103 | "countryRestriction": { # Rights management policy for YouTube resources. # The <code>countryRestriction</code> object contains information about the |
| 2104 | # countries where a video is (or is not) viewable. |
| 2105 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 2106 | # not apply. |
| 2107 | "A String", |
| 2108 | ], |
| 2109 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 2110 | # policy is allowed or denied by default. |
| 2111 | }, |
| 2112 | "definition": "A String", # The value of <code>definition</code> indicates whether the video is |
| 2113 | # available in high definition or only in standard definition. |
| 2114 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for # Specifies the ratings that the video received under various rating schemes. |
| 2115 | # movies and shows. |
| 2116 | # LINT.IfChange |
| 2117 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance |
| 2118 | # de la classification des films (CSCF). |
| 2119 | "icaaRating": "A String", # The video's Instituto de la Cinematograf&iacute;a y de las Artes |
| 2120 | # Audiovisuales (ICAA - Spain) rating. |
| 2121 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 2122 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 2123 | "oflcRating": "A String", # The video's Office of Film and Literature Classification |
| 2124 | # (OFLC - New Zealand) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2125 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2126 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2127 | "djctqRating": "A String", # The video's Departamento de Justi&ccedil;a, Classifica&ccedil;&atilde;o, |
| 2128 | # Qualifica&ccedil;&atilde;o e T&iacute;tulos (DJCQT - Brazil) rating. |
| 2129 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See |
| 2130 | # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 2131 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 2132 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 2133 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian |
| 2134 | # Communications and Media Authority (ACMA) rating. ACMA ratings are used |
| 2135 | # to classify children's television programming. |
| 2136 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 2137 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attivit&agrave; |
| 2138 | # Culturali e del Turismo (Italy). |
| 2139 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and |
| 2140 | # Telecommunications Commission (CRTC) for Canadian French-language |
| 2141 | # broadcasts. For more information, see the |
| 2142 | # <a href="http://www.cbsc.ca/english/agvot/frenchsystem.php">Canadian |
| 2143 | # Broadcast Standards Council</a> website. |
| 2144 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture |
| 2145 | # (&#25991;&#21270;&#37096;). |
| 2146 | "nkclvRating": "A String", # The video's rating from the Nacion&atilde;lais Kino centrs (National Film |
| 2147 | # Centre of Latvia). |
| 2148 | "csaRating": "A String", # The video's rating from France's Conseil sup&eacute;rieur de |
| 2149 | # l’audiovisuel, which rates broadcast content. |
| 2150 | "rteRating": "A String", # The video's rating from Ireland's Raidi&oacute; Teilif&iacute;s |
| 2151 | # &Eacute;ireann. |
| 2152 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. |
| 2153 | # See the <a |
| 2154 | # href="http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro">IFCO</a> |
| 2155 | # website for more information. |
| 2156 | "cceRating": "A String", # The video's rating from Portugal's Comiss&atilde;o de |
| 2157 | # Classifica&ccedil;&atilde;o de Espect&acute;culos. |
| 2158 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the |
| 2159 | # Ministry of Culture and Tourism |
| 2160 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 2161 | "eirinRating": "A String", # The video's Eirin (&#26144;&#20523;) rating. |
| 2162 | # Eirin is the Japanese rating system. |
| 2163 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 2164 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification |
| 2165 | # (Bundesministerium f&uuml;r Unterricht, Kunst und Kultur). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2166 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 2167 | "A String", |
| 2168 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2169 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2170 | "smaisRating": "A String", # The video's rating in Iceland. |
| 2171 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti |
| 2172 | # (National Audiovisual Institute). |
| 2173 | "smsaRating": "A String", # The video's rating from Statens medier&aring;d (Sweden's National Media |
| 2174 | # Council). |
| 2175 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 2176 | "nbcplRating": "A String", # The video's rating in Poland. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2177 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2178 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 2179 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut |
| 2180 | # voor de Classificatie van Audiovisuele Media (Netherlands). |
| 2181 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating |
| 2182 | # Committee of the National Office of Film. |
| 2183 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 2184 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 2185 | "cicfRating": "A String", # The video's rating from the Commission de Contr&ocirc;le des Films |
| 2186 | # (Belgium). |
| 2187 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper |
| 2188 | # and Article Administration. |
| 2189 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System |
| 2190 | # The video's rating from the Canadian Radio-Television and |
| 2191 | # Telecommunications Commission (CRTC) for Canadian English-language |
| 2192 | # broadcasts. For more information, see the |
| 2193 | # <a href="http://www.cbsc.ca/english/agvot/englishsystem.php">Canadian |
| 2194 | # Broadcast Standards Council</a> website. |
| 2195 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 2196 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation |
| 2197 | # (MKRF - Russia) rating. |
| 2198 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 2199 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 2200 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 2201 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2202 | "A String", |
| 2203 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2204 | "agcomRating": "A String", # The video's rating from Italy's Autorit&agrave; per le Garanzie nelle |
| 2205 | # Comunicazioni (AGCOM). |
| 2206 | "pefilmRating": "A String", # The video's rating in Peru. |
| 2207 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 2208 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske |
| 2209 | # Filminstitut) Media Council for Children and Young People. |
| 2210 | "grfilmRating": "A String", # The video's rating in Greece. |
| 2211 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 2212 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to |
| 2213 | # prevent titles go live w/o additional QC check, since some of them can be |
| 2214 | # inappropriate for the countries at all. See b/33408548 for more details. |
| 2215 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 2216 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, |
| 2217 | # specifically, it's Board of Film Censors (BFC). |
| 2218 | "kmrbRating": "A String", # The video's Korea Media Rating Board |
| 2219 | # (&#50689;&#49345;&#47932;&#46321;&#44553;&#50948;&#50896;&#54924;) rating. |
| 2220 | # The KMRB rates videos in South Korea. |
| 2221 | "nfrcRating": "A String", # The video's rating from the <a href="http://www.nfc.bg/">Bulgarian |
| 2222 | # National Film Center</a>. |
| 2223 | "fmocRating": "A String", # <span class="deprecated">This property has been deprecated. Use the |
| 2224 | # <code><a |
| 2225 | # href="#contentDetails.contentRating.cncRating">contentDetails.contentRating.cncRating</a></code> |
| 2226 | # instead.</span> |
| 2227 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 2228 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI |
| 2229 | # (CNA). |
| 2230 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft |
| 2231 | # (FSK - Germany) rating. |
| 2232 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 2233 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - |
| 2234 | # Argentina) rating. |
| 2235 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 2236 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography |
| 2237 | # (Mexico) rating. |
| 2238 | "anatelRating": "A String", # The video's Anatel (Asociaci&oacute;n Nacional de Televisi&oacute;n) |
| 2239 | # rating for Chilean television. |
| 2240 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and |
| 2241 | # Classification Board (Philippines). |
| 2242 | "cccRating": "A String", # The video's Consejo de Calificaci&oacute;n Cinematogr&aacute;fica (Chile) |
| 2243 | # rating. |
| 2244 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2245 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2246 | "projection": "A String", # Specifies the projection format of the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2247 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2248 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The <code>projectDetails</code> object contains information about the |
| 2249 | # project specific video metadata. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2250 | "tags": [ # A list of project tags associated with the video during the upload. |
| 2251 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2252 | ], |
| 2253 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2254 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 2255 | "localizations": { # The <code>localizations</code> object contains localized versions of the |
| 2256 | # basic details about the video, such as its title and description. |
| 2257 | "a_key": { # Localized versions of certain video properties (e.g. title). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2258 | "title": "A String", # Localized version of the video's title. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2259 | "description": "A String", # Localized version of the video's description. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2260 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2261 | }, |
| 2262 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The <code>monetizationDetails</code> object encapsulates information |
| 2263 | # about the monetization status of the video. |
| 2264 | "access": { # Rights management policy for YouTube resources. # The value of <code>access</code> indicates whether the video can be |
| 2265 | # monetized or not. |
| 2266 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 2267 | # not apply. |
| 2268 | "A String", |
| 2269 | ], |
| 2270 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 2271 | # policy is allowed or denied by default. |
| 2272 | }, |
| 2273 | }, |
| 2274 | "status": { # Basic details about a video category, such as its localized title. # The <code>status</code> object contains information about the video's |
| 2275 | # uploading, processing, and privacy statuses. |
| 2276 | # Next Id: 17 |
| 2277 | "failureReason": "A String", # This value explains why a video failed to upload. This property is |
| 2278 | # only present if the <code>uploadStatus</code> property indicates that |
| 2279 | # the upload failed. |
| 2280 | "privacyStatus": "A String", # The video's privacy status. |
| 2281 | "selfDeclaredMadeForKids": True or False, |
| 2282 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This |
| 2283 | # property is only present if the <code>uploadStatus</code> property |
| 2284 | # indicates that the upload was rejected. |
| 2285 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. |
| 2286 | # @mutable youtube.videos.insert youtube.videos.update |
| 2287 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set |
| 2288 | # only if the privacy status of the video is private. The value is specified |
| 2289 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2290 | # format. |
| 2291 | "madeForKids": True or False, |
| 2292 | "license": "A String", # The video's license. |
| 2293 | # @mutable youtube.videos.insert youtube.videos.update |
| 2294 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page |
| 2295 | # can be viewed by everyone. Note that the view count, likes, etc will still |
| 2296 | # be visible if this is disabled. |
| 2297 | # @mutable youtube.videos.insert youtube.videos.update |
| 2298 | "uploadStatus": "A String", # The status of the uploaded video. |
| 2299 | }, |
| 2300 | "statistics": { # Statistics about the video, such as the number of times the video was viewed # The <code>statistics</code> object contains statistics about the video. |
| 2301 | # or liked. |
| 2302 | "likeCount": "A String", # The number of users who have indicated that they liked the video by |
| 2303 | # giving it a positive rating. |
| 2304 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by |
| 2305 | # giving it a negative rating. |
| 2306 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite |
| 2307 | # video. |
| 2308 | "commentCount": "A String", # The number of comments for the video. |
| 2309 | "viewCount": "A String", # The number of times the video has been viewed. |
| 2310 | }, |
| 2311 | "snippet": { # Basic details about a video, including title, description, uploader, # The <code>snippet</code> object contains basic details about the video, |
| 2312 | # such as its title, description, and category. |
| 2313 | # thumbnails and category. |
| 2314 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization |
| 2315 | # exists, this field is populated with the default snippet. (Read-only) |
| 2316 | "title": "A String", # Localized version of the video's title. |
| 2317 | "description": "A String", # Localized version of the video's description. |
| 2318 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2319 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
| 2320 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2321 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2322 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 2323 | "title": "A String", # The video's title. |
| 2324 | # @mutable youtube.videos.insert youtube.videos.update |
| 2325 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. |
| 2326 | # Or it's "none" if the video is not an upcoming/active live broadcast. |
| 2327 | "description": "A String", # The video's description. |
| 2328 | # @mutable youtube.videos.insert youtube.videos.update |
| 2329 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 2330 | "defaultAudioLanguage": "A String", # The <code>default_audio_language</code> property specifies the language |
| 2331 | # spoken in the video's default audio track. |
| 2332 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the |
| 2333 | # video was uploaded to. |
| 2334 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the |
| 2335 | # map, the key is the name of the thumbnail image, and the value is an object |
| 2336 | # that contains other information about the thumbnail. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2337 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2338 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2339 | "url": "A String", # The thumbnail image's URL. |
| 2340 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2341 | }, |
| 2342 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2343 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2344 | "url": "A String", # The thumbnail image's URL. |
| 2345 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2346 | }, |
| 2347 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 2348 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2349 | "url": "A String", # The thumbnail image's URL. |
| 2350 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2351 | }, |
| 2352 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 2353 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2354 | "url": "A String", # The thumbnail image's URL. |
| 2355 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2356 | }, |
| 2357 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 2358 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2359 | "url": "A String", # The thumbnail image's URL. |
| 2360 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2361 | }, |
| 2362 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2363 | "categoryId": "A String", # The YouTube <a href="/youtube/v3/docs/videoCategories/list">video |
| 2364 | # category</a> associated with the video. |
| 2365 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified |
| 2366 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2367 | # format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2368 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2369 | "processingDetails": { # Describes processing status and progress and availability of some other Video # The <code>processingDetails</code> object encapsulates information about |
| 2370 | # YouTube's progress in processing the uploaded video file. The properties |
| 2371 | # in the object identify the current processing status and an estimate of |
| 2372 | # the time remaining until YouTube finishes processing the video. This part |
| 2373 | # also indicates whether different types of data or content, such as file |
| 2374 | # details or thumbnail images, are available for the video.<br><br> |
| 2375 | # The <code>processingProgress</code> object is designed to be polled so |
| 2376 | # that the video uploaded can track the progress that YouTube has made in |
| 2377 | # processing the uploaded video file. This data can only be retrieved by |
| 2378 | # the video owner. |
| 2379 | # resource parts. |
| 2380 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded |
| 2381 | # video. You can retrieve a video's file details by requesting the |
| 2382 | # <code>fileDetails</code> part in your <code>videos.list()</code> request. |
| 2383 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will |
| 2384 | # only have a value if the <code>processingStatus</code> |
| 2385 | # property's value is <code>failed</code>. |
| 2386 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might |
| 2387 | # improve video quality or the playback experience, are available for |
| 2388 | # the video. You can retrieve these suggestions by requesting the |
| 2389 | # <code>suggestions</code> part in your <code>videos.list()</code> request. |
| 2390 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for |
| 2391 | # the video. Tags can be added to a video's metadata to make it easier for |
| 2392 | # other users to find the video. You can retrieve these suggestions by |
| 2393 | # requesting the <code>suggestions</code> part in your |
| 2394 | # <code>videos.list()</code> request. |
| 2395 | "processingProgress": { # Video processing progress and completion time estimate. # The <code>processingProgress</code> object contains information about the |
| 2396 | # progress YouTube has made in processing the video. The values are really |
| 2397 | # only relevant if the video's processing status is <code>processing</code>. |
| 2398 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs |
| 2399 | # to finish processing the video. |
| 2400 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. |
| 2401 | # You can estimate the percentage of the video that YouTube has already |
| 2402 | # processed by calculating:<br> |
| 2403 | # <code>100 * parts_processed / parts_total</code><br><br> |
| 2404 | # Note that since the estimated number of parts could increase without |
| 2405 | # a corresponding increase in the number of parts that have already been |
| 2406 | # processed, it is possible that the calculated progress could |
| 2407 | # periodically decrease while YouTube processes a video. |
| 2408 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed |
| 2409 | # for the video. The number may be updated with more precise estimates |
| 2410 | # while YouTube processes the video. |
| 2411 | }, |
| 2412 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for |
| 2413 | # the video. |
| 2414 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated |
| 2415 | # suggestions that might improve YouTube's ability to process the |
| 2416 | # the video, warnings that explain video processing problems, or |
| 2417 | # errors that cause video processing problems. You can retrieve these |
| 2418 | # suggestions by requesting the <code>suggestions</code> part in your |
| 2419 | # <code>videos.list()</code> request. |
| 2420 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was |
| 2421 | # able to process the video or if the video is still being processed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2422 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2423 | "etag": "A String", # Etag of this resource. |
| 2424 | "player": { # Player to be used for a video playback. # The <code>player</code> object contains information that you would use to |
| 2425 | # play the video in an embedded player. |
| 2426 | "embedWidth": "A String", # The embed width |
| 2427 | "embedHeight": "A String", |
| 2428 | "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| 2429 | # play the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2430 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2431 | "liveStreamingDetails": { # Details about the live streaming metadata. # The <code>liveStreamingDetails</code> object contains metadata about a live |
| 2432 | # video broadcast. The object will only be present in a <code>video</code> |
| 2433 | # resource if the video is an upcoming, live, or completed live broadcast. |
| 2434 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This |
| 2435 | # field is filled only if the video is a currently live broadcast that has |
| 2436 | # live chat. Once the broadcast transitions to complete this field will be |
| 2437 | # removed and the live chat closed down. For persistent broadcasts that live |
| 2438 | # chat id will no longer be tied to this video but rather to the new video |
| 2439 | # being displayed at the persistent page. |
| 2440 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and |
| 2441 | # its value will be present if the broadcast has current viewers and the |
| 2442 | # broadcast owner has not hidden the viewcount for the video. Note that |
| 2443 | # YouTube stops tracking the number of concurrent viewers for a broadcast |
| 2444 | # when the broadcast ends. So, this property would not identify the number |
| 2445 | # of viewers watching an archived video of a live broadcast that already |
| 2446 | # ended. |
| 2447 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified |
| 2448 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2449 | # format. If the value is empty or |
| 2450 | # the property is not present, then the broadcast is scheduled to continue |
| 2451 | # indefinitely. |
| 2452 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified |
| 2453 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2454 | # format. This value will not be |
| 2455 | # available until the broadcast begins. |
| 2456 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified |
| 2457 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2458 | # format. This value will not be |
| 2459 | # available until the broadcast is over. |
| 2460 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified |
| 2461 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2462 | # format. |
| 2463 | }, |
| 2464 | "topicDetails": { # Freebase topic information related to the video. # The <code>topicDetails</code> object encapsulates information about <a |
| 2465 | # href="http://www.freebase.com">Freebase</a> topics associated with the |
| 2466 | # video. |
| 2467 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the |
| 2468 | # video's content. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2469 | "A String", |
| 2470 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2471 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the |
| 2472 | # video. These are topics that may be mentioned in, or appear in the video. |
| 2473 | # You can retrieve information about each topic using <a |
| 2474 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2475 | "A String", |
| 2476 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2477 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. |
| 2478 | # These are topics that are centrally featured in the video, and it can be |
| 2479 | # said that the video is mainly about each of these. You can retrieve |
| 2480 | # information about each topic using the < a |
| 2481 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2482 | "A String", |
| 2483 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2484 | }, |
| 2485 | "fileDetails": { # Describes original video file properties, including technical details about # The <code>fileDetails</code> object encapsulates information about the |
| 2486 | # video file that was uploaded to YouTube, including the file's resolution, |
| 2487 | # duration, audio and video codecs, stream bitrates, and more. This data can |
| 2488 | # only be retrieved by the video owner. |
| 2489 | # audio and video streams, but also metadata information like content length, |
| 2490 | # digitization time, or geotagging information. |
| 2491 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or |
| 2492 | # another type of file was uploaded. |
| 2493 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item |
| 2494 | # in the list contains detailed metadata about a video stream. |
| 2495 | { # Information about a video stream. |
| 2496 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
| 2497 | "heightPixels": 42, # The encoded video content's height in pixels. |
| 2498 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is |
| 2499 | # a four-letter vendor code. |
| 2500 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content |
| 2501 | # to properly display the video. |
| 2502 | "codec": "A String", # The video codec that the stream uses. |
| 2503 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 2504 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect |
| 2505 | # ratio in which the video should be displayed. |
| 2506 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the |
| 2507 | # video's encoding aspect ratio as |
| 2508 | # <code>width_pixels</code>&nbsp;/&nbsp;<code>height_pixels</code>. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2509 | }, |
| 2510 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2511 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item |
| 2512 | # in the list contains detailed metadata about an audio stream. |
| 2513 | { # Information about an audio stream. |
| 2514 | "codec": "A String", # The audio codec that the stream uses. |
| 2515 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 2516 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value |
| 2517 | # is a four-letter vendor code. |
| 2518 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 2519 | }, |
| 2520 | ], |
| 2521 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits |
| 2522 | # per second. |
| 2523 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
| 2524 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing |
| 2525 | # engine. Currently, YouTube only processes video files, but this field |
| 2526 | # is present whether a video file or another type of file was uploaded. |
| 2527 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether |
| 2528 | # a video file or another type of file was uploaded. |
| 2529 | "container": "A String", # The uploaded video file's container format. |
| 2530 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is |
| 2531 | # specified in <a href="http://www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2532 | # format. Currently, the following ISO 8601 formats are supported: |
| 2533 | # <ul> |
| 2534 | # <li>Date only: <code>YYYY-MM-DD</code></li> |
| 2535 | # <li>Naive time: <code>YYYY-MM-DDTHH:MM:SS</code></li> |
| 2536 | # <li>Time with timezone: <code>YYYY-MM-DDTHH:MM:SS+HH:MM</code></li> |
| 2537 | # </ul> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2538 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2539 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved |
| 2540 | # by the video owner. |
| 2541 | "videoGameRating": "A String", # Video game rating, if any. |
| 2542 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only |
| 2543 | # users of legal purchasing age in a particular country, as identified by |
| 2544 | # ICAP, can view the content. |
| 2545 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. |
| 2546 | # Only users aged 18+ can view the content. The the field is |
| 2547 | # <code>true</code> the content is restricted to viewers aged 18+. Otherwise |
| 2548 | # The field won't be present. |
| 2549 | }, |
| 2550 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string |
| 2551 | # <code>"youtube#video"</code>. |
| 2552 | "suggestions": { # Specifies suggestions on how to improve video content, # The <code>suggestions</code> object encapsulates suggestions that identify |
| 2553 | # opportunities to improve the video quality or the metadata for the uploaded |
| 2554 | # video. This data can only be retrieved by the video owner. |
| 2555 | # including encoding hints, tag suggestions, and editor suggestions. |
| 2556 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the |
| 2557 | # video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2558 | "A String", |
| 2559 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2560 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to |
| 2561 | # increase the likelihood that users will locate your video when searching |
| 2562 | # or browsing on YouTube. |
| 2563 | { # A single tag suggestion with it's relevance information. |
| 2564 | "tag": "A String", # The keyword tag suggested for the video. |
| 2565 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this |
| 2566 | # information to display appropriate tag suggestions based on the video |
| 2567 | # category that the video uploader associates with the video. By default, |
| 2568 | # tag suggestions are relevant for all categories if there are no restricts |
| 2569 | # defined for the keyword. |
| 2570 | "A String", |
| 2571 | ], |
| 2572 | }, |
| 2573 | ], |
| 2574 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing |
| 2575 | # the uploaded video video. These errors indicate that, regardless of the |
| 2576 | # video's current <a href="#processingProgress.processingStatus">processing |
| 2577 | # status</a>, eventually, that status will almost certainly be |
| 2578 | # <code>failed</code>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2579 | "A String", |
| 2580 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2581 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality |
| 2582 | # or playback experience of the uploaded video. |
| 2583 | "A String", |
| 2584 | ], |
| 2585 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the |
| 2586 | # uploaded video or that might result in an erroneous transcoding. |
| 2587 | # These warnings are generated before YouTube actually processes the |
| 2588 | # uploaded video file. In addition, they identify issues that are unlikely |
| 2589 | # to cause the video processing to fail but that might cause problems |
| 2590 | # such as sync issues, video artifacts, or a missing audio track. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2591 | "A String", |
| 2592 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 2593 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2594 | } |
| 2595 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2596 | onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube |
| 2597 | content partners.<br><br>The |
| 2598 | <code><strong>onBehalfOfContentOwner</strong></code> parameter indicates |
| 2599 | that the |
| 2600 | request's authorization credentials identify a YouTube CMS user who is |
| 2601 | acting on behalf of the content owner specified in the parameter value. |
| 2602 | This parameter is intended for YouTube content partners that own and manage |
| 2603 | many different YouTube channels. It allows content owners to authenticate |
| 2604 | once and get access to all their video and channel data, without having to |
| 2605 | provide authentication credentials for each individual channel. The actual |
| 2606 | CMS account that the user authenticates with must be linked to the |
| 2607 | specified YouTube content owner. |
| 2608 | x__xgafv: string, V1 error format. |
| 2609 | Allowed values |
| 2610 | 1 - v1 error format |
| 2611 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2612 | |
| 2613 | Returns: |
| 2614 | An object of the form: |
| 2615 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2616 | { # A <code><strong>video</strong></code> resource represents a YouTube video. |
| 2617 | "recordingDetails": { # Recording information associated with the video. # The <code>recordingDetails</code> object encapsulates information about the |
| 2618 | # location, date and address where the video was recorded. |
| 2619 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 2620 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in <a |
| 2621 | # href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2622 | # (<code>YYYY-MM-DDThh:mm:ss.sssZ</code>) format. |
| 2623 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 2624 | "latitude": 3.14, # Latitude in degrees. |
| 2625 | "longitude": 3.14, # Longitude in degrees. |
| 2626 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 2627 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2628 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2629 | "contentDetails": { # Details about the content of a YouTube Video. # The <code>contentDetails</code> object contains information about the video |
| 2630 | # content, including the length of the video and its aspect ratio. |
| 2631 | "dimension": "A String", # The value of <code>dimension</code> indicates whether the video is |
| 2632 | # available in 3D or in 2D. |
| 2633 | "caption": "A String", # The value of <code>captions</code> indicates whether the video |
| 2634 | # has captions or not. |
| 2635 | "duration": "A String", # The length of the video. The tag value is an <a |
| 2636 | # href="//en.wikipedia.org/wiki/ISO_8601#Durations">ISO 8601</a> duration in |
| 2637 | # the format <code>PT#M#S</code>, in which the letters <code>PT</code> |
| 2638 | # indicate that the value specifies a period of time, and the letters |
| 2639 | # <code>M</code> and <code>S</code> refer to length in minutes and seconds, |
| 2640 | # respectively. The <code>#</code> characters preceding the <code>M</code> |
| 2641 | # and <code>S</code> letters are both integers that specify the number of |
| 2642 | # minutes (or seconds) of the video. For example, a value of |
| 2643 | # <code>PT15M51S</code> indicates that the video is 15 minutes and 51 seconds |
| 2644 | # long. |
| 2645 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom |
| 2646 | # thumbnail image for the video. |
| 2647 | # This property is only visible to the video uploader. |
| 2648 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The <code>regionRestriction</code> object contains information about the |
| 2649 | # countries where a video is (or is not) viewable. The object will contain |
| 2650 | # either the <code>contentDetails.regionRestriction.allowed</code> property |
| 2651 | # or the <code>contentDetails.regionRestriction.blocked</code> property. |
| 2652 | "allowed": [ # A list of region codes that identify countries where the video is |
| 2653 | # viewable. If this property is present and a country is not listed |
| 2654 | # in its value, then the video is blocked from appearing in that |
| 2655 | # country. If this property is present and contains an empty list, |
| 2656 | # the video is blocked in all countries. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2657 | "A String", |
| 2658 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2659 | "blocked": [ # A list of region codes that identify countries where the video is |
| 2660 | # blocked. If this property is present and a country is not listed in |
| 2661 | # its value, then the video is viewable in that country. If this |
| 2662 | # property is present and contains an empty list, the video is |
| 2663 | # viewable in all countries. |
| 2664 | "A String", |
| 2665 | ], |
| 2666 | }, |
| 2667 | "licensedContent": True or False, # The value of <code>is_license_content</code> indicates whether the video is |
| 2668 | # licensed content. |
| 2669 | "countryRestriction": { # Rights management policy for YouTube resources. # The <code>countryRestriction</code> object contains information about the |
| 2670 | # countries where a video is (or is not) viewable. |
| 2671 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 2672 | # not apply. |
| 2673 | "A String", |
| 2674 | ], |
| 2675 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 2676 | # policy is allowed or denied by default. |
| 2677 | }, |
| 2678 | "definition": "A String", # The value of <code>definition</code> indicates whether the video is |
| 2679 | # available in high definition or only in standard definition. |
| 2680 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for # Specifies the ratings that the video received under various rating schemes. |
| 2681 | # movies and shows. |
| 2682 | # LINT.IfChange |
| 2683 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance |
| 2684 | # de la classification des films (CSCF). |
| 2685 | "icaaRating": "A String", # The video's Instituto de la Cinematograf&iacute;a y de las Artes |
| 2686 | # Audiovisuales (ICAA - Spain) rating. |
| 2687 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 2688 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 2689 | "oflcRating": "A String", # The video's Office of Film and Literature Classification |
| 2690 | # (OFLC - New Zealand) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2691 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2692 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2693 | "djctqRating": "A String", # The video's Departamento de Justi&ccedil;a, Classifica&ccedil;&atilde;o, |
| 2694 | # Qualifica&ccedil;&atilde;o e T&iacute;tulos (DJCQT - Brazil) rating. |
| 2695 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See |
| 2696 | # http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 2697 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 2698 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 2699 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian |
| 2700 | # Communications and Media Authority (ACMA) rating. ACMA ratings are used |
| 2701 | # to classify children's television programming. |
| 2702 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 2703 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attivit&agrave; |
| 2704 | # Culturali e del Turismo (Italy). |
| 2705 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and |
| 2706 | # Telecommunications Commission (CRTC) for Canadian French-language |
| 2707 | # broadcasts. For more information, see the |
| 2708 | # <a href="http://www.cbsc.ca/english/agvot/frenchsystem.php">Canadian |
| 2709 | # Broadcast Standards Council</a> website. |
| 2710 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture |
| 2711 | # (&#25991;&#21270;&#37096;). |
| 2712 | "nkclvRating": "A String", # The video's rating from the Nacion&atilde;lais Kino centrs (National Film |
| 2713 | # Centre of Latvia). |
| 2714 | "csaRating": "A String", # The video's rating from France's Conseil sup&eacute;rieur de |
| 2715 | # l’audiovisuel, which rates broadcast content. |
| 2716 | "rteRating": "A String", # The video's rating from Ireland's Raidi&oacute; Teilif&iacute;s |
| 2717 | # &Eacute;ireann. |
| 2718 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. |
| 2719 | # See the <a |
| 2720 | # href="http://www.ifco.ie/website/ifco/ifcoweb.nsf/web/classcatintro">IFCO</a> |
| 2721 | # website for more information. |
| 2722 | "cceRating": "A String", # The video's rating from Portugal's Comiss&atilde;o de |
| 2723 | # Classifica&ccedil;&atilde;o de Espect&acute;culos. |
| 2724 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the |
| 2725 | # Ministry of Culture and Tourism |
| 2726 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 2727 | "eirinRating": "A String", # The video's Eirin (&#26144;&#20523;) rating. |
| 2728 | # Eirin is the Japanese rating system. |
| 2729 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 2730 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification |
| 2731 | # (Bundesministerium f&uuml;r Unterricht, Kunst und Kultur). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2732 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 2733 | "A String", |
| 2734 | ], |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2735 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2736 | "smaisRating": "A String", # The video's rating in Iceland. |
| 2737 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti |
| 2738 | # (National Audiovisual Institute). |
| 2739 | "smsaRating": "A String", # The video's rating from Statens medier&aring;d (Sweden's National Media |
| 2740 | # Council). |
| 2741 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 2742 | "nbcplRating": "A String", # The video's rating in Poland. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2743 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2744 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 2745 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut |
| 2746 | # voor de Classificatie van Audiovisuele Media (Netherlands). |
| 2747 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating |
| 2748 | # Committee of the National Office of Film. |
| 2749 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 2750 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 2751 | "cicfRating": "A String", # The video's rating from the Commission de Contr&ocirc;le des Films |
| 2752 | # (Belgium). |
| 2753 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper |
| 2754 | # and Article Administration. |
| 2755 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System |
| 2756 | # The video's rating from the Canadian Radio-Television and |
| 2757 | # Telecommunications Commission (CRTC) for Canadian English-language |
| 2758 | # broadcasts. For more information, see the |
| 2759 | # <a href="http://www.cbsc.ca/english/agvot/englishsystem.php">Canadian |
| 2760 | # Broadcast Standards Council</a> website. |
| 2761 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 2762 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation |
| 2763 | # (MKRF - Russia) rating. |
| 2764 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 2765 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 2766 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 2767 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2768 | "A String", |
| 2769 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2770 | "agcomRating": "A String", # The video's rating from Italy's Autorit&agrave; per le Garanzie nelle |
| 2771 | # Comunicazioni (AGCOM). |
| 2772 | "pefilmRating": "A String", # The video's rating in Peru. |
| 2773 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 2774 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske |
| 2775 | # Filminstitut) Media Council for Children and Young People. |
| 2776 | "grfilmRating": "A String", # The video's rating in Greece. |
| 2777 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 2778 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to |
| 2779 | # prevent titles go live w/o additional QC check, since some of them can be |
| 2780 | # inappropriate for the countries at all. See b/33408548 for more details. |
| 2781 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 2782 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, |
| 2783 | # specifically, it's Board of Film Censors (BFC). |
| 2784 | "kmrbRating": "A String", # The video's Korea Media Rating Board |
| 2785 | # (&#50689;&#49345;&#47932;&#46321;&#44553;&#50948;&#50896;&#54924;) rating. |
| 2786 | # The KMRB rates videos in South Korea. |
| 2787 | "nfrcRating": "A String", # The video's rating from the <a href="http://www.nfc.bg/">Bulgarian |
| 2788 | # National Film Center</a>. |
| 2789 | "fmocRating": "A String", # <span class="deprecated">This property has been deprecated. Use the |
| 2790 | # <code><a |
| 2791 | # href="#contentDetails.contentRating.cncRating">contentDetails.contentRating.cncRating</a></code> |
| 2792 | # instead.</span> |
| 2793 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 2794 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI |
| 2795 | # (CNA). |
| 2796 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft |
| 2797 | # (FSK - Germany) rating. |
| 2798 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 2799 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - |
| 2800 | # Argentina) rating. |
| 2801 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 2802 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography |
| 2803 | # (Mexico) rating. |
| 2804 | "anatelRating": "A String", # The video's Anatel (Asociaci&oacute;n Nacional de Televisi&oacute;n) |
| 2805 | # rating for Chilean television. |
| 2806 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and |
| 2807 | # Classification Board (Philippines). |
| 2808 | "cccRating": "A String", # The video's Consejo de Calificaci&oacute;n Cinematogr&aacute;fica (Chile) |
| 2809 | # rating. |
| 2810 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2811 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2812 | "projection": "A String", # Specifies the projection format of the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2813 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2814 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The <code>projectDetails</code> object contains information about the |
| 2815 | # project specific video metadata. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2816 | "tags": [ # A list of project tags associated with the video during the upload. |
| 2817 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2818 | ], |
| 2819 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2820 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
| 2821 | "localizations": { # The <code>localizations</code> object contains localized versions of the |
| 2822 | # basic details about the video, such as its title and description. |
| 2823 | "a_key": { # Localized versions of certain video properties (e.g. title). |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2824 | "title": "A String", # Localized version of the video's title. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2825 | "description": "A String", # Localized version of the video's description. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2826 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2827 | }, |
| 2828 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The <code>monetizationDetails</code> object encapsulates information |
| 2829 | # about the monetization status of the video. |
| 2830 | "access": { # Rights management policy for YouTube resources. # The value of <code>access</code> indicates whether the video can be |
| 2831 | # monetized or not. |
| 2832 | "exception": [ # A list of region codes that identify countries where the default policy do |
| 2833 | # not apply. |
| 2834 | "A String", |
| 2835 | ], |
| 2836 | "allowed": True or False, # The value of <code>allowed</code> indicates whether the access to the |
| 2837 | # policy is allowed or denied by default. |
| 2838 | }, |
| 2839 | }, |
| 2840 | "status": { # Basic details about a video category, such as its localized title. # The <code>status</code> object contains information about the video's |
| 2841 | # uploading, processing, and privacy statuses. |
| 2842 | # Next Id: 17 |
| 2843 | "failureReason": "A String", # This value explains why a video failed to upload. This property is |
| 2844 | # only present if the <code>uploadStatus</code> property indicates that |
| 2845 | # the upload failed. |
| 2846 | "privacyStatus": "A String", # The video's privacy status. |
| 2847 | "selfDeclaredMadeForKids": True or False, |
| 2848 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This |
| 2849 | # property is only present if the <code>uploadStatus</code> property |
| 2850 | # indicates that the upload was rejected. |
| 2851 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. |
| 2852 | # @mutable youtube.videos.insert youtube.videos.update |
| 2853 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set |
| 2854 | # only if the privacy status of the video is private. The value is specified |
| 2855 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2856 | # format. |
| 2857 | "madeForKids": True or False, |
| 2858 | "license": "A String", # The video's license. |
| 2859 | # @mutable youtube.videos.insert youtube.videos.update |
| 2860 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page |
| 2861 | # can be viewed by everyone. Note that the view count, likes, etc will still |
| 2862 | # be visible if this is disabled. |
| 2863 | # @mutable youtube.videos.insert youtube.videos.update |
| 2864 | "uploadStatus": "A String", # The status of the uploaded video. |
| 2865 | }, |
| 2866 | "statistics": { # Statistics about the video, such as the number of times the video was viewed # The <code>statistics</code> object contains statistics about the video. |
| 2867 | # or liked. |
| 2868 | "likeCount": "A String", # The number of users who have indicated that they liked the video by |
| 2869 | # giving it a positive rating. |
| 2870 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by |
| 2871 | # giving it a negative rating. |
| 2872 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite |
| 2873 | # video. |
| 2874 | "commentCount": "A String", # The number of comments for the video. |
| 2875 | "viewCount": "A String", # The number of times the video has been viewed. |
| 2876 | }, |
| 2877 | "snippet": { # Basic details about a video, including title, description, uploader, # The <code>snippet</code> object contains basic details about the video, |
| 2878 | # such as its title, description, and category. |
| 2879 | # thumbnails and category. |
| 2880 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization |
| 2881 | # exists, this field is populated with the default snippet. (Read-only) |
| 2882 | "title": "A String", # Localized version of the video's title. |
| 2883 | "description": "A String", # Localized version of the video's description. |
| 2884 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2885 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
| 2886 | "A String", |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 2887 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2888 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 2889 | "title": "A String", # The video's title. |
| 2890 | # @mutable youtube.videos.insert youtube.videos.update |
| 2891 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. |
| 2892 | # Or it's "none" if the video is not an upcoming/active live broadcast. |
| 2893 | "description": "A String", # The video's description. |
| 2894 | # @mutable youtube.videos.insert youtube.videos.update |
| 2895 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 2896 | "defaultAudioLanguage": "A String", # The <code>default_audio_language</code> property specifies the language |
| 2897 | # spoken in the video's default audio track. |
| 2898 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the |
| 2899 | # video was uploaded to. |
| 2900 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the |
| 2901 | # map, the key is the name of the thumbnail image, and the value is an object |
| 2902 | # that contains other information about the thumbnail. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2903 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2904 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2905 | "url": "A String", # The thumbnail image's URL. |
| 2906 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2907 | }, |
| 2908 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2909 | "width": 42, # (Optional) Width of the thumbnail image. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2910 | "url": "A String", # The thumbnail image's URL. |
| 2911 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2912 | }, |
| 2913 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 2914 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2915 | "url": "A String", # The thumbnail image's URL. |
| 2916 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2917 | }, |
| 2918 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 2919 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2920 | "url": "A String", # The thumbnail image's URL. |
| 2921 | "height": 42, # (Optional) Height of the thumbnail image. |
| 2922 | }, |
| 2923 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 2924 | "width": 42, # (Optional) Width of the thumbnail image. |
| 2925 | "url": "A String", # The thumbnail image's URL. |
| 2926 | "height": 42, # (Optional) Height of the thumbnail image. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2927 | }, |
| 2928 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2929 | "categoryId": "A String", # The YouTube <a href="/youtube/v3/docs/videoCategories/list">video |
| 2930 | # category</a> associated with the video. |
| 2931 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified |
| 2932 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 2933 | # format. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2934 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2935 | "processingDetails": { # Describes processing status and progress and availability of some other Video # The <code>processingDetails</code> object encapsulates information about |
| 2936 | # YouTube's progress in processing the uploaded video file. The properties |
| 2937 | # in the object identify the current processing status and an estimate of |
| 2938 | # the time remaining until YouTube finishes processing the video. This part |
| 2939 | # also indicates whether different types of data or content, such as file |
| 2940 | # details or thumbnail images, are available for the video.<br><br> |
| 2941 | # The <code>processingProgress</code> object is designed to be polled so |
| 2942 | # that the video uploaded can track the progress that YouTube has made in |
| 2943 | # processing the uploaded video file. This data can only be retrieved by |
| 2944 | # the video owner. |
| 2945 | # resource parts. |
| 2946 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded |
| 2947 | # video. You can retrieve a video's file details by requesting the |
| 2948 | # <code>fileDetails</code> part in your <code>videos.list()</code> request. |
| 2949 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will |
| 2950 | # only have a value if the <code>processingStatus</code> |
| 2951 | # property's value is <code>failed</code>. |
| 2952 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might |
| 2953 | # improve video quality or the playback experience, are available for |
| 2954 | # the video. You can retrieve these suggestions by requesting the |
| 2955 | # <code>suggestions</code> part in your <code>videos.list()</code> request. |
| 2956 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for |
| 2957 | # the video. Tags can be added to a video's metadata to make it easier for |
| 2958 | # other users to find the video. You can retrieve these suggestions by |
| 2959 | # requesting the <code>suggestions</code> part in your |
| 2960 | # <code>videos.list()</code> request. |
| 2961 | "processingProgress": { # Video processing progress and completion time estimate. # The <code>processingProgress</code> object contains information about the |
| 2962 | # progress YouTube has made in processing the video. The values are really |
| 2963 | # only relevant if the video's processing status is <code>processing</code>. |
| 2964 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs |
| 2965 | # to finish processing the video. |
| 2966 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. |
| 2967 | # You can estimate the percentage of the video that YouTube has already |
| 2968 | # processed by calculating:<br> |
| 2969 | # <code>100 * parts_processed / parts_total</code><br><br> |
| 2970 | # Note that since the estimated number of parts could increase without |
| 2971 | # a corresponding increase in the number of parts that have already been |
| 2972 | # processed, it is possible that the calculated progress could |
| 2973 | # periodically decrease while YouTube processes a video. |
| 2974 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed |
| 2975 | # for the video. The number may be updated with more precise estimates |
| 2976 | # while YouTube processes the video. |
| 2977 | }, |
| 2978 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for |
| 2979 | # the video. |
| 2980 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated |
| 2981 | # suggestions that might improve YouTube's ability to process the |
| 2982 | # the video, warnings that explain video processing problems, or |
| 2983 | # errors that cause video processing problems. You can retrieve these |
| 2984 | # suggestions by requesting the <code>suggestions</code> part in your |
| 2985 | # <code>videos.list()</code> request. |
| 2986 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was |
| 2987 | # able to process the video or if the video is still being processed. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2988 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2989 | "etag": "A String", # Etag of this resource. |
| 2990 | "player": { # Player to be used for a video playback. # The <code>player</code> object contains information that you would use to |
| 2991 | # play the video in an embedded player. |
| 2992 | "embedWidth": "A String", # The embed width |
| 2993 | "embedHeight": "A String", |
| 2994 | "embedHtml": "A String", # An <code>&lt;iframe&gt;</code> tag that embeds a player that will |
| 2995 | # play the video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 2996 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 2997 | "liveStreamingDetails": { # Details about the live streaming metadata. # The <code>liveStreamingDetails</code> object contains metadata about a live |
| 2998 | # video broadcast. The object will only be present in a <code>video</code> |
| 2999 | # resource if the video is an upcoming, live, or completed live broadcast. |
| 3000 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This |
| 3001 | # field is filled only if the video is a currently live broadcast that has |
| 3002 | # live chat. Once the broadcast transitions to complete this field will be |
| 3003 | # removed and the live chat closed down. For persistent broadcasts that live |
| 3004 | # chat id will no longer be tied to this video but rather to the new video |
| 3005 | # being displayed at the persistent page. |
| 3006 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and |
| 3007 | # its value will be present if the broadcast has current viewers and the |
| 3008 | # broadcast owner has not hidden the viewcount for the video. Note that |
| 3009 | # YouTube stops tracking the number of concurrent viewers for a broadcast |
| 3010 | # when the broadcast ends. So, this property would not identify the number |
| 3011 | # of viewers watching an archived video of a live broadcast that already |
| 3012 | # ended. |
| 3013 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified |
| 3014 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 3015 | # format. If the value is empty or |
| 3016 | # the property is not present, then the broadcast is scheduled to continue |
| 3017 | # indefinitely. |
| 3018 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified |
| 3019 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 3020 | # format. This value will not be |
| 3021 | # available until the broadcast begins. |
| 3022 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified |
| 3023 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 3024 | # format. This value will not be |
| 3025 | # available until the broadcast is over. |
| 3026 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified |
| 3027 | # in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 3028 | # format. |
| 3029 | }, |
| 3030 | "topicDetails": { # Freebase topic information related to the video. # The <code>topicDetails</code> object encapsulates information about <a |
| 3031 | # href="http://www.freebase.com">Freebase</a> topics associated with the |
| 3032 | # video. |
| 3033 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the |
| 3034 | # video's content. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3035 | "A String", |
| 3036 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3037 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the |
| 3038 | # video. These are topics that may be mentioned in, or appear in the video. |
| 3039 | # You can retrieve information about each topic using <a |
| 3040 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3041 | "A String", |
| 3042 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3043 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. |
| 3044 | # These are topics that are centrally featured in the video, and it can be |
| 3045 | # said that the video is mainly about each of these. You can retrieve |
| 3046 | # information about each topic using the < a |
| 3047 | # href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API</a>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3048 | "A String", |
| 3049 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3050 | }, |
| 3051 | "fileDetails": { # Describes original video file properties, including technical details about # The <code>fileDetails</code> object encapsulates information about the |
| 3052 | # video file that was uploaded to YouTube, including the file's resolution, |
| 3053 | # duration, audio and video codecs, stream bitrates, and more. This data can |
| 3054 | # only be retrieved by the video owner. |
| 3055 | # audio and video streams, but also metadata information like content length, |
| 3056 | # digitization time, or geotagging information. |
| 3057 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or |
| 3058 | # another type of file was uploaded. |
| 3059 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item |
| 3060 | # in the list contains detailed metadata about a video stream. |
| 3061 | { # Information about a video stream. |
| 3062 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
| 3063 | "heightPixels": 42, # The encoded video content's height in pixels. |
| 3064 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is |
| 3065 | # a four-letter vendor code. |
| 3066 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content |
| 3067 | # to properly display the video. |
| 3068 | "codec": "A String", # The video codec that the stream uses. |
| 3069 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 3070 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect |
| 3071 | # ratio in which the video should be displayed. |
| 3072 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the |
| 3073 | # video's encoding aspect ratio as |
| 3074 | # <code>width_pixels</code>&nbsp;/&nbsp;<code>height_pixels</code>. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3075 | }, |
| 3076 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3077 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item |
| 3078 | # in the list contains detailed metadata about an audio stream. |
| 3079 | { # Information about an audio stream. |
| 3080 | "codec": "A String", # The audio codec that the stream uses. |
| 3081 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 3082 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value |
| 3083 | # is a four-letter vendor code. |
| 3084 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 3085 | }, |
| 3086 | ], |
| 3087 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits |
| 3088 | # per second. |
| 3089 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
| 3090 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing |
| 3091 | # engine. Currently, YouTube only processes video files, but this field |
| 3092 | # is present whether a video file or another type of file was uploaded. |
| 3093 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether |
| 3094 | # a video file or another type of file was uploaded. |
| 3095 | "container": "A String", # The uploaded video file's container format. |
| 3096 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is |
| 3097 | # specified in <a href="http://www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| 3098 | # format. Currently, the following ISO 8601 formats are supported: |
| 3099 | # <ul> |
| 3100 | # <li>Date only: <code>YYYY-MM-DD</code></li> |
| 3101 | # <li>Naive time: <code>YYYY-MM-DDTHH:MM:SS</code></li> |
| 3102 | # <li>Time with timezone: <code>YYYY-MM-DDTHH:MM:SS+HH:MM</code></li> |
| 3103 | # </ul> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3104 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3105 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved |
| 3106 | # by the video owner. |
| 3107 | "videoGameRating": "A String", # Video game rating, if any. |
| 3108 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only |
| 3109 | # users of legal purchasing age in a particular country, as identified by |
| 3110 | # ICAP, can view the content. |
| 3111 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. |
| 3112 | # Only users aged 18+ can view the content. The the field is |
| 3113 | # <code>true</code> the content is restricted to viewers aged 18+. Otherwise |
| 3114 | # The field won't be present. |
| 3115 | }, |
| 3116 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string |
| 3117 | # <code>"youtube#video"</code>. |
| 3118 | "suggestions": { # Specifies suggestions on how to improve video content, # The <code>suggestions</code> object encapsulates suggestions that identify |
| 3119 | # opportunities to improve the video quality or the metadata for the uploaded |
| 3120 | # video. This data can only be retrieved by the video owner. |
| 3121 | # including encoding hints, tag suggestions, and editor suggestions. |
| 3122 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the |
| 3123 | # video. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3124 | "A String", |
| 3125 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3126 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to |
| 3127 | # increase the likelihood that users will locate your video when searching |
| 3128 | # or browsing on YouTube. |
| 3129 | { # A single tag suggestion with it's relevance information. |
| 3130 | "tag": "A String", # The keyword tag suggested for the video. |
| 3131 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this |
| 3132 | # information to display appropriate tag suggestions based on the video |
| 3133 | # category that the video uploader associates with the video. By default, |
| 3134 | # tag suggestions are relevant for all categories if there are no restricts |
| 3135 | # defined for the keyword. |
| 3136 | "A String", |
| 3137 | ], |
| 3138 | }, |
| 3139 | ], |
| 3140 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing |
| 3141 | # the uploaded video video. These errors indicate that, regardless of the |
| 3142 | # video's current <a href="#processingProgress.processingStatus">processing |
| 3143 | # status</a>, eventually, that status will almost certainly be |
| 3144 | # <code>failed</code>. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3145 | "A String", |
| 3146 | ], |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 3147 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality |
| 3148 | # or playback experience of the uploaded video. |
| 3149 | "A String", |
| 3150 | ], |
| 3151 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the |
| 3152 | # uploaded video or that might result in an erroneous transcoding. |
| 3153 | # These warnings are generated before YouTube actually processes the |
| 3154 | # uploaded video file. In addition, they identify issues that are unlikely |
| 3155 | # to cause the video processing to fail but that might cause problems |
| 3156 | # such as sync issues, video artifacts, or a missing audio track. |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 3157 | "A String", |
| 3158 | ], |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 3159 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 3160 | }</pre> |
| 3161 | </div> |
| 3162 | |
| 3163 | </body></html> |