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"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a resource.</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="#getRating">getRating(id, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <p class="firstline">Retrieves the ratings that the authorized user gave to a list of specified videos.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 87 | <code><a href="#insert">insert(part, body=None, stabilize=None, autoLevels=None, notifySubscribers=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 88 | <p class="firstline">Inserts a new resource into this collection.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <p class="toc_element"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 90 | <code><a href="#list">list(part, onBehalfOfContentOwner=None, maxHeight=None, chart=None, regionCode=None, maxResults=None, myRating=None, videoCategoryId=None, locale=None, id=None, hl=None, pageToken=None, maxWidth=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 91 | <p class="firstline">Retrieves a list of resources, possibly filtered.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 96 | <code><a href="#rate">rate(id, rating, x__xgafv=None)</a></code></p> |
| 97 | <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] | 98 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 99 | <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] | 100 | <p class="firstline">Report abuse for a video.</p> |
| 101 | <p class="toc_element"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 102 | <code><a href="#update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</a></code></p> |
| 103 | <p class="firstline">Updates an existing resource.</p> |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <code class="details" id="close">close()</code> |
| 107 | <pre>Close httplib2 connections.</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 111 | <code class="details" id="delete">delete(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 112 | <pre>Deletes a resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 113 | |
| 114 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 115 | id: string, A parameter (required) |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 116 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 117 | x__xgafv: string, V1 error format. |
| 118 | Allowed values |
| 119 | 1 - v1 error format |
| 120 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 121 | </pre> |
| 122 | </div> |
| 123 | |
| 124 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 125 | <code class="details" id="getRating">getRating(id, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 126 | <pre>Retrieves the ratings that the authorized user gave to a list of specified videos. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 127 | |
| 128 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 129 | id: string, A parameter (required) (repeated) |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 130 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | x__xgafv: string, V1 error format. |
| 132 | Allowed values |
| 133 | 1 - v1 error format |
| 134 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 135 | |
| 136 | Returns: |
| 137 | An object of the form: |
| 138 | |
| 139 | { |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 140 | "visitorId": "A String", # The visitorId identifies the visitor. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 141 | "etag": "A String", # Etag of this resource. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 142 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 143 | "kind": "youtube#videoGetRatingResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoGetRatingResponse". |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "items": [ # A list of ratings that match the request criteria. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 145 | { # Basic details about rating of a video. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 146 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 147 | "rating": "A String", # Rating of a video. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 148 | }, |
| 149 | ], |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 150 | }</pre> |
| 151 | </div> |
| 152 | |
| 153 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 154 | <code class="details" id="insert">insert(part, body=None, stabilize=None, autoLevels=None, notifySubscribers=None, onBehalfOfContentOwnerChannel=None, onBehalfOfContentOwner=None, x__xgafv=None, media_body=None, media_mime_type=None)</code> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 155 | <pre>Inserts a new resource into this collection. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 156 | |
| 157 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 158 | part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required) (repeated) |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 159 | body: object, The request body. |
| 160 | The object takes the form of: |
| 161 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 162 | { # A *video* resource represents a YouTube video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 163 | "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 164 | "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 165 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 166 | "viewCount": "A String", # The number of times the video has been viewed. |
| 167 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating. |
| 168 | "commentCount": "A String", # The number of comments for the video. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 169 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 170 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. |
| 171 | "videoGameRating": "A String", # Video game rating, if any. |
| 172 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. |
| 173 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. |
| 174 | }, |
| 175 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 176 | "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 177 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. |
| 178 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. |
| 179 | "anatelRating": "A String", # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. |
| 180 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 181 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 182 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 183 | "djctqRating": "A String", # The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. |
| 184 | "kmrbRating": "A String", # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. |
| 185 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 186 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. |
| 187 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 188 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
| 189 | "A String", |
| 190 | ], |
| 191 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
| 192 | "smsaRating": "A String", # The video's rating from Statens medieråd (Sweden's National Media Council). |
| 193 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 194 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. |
| 195 | "smaisRating": "A String", # The video's rating in Iceland. |
| 196 | "agcomRating": "A String", # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). |
| 197 | "rteRating": "A String", # The video's rating from Ireland's Raidió Teilifís Éireann. |
| 198 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details. |
| 199 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 200 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). |
| 201 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
| 202 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. |
| 203 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 204 | "oflcRating": "A String", # The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. |
| 205 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 206 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
| 207 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). |
| 208 | "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. |
| 209 | "csaRating": "A String", # The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content. |
| 210 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 211 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 212 | "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. |
| 213 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
| 214 | "nbcplRating": "A String", # The video's rating in Poland. |
| 215 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
| 216 | "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. |
| 217 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. |
| 218 | "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. |
| 219 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. |
| 220 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 221 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 222 | "A String", |
| 223 | ], |
| 224 | "cicfRating": "A String", # The video's rating from the Commission de Contrôle des Films (Belgium). |
| 225 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). |
| 226 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. |
| 227 | "icaaRating": "A String", # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. |
| 228 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands). |
| 229 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. |
| 230 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 231 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 232 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 233 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 234 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 235 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 236 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture (文化部). |
| 237 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 238 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). |
| 239 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 240 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
| 241 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). |
| 242 | "pefilmRating": "A String", # The video's rating in Peru. |
| 243 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 244 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 245 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 246 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. |
| 247 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and Classification Board (Philippines). |
| 248 | "nkclvRating": "A String", # The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). |
| 249 | "nfrcRating": "A String", # The video's rating from the Bulgarian National Film Center. |
| 250 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). |
| 251 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 252 | "grfilmRating": "A String", # The video's rating in Greece. |
| 253 | }, |
| 254 | "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable. |
| 255 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 256 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 257 | "A String", |
| 258 | ], |
| 259 | }, |
| 260 | "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 261 | "caption": "A String", # The value of captions indicates whether the video has captions or not. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 262 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. |
| 263 | "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. |
| 264 | "A String", |
| 265 | ], |
| 266 | "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. |
| 267 | "A String", |
| 268 | ], |
| 269 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 270 | "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 271 | "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 272 | "projection": "A String", # Specifies the projection format of the video. |
| 273 | "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. |
| 274 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 275 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 276 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video". |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 277 | "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 278 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second. |
| 279 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 280 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 281 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
| 282 | { # Information about an audio stream. |
| 283 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 284 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 285 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
| 286 | "codec": "A String", # The audio codec that the stream uses. |
| 287 | }, |
| 288 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 289 | "container": "A String", # The uploaded video file's container format. |
| 290 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
| 291 | { # Information about a video stream. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 292 | "codec": "A String", # The video codec that the stream uses. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 293 | "heightPixels": 42, # The encoded video content's height in pixels. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 294 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 295 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 296 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video. |
| 297 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
| 298 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 299 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 300 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 301 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 302 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
| 303 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. |
| 304 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 305 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 306 | "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video. |
| 307 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API. |
| 308 | "A String", |
| 309 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 310 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the video's content. |
| 311 | "A String", |
| 312 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 313 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. |
| 314 | "A String", |
| 315 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 316 | }, |
| 317 | "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 318 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 319 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 320 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 321 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 322 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 323 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 324 | }, |
| 325 | "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 326 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| 327 | "A String", |
| 328 | ], |
| 329 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. |
| 330 | "A String", |
| 331 | ], |
| 332 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. |
| 333 | "A String", |
| 334 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 335 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. |
| 336 | { # A single tag suggestion with it's relevance information. |
| 337 | "tag": "A String", # The keyword tag suggested for the video. |
| 338 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. |
| 339 | "A String", |
| 340 | ], |
| 341 | }, |
| 342 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 343 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video. |
| 344 | "A String", |
| 345 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 346 | }, |
| 347 | "etag": "A String", # Etag of this resource. |
| 348 | "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
| 349 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 350 | "latitude": 3.14, # Latitude in degrees. |
| 351 | "longitude": 3.14, # Longitude in degrees. |
| 352 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 353 | }, |
| 354 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
| 355 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 356 | }, |
| 357 | "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. |
| 358 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| 359 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 360 | "url": "A String", # The thumbnail image's URL. |
| 361 | "width": 42, # (Optional) Width of the thumbnail image. |
| 362 | "height": 42, # (Optional) Height of the thumbnail image. |
| 363 | }, |
| 364 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 365 | "url": "A String", # The thumbnail image's URL. |
| 366 | "width": 42, # (Optional) Width of the thumbnail image. |
| 367 | "height": 42, # (Optional) Height of the thumbnail image. |
| 368 | }, |
| 369 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 370 | "url": "A String", # The thumbnail image's URL. |
| 371 | "width": 42, # (Optional) Width of the thumbnail image. |
| 372 | "height": 42, # (Optional) Height of the thumbnail image. |
| 373 | }, |
| 374 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 375 | "url": "A String", # The thumbnail image's URL. |
| 376 | "width": 42, # (Optional) Width of the thumbnail image. |
| 377 | "height": 42, # (Optional) Height of the thumbnail image. |
| 378 | }, |
| 379 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 380 | "url": "A String", # The thumbnail image's URL. |
| 381 | "width": 42, # (Optional) Width of the thumbnail image. |
| 382 | "height": 42, # (Optional) Height of the thumbnail image. |
| 383 | }, |
| 384 | }, |
| 385 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) |
| 386 | "title": "A String", # Localized version of the video's title. |
| 387 | "description": "A String", # Localized version of the video's description. |
| 388 | }, |
| 389 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. |
| 390 | "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track. |
| 391 | "categoryId": "A String", # The YouTube video category associated with the video. |
| 392 | "description": "A String", # The video's description. @mutable youtube.videos.insert youtube.videos.update |
| 393 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 394 | "A String", |
| 395 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 396 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| 397 | "title": "A String", # The video's title. @mutable youtube.videos.insert youtube.videos.update |
| 398 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 399 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 format. |
| 400 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 401 | }, |
| 402 | "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player. |
| 403 | "embedHeight": "A String", |
| 404 | "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video. |
| 405 | "embedWidth": "A String", # The embed width |
| 406 | }, |
| 407 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video. |
| 408 | "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not. |
| 409 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 410 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 411 | "A String", |
| 412 | ], |
| 413 | }, |
| 414 | }, |
| 415 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata. |
| 416 | "tags": [ # A list of project tags associated with the video during the upload. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 417 | "A String", |
| 418 | ], |
| 419 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 420 | "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. |
| 421 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. |
| 422 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video. |
| 423 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. |
| 424 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 425 | "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. |
| 426 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. |
| 427 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. |
| 428 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
| 429 | }, |
| 430 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 431 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 432 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. |
| 433 | }, |
| 434 | "localizations": { # The localizations object contains localized versions of the basic details about the video, such as its title and description. |
| 435 | "a_key": { # Localized versions of certain video properties (e.g. title). |
| 436 | "title": "A String", # Localized version of the video's title. |
| 437 | "description": "A String", # Localized version of the video's description. |
| 438 | }, |
| 439 | }, |
| 440 | "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. |
| 441 | "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update |
| 442 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. |
| 443 | "selfDeclaredMadeForKids": True or False, |
| 444 | "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. |
| 445 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update |
| 446 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update |
| 447 | "madeForKids": True or False, |
| 448 | "privacyStatus": "A String", # The video's privacy status. |
| 449 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format. |
| 450 | "uploadStatus": "A String", # The status of the uploaded video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 451 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 452 | } |
| 453 | |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 454 | stabilize: boolean, Should stabilize be applied to the upload. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 455 | autoLevels: boolean, Should auto-levels be applied to the upload. |
| 456 | notifySubscribers: boolean, Notify the channel subscribers about the new video. As default, the notification is enabled. |
| 457 | onBehalfOfContentOwnerChannel: string, This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel. |
| 458 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 459 | x__xgafv: string, V1 error format. |
| 460 | Allowed values |
| 461 | 1 - v1 error format |
| 462 | 2 - v2 error format |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 463 | media_body: string, The filename of the media request body, or an instance of a MediaUpload object. |
| 464 | 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] | 465 | |
| 466 | Returns: |
| 467 | An object of the form: |
| 468 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 469 | { # A *video* resource represents a YouTube video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 470 | "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 471 | "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 472 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 473 | "viewCount": "A String", # The number of times the video has been viewed. |
| 474 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating. |
| 475 | "commentCount": "A String", # The number of comments for the video. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 476 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 477 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. |
| 478 | "videoGameRating": "A String", # Video game rating, if any. |
| 479 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. |
| 480 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. |
| 481 | }, |
| 482 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 483 | "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 484 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. |
| 485 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. |
| 486 | "anatelRating": "A String", # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. |
| 487 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 488 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 489 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 490 | "djctqRating": "A String", # The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. |
| 491 | "kmrbRating": "A String", # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. |
| 492 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 493 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. |
| 494 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 495 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
| 496 | "A String", |
| 497 | ], |
| 498 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
| 499 | "smsaRating": "A String", # The video's rating from Statens medieråd (Sweden's National Media Council). |
| 500 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 501 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. |
| 502 | "smaisRating": "A String", # The video's rating in Iceland. |
| 503 | "agcomRating": "A String", # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). |
| 504 | "rteRating": "A String", # The video's rating from Ireland's Raidió Teilifís Éireann. |
| 505 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details. |
| 506 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 507 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). |
| 508 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
| 509 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. |
| 510 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 511 | "oflcRating": "A String", # The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. |
| 512 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 513 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
| 514 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). |
| 515 | "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. |
| 516 | "csaRating": "A String", # The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content. |
| 517 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 518 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 519 | "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. |
| 520 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
| 521 | "nbcplRating": "A String", # The video's rating in Poland. |
| 522 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
| 523 | "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. |
| 524 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. |
| 525 | "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. |
| 526 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. |
| 527 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 528 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 529 | "A String", |
| 530 | ], |
| 531 | "cicfRating": "A String", # The video's rating from the Commission de Contrôle des Films (Belgium). |
| 532 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). |
| 533 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. |
| 534 | "icaaRating": "A String", # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. |
| 535 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands). |
| 536 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. |
| 537 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 538 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 539 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 540 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 541 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 542 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 543 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture (文化部). |
| 544 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 545 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). |
| 546 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 547 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
| 548 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). |
| 549 | "pefilmRating": "A String", # The video's rating in Peru. |
| 550 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 551 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 552 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 553 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. |
| 554 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and Classification Board (Philippines). |
| 555 | "nkclvRating": "A String", # The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). |
| 556 | "nfrcRating": "A String", # The video's rating from the Bulgarian National Film Center. |
| 557 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). |
| 558 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 559 | "grfilmRating": "A String", # The video's rating in Greece. |
| 560 | }, |
| 561 | "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable. |
| 562 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 563 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 564 | "A String", |
| 565 | ], |
| 566 | }, |
| 567 | "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 568 | "caption": "A String", # The value of captions indicates whether the video has captions or not. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 569 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. |
| 570 | "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. |
| 571 | "A String", |
| 572 | ], |
| 573 | "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. |
| 574 | "A String", |
| 575 | ], |
| 576 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 577 | "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 578 | "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 579 | "projection": "A String", # Specifies the projection format of the video. |
| 580 | "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. |
| 581 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 582 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 583 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video". |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 584 | "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 585 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second. |
| 586 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 587 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 588 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
| 589 | { # Information about an audio stream. |
| 590 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 591 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 592 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
| 593 | "codec": "A String", # The audio codec that the stream uses. |
| 594 | }, |
| 595 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 596 | "container": "A String", # The uploaded video file's container format. |
| 597 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
| 598 | { # Information about a video stream. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 599 | "codec": "A String", # The video codec that the stream uses. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 600 | "heightPixels": 42, # The encoded video content's height in pixels. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 601 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 602 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 603 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video. |
| 604 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
| 605 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 606 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 607 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 608 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 609 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
| 610 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. |
| 611 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 612 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 613 | "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video. |
| 614 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API. |
| 615 | "A String", |
| 616 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 617 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the video's content. |
| 618 | "A String", |
| 619 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 620 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. |
| 621 | "A String", |
| 622 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 623 | }, |
| 624 | "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 625 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 626 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 627 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 628 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 629 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 630 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 631 | }, |
| 632 | "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 633 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| 634 | "A String", |
| 635 | ], |
| 636 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. |
| 637 | "A String", |
| 638 | ], |
| 639 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. |
| 640 | "A String", |
| 641 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 642 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. |
| 643 | { # A single tag suggestion with it's relevance information. |
| 644 | "tag": "A String", # The keyword tag suggested for the video. |
| 645 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. |
| 646 | "A String", |
| 647 | ], |
| 648 | }, |
| 649 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 650 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video. |
| 651 | "A String", |
| 652 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 653 | }, |
| 654 | "etag": "A String", # Etag of this resource. |
| 655 | "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
| 656 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 657 | "latitude": 3.14, # Latitude in degrees. |
| 658 | "longitude": 3.14, # Longitude in degrees. |
| 659 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 660 | }, |
| 661 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
| 662 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 663 | }, |
| 664 | "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. |
| 665 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| 666 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 667 | "url": "A String", # The thumbnail image's URL. |
| 668 | "width": 42, # (Optional) Width of the thumbnail image. |
| 669 | "height": 42, # (Optional) Height of the thumbnail image. |
| 670 | }, |
| 671 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 672 | "url": "A String", # The thumbnail image's URL. |
| 673 | "width": 42, # (Optional) Width of the thumbnail image. |
| 674 | "height": 42, # (Optional) Height of the thumbnail image. |
| 675 | }, |
| 676 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 677 | "url": "A String", # The thumbnail image's URL. |
| 678 | "width": 42, # (Optional) Width of the thumbnail image. |
| 679 | "height": 42, # (Optional) Height of the thumbnail image. |
| 680 | }, |
| 681 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 682 | "url": "A String", # The thumbnail image's URL. |
| 683 | "width": 42, # (Optional) Width of the thumbnail image. |
| 684 | "height": 42, # (Optional) Height of the thumbnail image. |
| 685 | }, |
| 686 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 687 | "url": "A String", # The thumbnail image's URL. |
| 688 | "width": 42, # (Optional) Width of the thumbnail image. |
| 689 | "height": 42, # (Optional) Height of the thumbnail image. |
| 690 | }, |
| 691 | }, |
| 692 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) |
| 693 | "title": "A String", # Localized version of the video's title. |
| 694 | "description": "A String", # Localized version of the video's description. |
| 695 | }, |
| 696 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. |
| 697 | "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track. |
| 698 | "categoryId": "A String", # The YouTube video category associated with the video. |
| 699 | "description": "A String", # The video's description. @mutable youtube.videos.insert youtube.videos.update |
| 700 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 701 | "A String", |
| 702 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 703 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| 704 | "title": "A String", # The video's title. @mutable youtube.videos.insert youtube.videos.update |
| 705 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 706 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 format. |
| 707 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 708 | }, |
| 709 | "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player. |
| 710 | "embedHeight": "A String", |
| 711 | "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video. |
| 712 | "embedWidth": "A String", # The embed width |
| 713 | }, |
| 714 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video. |
| 715 | "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not. |
| 716 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 717 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 718 | "A String", |
| 719 | ], |
| 720 | }, |
| 721 | }, |
| 722 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata. |
| 723 | "tags": [ # A list of project tags associated with the video during the upload. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 724 | "A String", |
| 725 | ], |
| 726 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 727 | "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. |
| 728 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. |
| 729 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video. |
| 730 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. |
| 731 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 732 | "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. |
| 733 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. |
| 734 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. |
| 735 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
| 736 | }, |
| 737 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 738 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 739 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. |
| 740 | }, |
| 741 | "localizations": { # The localizations object contains localized versions of the basic details about the video, such as its title and description. |
| 742 | "a_key": { # Localized versions of certain video properties (e.g. title). |
| 743 | "title": "A String", # Localized version of the video's title. |
| 744 | "description": "A String", # Localized version of the video's description. |
| 745 | }, |
| 746 | }, |
| 747 | "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. |
| 748 | "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update |
| 749 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. |
| 750 | "selfDeclaredMadeForKids": True or False, |
| 751 | "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. |
| 752 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update |
| 753 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update |
| 754 | "madeForKids": True or False, |
| 755 | "privacyStatus": "A String", # The video's privacy status. |
| 756 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format. |
| 757 | "uploadStatus": "A String", # The status of the uploaded video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 758 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 759 | }</pre> |
| 760 | </div> |
| 761 | |
| 762 | <div class="method"> |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 763 | <code class="details" id="list">list(part, onBehalfOfContentOwner=None, maxHeight=None, chart=None, regionCode=None, maxResults=None, myRating=None, videoCategoryId=None, locale=None, id=None, hl=None, pageToken=None, maxWidth=None, x__xgafv=None)</code> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 764 | <pre>Retrieves a list of resources, possibly filtered. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 765 | |
| 766 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 767 | part: string, The *part* parameter specifies a comma-separated list of one or more video resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set *part=snippet*, the API response will contain all of those properties. (required) (repeated) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 768 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 769 | maxHeight: integer, A parameter |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 770 | chart: string, Return the videos that are in the specified chart. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 771 | Allowed values |
| 772 | chartUnspecified - |
| 773 | mostPopular - Return the most popular videos for the specified content region and video category. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 774 | regionCode: string, Use a chart that is specific to the specified region |
| 775 | maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 776 | myRating: string, Return videos liked/disliked by the authenticated user. Does not support RateType.RATED_TYPE_NONE. |
| 777 | Allowed values |
| 778 | none - |
| 779 | like - The entity is liked. |
| 780 | dislike - The entity is disliked. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 781 | videoCategoryId: string, Use chart that is specific to the specified video category |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 782 | locale: string, A parameter |
| 783 | id: string, Return videos with the given ids. (repeated) |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 784 | hl: string, Stands for "host language". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX). |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 785 | pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. *Note:* This parameter is supported for use in conjunction with the myRating and chart parameters, but it is not supported for use in conjunction with the id parameter. |
| 786 | maxWidth: integer, Return the player with maximum height specified in |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 787 | x__xgafv: string, V1 error format. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 788 | Allowed values |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 789 | 1 - v1 error format |
| 790 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 791 | |
| 792 | Returns: |
| 793 | An object of the form: |
| 794 | |
| 795 | { |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 796 | "nextPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set. |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 797 | "kind": "youtube#videoListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse". |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 798 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 799 | }, |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 800 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 801 | "etag": "A String", # Etag of this resource. |
| 802 | "prevPageToken": "A String", # The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set. |
| 803 | "visitorId": "A String", # The visitorId identifies the visitor. |
| 804 | "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. # General pagination information. |
| 805 | "resultsPerPage": 42, # The number of results included in the API response. |
| 806 | "totalResults": 42, # The total number of results in the result set. |
| 807 | }, |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 808 | "items": [ |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 809 | { # A *video* resource represents a YouTube video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 810 | "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 811 | "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 812 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 813 | "viewCount": "A String", # The number of times the video has been viewed. |
| 814 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating. |
| 815 | "commentCount": "A String", # The number of comments for the video. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 816 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 817 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. |
| 818 | "videoGameRating": "A String", # Video game rating, if any. |
| 819 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. |
| 820 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. |
| 821 | }, |
| 822 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 823 | "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 824 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. |
| 825 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. |
| 826 | "anatelRating": "A String", # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. |
| 827 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 828 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 829 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 830 | "djctqRating": "A String", # The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. |
| 831 | "kmrbRating": "A String", # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. |
| 832 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 833 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. |
| 834 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 835 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
| 836 | "A String", |
| 837 | ], |
| 838 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
| 839 | "smsaRating": "A String", # The video's rating from Statens medieråd (Sweden's National Media Council). |
| 840 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 841 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. |
| 842 | "smaisRating": "A String", # The video's rating in Iceland. |
| 843 | "agcomRating": "A String", # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). |
| 844 | "rteRating": "A String", # The video's rating from Ireland's Raidió Teilifís Éireann. |
| 845 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details. |
| 846 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 847 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). |
| 848 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
| 849 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. |
| 850 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 851 | "oflcRating": "A String", # The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. |
| 852 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 853 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
| 854 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). |
| 855 | "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. |
| 856 | "csaRating": "A String", # The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content. |
| 857 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 858 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 859 | "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. |
| 860 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
| 861 | "nbcplRating": "A String", # The video's rating in Poland. |
| 862 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
| 863 | "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. |
| 864 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. |
| 865 | "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. |
| 866 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. |
| 867 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 868 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 869 | "A String", |
| 870 | ], |
| 871 | "cicfRating": "A String", # The video's rating from the Commission de Contrôle des Films (Belgium). |
| 872 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). |
| 873 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. |
| 874 | "icaaRating": "A String", # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. |
| 875 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands). |
| 876 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. |
| 877 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 878 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 879 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 880 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 881 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 882 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 883 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture (文化部). |
| 884 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 885 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). |
| 886 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 887 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
| 888 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). |
| 889 | "pefilmRating": "A String", # The video's rating in Peru. |
| 890 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 891 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 892 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 893 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. |
| 894 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and Classification Board (Philippines). |
| 895 | "nkclvRating": "A String", # The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). |
| 896 | "nfrcRating": "A String", # The video's rating from the Bulgarian National Film Center. |
| 897 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). |
| 898 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 899 | "grfilmRating": "A String", # The video's rating in Greece. |
| 900 | }, |
| 901 | "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable. |
| 902 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 903 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 904 | "A String", |
| 905 | ], |
| 906 | }, |
| 907 | "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 908 | "caption": "A String", # The value of captions indicates whether the video has captions or not. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 909 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. |
| 910 | "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. |
| 911 | "A String", |
| 912 | ], |
| 913 | "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. |
| 914 | "A String", |
| 915 | ], |
| 916 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 917 | "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 918 | "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 919 | "projection": "A String", # Specifies the projection format of the video. |
| 920 | "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. |
| 921 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 922 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 923 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video". |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 924 | "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 925 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second. |
| 926 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 927 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 928 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
| 929 | { # Information about an audio stream. |
| 930 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 931 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 932 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
| 933 | "codec": "A String", # The audio codec that the stream uses. |
| 934 | }, |
| 935 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 936 | "container": "A String", # The uploaded video file's container format. |
| 937 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
| 938 | { # Information about a video stream. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 939 | "codec": "A String", # The video codec that the stream uses. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 940 | "heightPixels": 42, # The encoded video content's height in pixels. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 941 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 942 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 943 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video. |
| 944 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
| 945 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 946 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 947 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 948 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 949 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
| 950 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. |
| 951 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 952 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 953 | "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video. |
| 954 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API. |
| 955 | "A String", |
| 956 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 957 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the video's content. |
| 958 | "A String", |
| 959 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 960 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. |
| 961 | "A String", |
| 962 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 963 | }, |
| 964 | "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 965 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 966 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 967 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 968 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 969 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 970 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 971 | }, |
| 972 | "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 973 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| 974 | "A String", |
| 975 | ], |
| 976 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. |
| 977 | "A String", |
| 978 | ], |
| 979 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. |
| 980 | "A String", |
| 981 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 982 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. |
| 983 | { # A single tag suggestion with it's relevance information. |
| 984 | "tag": "A String", # The keyword tag suggested for the video. |
| 985 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. |
| 986 | "A String", |
| 987 | ], |
| 988 | }, |
| 989 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 990 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video. |
| 991 | "A String", |
| 992 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 993 | }, |
| 994 | "etag": "A String", # Etag of this resource. |
| 995 | "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
| 996 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 997 | "latitude": 3.14, # Latitude in degrees. |
| 998 | "longitude": 3.14, # Longitude in degrees. |
| 999 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 1000 | }, |
| 1001 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
| 1002 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 1003 | }, |
| 1004 | "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. |
| 1005 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| 1006 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1007 | "url": "A String", # The thumbnail image's URL. |
| 1008 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1009 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1010 | }, |
| 1011 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 1012 | "url": "A String", # The thumbnail image's URL. |
| 1013 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1014 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1015 | }, |
| 1016 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1017 | "url": "A String", # The thumbnail image's URL. |
| 1018 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1019 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1020 | }, |
| 1021 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1022 | "url": "A String", # The thumbnail image's URL. |
| 1023 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1024 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1025 | }, |
| 1026 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 1027 | "url": "A String", # The thumbnail image's URL. |
| 1028 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1029 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1030 | }, |
| 1031 | }, |
| 1032 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) |
| 1033 | "title": "A String", # Localized version of the video's title. |
| 1034 | "description": "A String", # Localized version of the video's description. |
| 1035 | }, |
| 1036 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. |
| 1037 | "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track. |
| 1038 | "categoryId": "A String", # The YouTube video category associated with the video. |
| 1039 | "description": "A String", # The video's description. @mutable youtube.videos.insert youtube.videos.update |
| 1040 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1041 | "A String", |
| 1042 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1043 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| 1044 | "title": "A String", # The video's title. @mutable youtube.videos.insert youtube.videos.update |
| 1045 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 1046 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 format. |
| 1047 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 1048 | }, |
| 1049 | "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player. |
| 1050 | "embedHeight": "A String", |
| 1051 | "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video. |
| 1052 | "embedWidth": "A String", # The embed width |
| 1053 | }, |
| 1054 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video. |
| 1055 | "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not. |
| 1056 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 1057 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 1058 | "A String", |
| 1059 | ], |
| 1060 | }, |
| 1061 | }, |
| 1062 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata. |
| 1063 | "tags": [ # A list of project tags associated with the video during the upload. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1064 | "A String", |
| 1065 | ], |
| 1066 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1067 | "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. |
| 1068 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. |
| 1069 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video. |
| 1070 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. |
| 1071 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1072 | "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. |
| 1073 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. |
| 1074 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. |
| 1075 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
| 1076 | }, |
| 1077 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1078 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1079 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. |
| 1080 | }, |
| 1081 | "localizations": { # The localizations object contains localized versions of the basic details about the video, such as its title and description. |
| 1082 | "a_key": { # Localized versions of certain video properties (e.g. title). |
| 1083 | "title": "A String", # Localized version of the video's title. |
| 1084 | "description": "A String", # Localized version of the video's description. |
| 1085 | }, |
| 1086 | }, |
| 1087 | "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. |
| 1088 | "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update |
| 1089 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. |
| 1090 | "selfDeclaredMadeForKids": True or False, |
| 1091 | "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. |
| 1092 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update |
| 1093 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update |
| 1094 | "madeForKids": True or False, |
| 1095 | "privacyStatus": "A String", # The video's privacy status. |
| 1096 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format. |
| 1097 | "uploadStatus": "A String", # The status of the uploaded video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1098 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1099 | }, |
| 1100 | ], |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1101 | }</pre> |
| 1102 | </div> |
| 1103 | |
| 1104 | <div class="method"> |
| 1105 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1106 | <pre>Retrieves the next page of results. |
| 1107 | |
| 1108 | Args: |
| 1109 | previous_request: The request for the previous page. (required) |
| 1110 | previous_response: The response from the request for the previous page. (required) |
| 1111 | |
| 1112 | Returns: |
Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1113 | 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] | 1114 | page. Returns None if there are no more items in the collection. |
| 1115 | </pre> |
| 1116 | </div> |
| 1117 | |
| 1118 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1119 | <code class="details" id="rate">rate(id, rating, x__xgafv=None)</code> |
| 1120 | <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] | 1121 | |
| 1122 | Args: |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1123 | id: string, A parameter (required) |
| 1124 | rating: string, A parameter (required) |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1125 | Allowed values |
| 1126 | none - |
| 1127 | like - The entity is liked. |
| 1128 | dislike - The entity is disliked. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1129 | x__xgafv: string, V1 error format. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1130 | Allowed values |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1131 | 1 - v1 error format |
| 1132 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1133 | </pre> |
| 1134 | </div> |
| 1135 | |
| 1136 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1137 | <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] | 1138 | <pre>Report abuse for a video. |
| 1139 | |
| 1140 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1141 | body: object, The request body. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1142 | The object takes the form of: |
| 1143 | |
| 1144 | { |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1145 | "reasonId": "A String", # The high-level, or primary, reason that the content is abusive. The value is an abuse report reason ID. |
| 1146 | "videoId": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1147 | "comments": "A String", # Additional comments regarding the abuse report. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1148 | "language": "A String", # The language that the content was viewed in. |
| 1149 | "secondaryReasonId": "A String", # The specific, or secondary, reason that this content is abusive (if available). The value is an abuse report reason ID that is a valid secondary reason for the primary reason. |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1150 | } |
| 1151 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1152 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1153 | x__xgafv: string, V1 error format. |
| 1154 | Allowed values |
| 1155 | 1 - v1 error format |
| 1156 | 2 - v2 error format |
Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1157 | </pre> |
| 1158 | </div> |
| 1159 | |
| 1160 | <div class="method"> |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1161 | <code class="details" id="update">update(part, body=None, onBehalfOfContentOwner=None, x__xgafv=None)</code> |
| 1162 | <pre>Updates an existing resource. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1163 | |
| 1164 | Args: |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1165 | part: string, The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting. In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response. (required) (repeated) |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1166 | body: object, The request body. |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1167 | The object takes the form of: |
| 1168 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1169 | { # A *video* resource represents a YouTube video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1170 | "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1171 | "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1172 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1173 | "viewCount": "A String", # The number of times the video has been viewed. |
| 1174 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating. |
| 1175 | "commentCount": "A String", # The number of comments for the video. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1176 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1177 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. |
| 1178 | "videoGameRating": "A String", # Video game rating, if any. |
| 1179 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. |
| 1180 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. |
| 1181 | }, |
| 1182 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1183 | "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1184 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. |
| 1185 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. |
| 1186 | "anatelRating": "A String", # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. |
| 1187 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 1188 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 1189 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 1190 | "djctqRating": "A String", # The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. |
| 1191 | "kmrbRating": "A String", # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. |
| 1192 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 1193 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. |
| 1194 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 1195 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
| 1196 | "A String", |
| 1197 | ], |
| 1198 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
| 1199 | "smsaRating": "A String", # The video's rating from Statens medieråd (Sweden's National Media Council). |
| 1200 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 1201 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. |
| 1202 | "smaisRating": "A String", # The video's rating in Iceland. |
| 1203 | "agcomRating": "A String", # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). |
| 1204 | "rteRating": "A String", # The video's rating from Ireland's Raidió Teilifís Éireann. |
| 1205 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details. |
| 1206 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 1207 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). |
| 1208 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
| 1209 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. |
| 1210 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 1211 | "oflcRating": "A String", # The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. |
| 1212 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 1213 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
| 1214 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). |
| 1215 | "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. |
| 1216 | "csaRating": "A String", # The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content. |
| 1217 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 1218 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 1219 | "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. |
| 1220 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
| 1221 | "nbcplRating": "A String", # The video's rating in Poland. |
| 1222 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
| 1223 | "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. |
| 1224 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. |
| 1225 | "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. |
| 1226 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. |
| 1227 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 1228 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 1229 | "A String", |
| 1230 | ], |
| 1231 | "cicfRating": "A String", # The video's rating from the Commission de Contrôle des Films (Belgium). |
| 1232 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). |
| 1233 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. |
| 1234 | "icaaRating": "A String", # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. |
| 1235 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands). |
| 1236 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. |
| 1237 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 1238 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 1239 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 1240 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 1241 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 1242 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 1243 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture (文化部). |
| 1244 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 1245 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). |
| 1246 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 1247 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
| 1248 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). |
| 1249 | "pefilmRating": "A String", # The video's rating in Peru. |
| 1250 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 1251 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 1252 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 1253 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. |
| 1254 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and Classification Board (Philippines). |
| 1255 | "nkclvRating": "A String", # The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). |
| 1256 | "nfrcRating": "A String", # The video's rating from the Bulgarian National Film Center. |
| 1257 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). |
| 1258 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 1259 | "grfilmRating": "A String", # The video's rating in Greece. |
| 1260 | }, |
| 1261 | "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable. |
| 1262 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 1263 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 1264 | "A String", |
| 1265 | ], |
| 1266 | }, |
| 1267 | "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1268 | "caption": "A String", # The value of captions indicates whether the video has captions or not. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1269 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. |
| 1270 | "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. |
| 1271 | "A String", |
| 1272 | ], |
| 1273 | "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. |
| 1274 | "A String", |
| 1275 | ], |
| 1276 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1277 | "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1278 | "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1279 | "projection": "A String", # Specifies the projection format of the video. |
| 1280 | "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. |
| 1281 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1282 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1283 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video". |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1284 | "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1285 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second. |
| 1286 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1287 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1288 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
| 1289 | { # Information about an audio stream. |
| 1290 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 1291 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 1292 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
| 1293 | "codec": "A String", # The audio codec that the stream uses. |
| 1294 | }, |
| 1295 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1296 | "container": "A String", # The uploaded video file's container format. |
| 1297 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
| 1298 | { # Information about a video stream. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1299 | "codec": "A String", # The video codec that the stream uses. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1300 | "heightPixels": 42, # The encoded video content's height in pixels. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1301 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1302 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1303 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video. |
| 1304 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
| 1305 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 1306 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1307 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1308 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1309 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
| 1310 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. |
| 1311 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1312 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1313 | "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video. |
| 1314 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API. |
| 1315 | "A String", |
| 1316 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1317 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the video's content. |
| 1318 | "A String", |
| 1319 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1320 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. |
| 1321 | "A String", |
| 1322 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1323 | }, |
| 1324 | "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1325 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1326 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1327 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1328 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1329 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1330 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1331 | }, |
| 1332 | "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1333 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| 1334 | "A String", |
| 1335 | ], |
| 1336 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. |
| 1337 | "A String", |
| 1338 | ], |
| 1339 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. |
| 1340 | "A String", |
| 1341 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1342 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. |
| 1343 | { # A single tag suggestion with it's relevance information. |
| 1344 | "tag": "A String", # The keyword tag suggested for the video. |
| 1345 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. |
| 1346 | "A String", |
| 1347 | ], |
| 1348 | }, |
| 1349 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1350 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video. |
| 1351 | "A String", |
| 1352 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1353 | }, |
| 1354 | "etag": "A String", # Etag of this resource. |
| 1355 | "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
| 1356 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 1357 | "latitude": 3.14, # Latitude in degrees. |
| 1358 | "longitude": 3.14, # Longitude in degrees. |
| 1359 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 1360 | }, |
| 1361 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
| 1362 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 1363 | }, |
| 1364 | "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. |
| 1365 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| 1366 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1367 | "url": "A String", # The thumbnail image's URL. |
| 1368 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1369 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1370 | }, |
| 1371 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 1372 | "url": "A String", # The thumbnail image's URL. |
| 1373 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1374 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1375 | }, |
| 1376 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1377 | "url": "A String", # The thumbnail image's URL. |
| 1378 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1379 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1380 | }, |
| 1381 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1382 | "url": "A String", # The thumbnail image's URL. |
| 1383 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1384 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1385 | }, |
| 1386 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 1387 | "url": "A String", # The thumbnail image's URL. |
| 1388 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1389 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1390 | }, |
| 1391 | }, |
| 1392 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) |
| 1393 | "title": "A String", # Localized version of the video's title. |
| 1394 | "description": "A String", # Localized version of the video's description. |
| 1395 | }, |
| 1396 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. |
| 1397 | "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track. |
| 1398 | "categoryId": "A String", # The YouTube video category associated with the video. |
| 1399 | "description": "A String", # The video's description. @mutable youtube.videos.insert youtube.videos.update |
| 1400 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1401 | "A String", |
| 1402 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1403 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| 1404 | "title": "A String", # The video's title. @mutable youtube.videos.insert youtube.videos.update |
| 1405 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 1406 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 format. |
| 1407 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 1408 | }, |
| 1409 | "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player. |
| 1410 | "embedHeight": "A String", |
| 1411 | "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video. |
| 1412 | "embedWidth": "A String", # The embed width |
| 1413 | }, |
| 1414 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video. |
| 1415 | "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not. |
| 1416 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 1417 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 1418 | "A String", |
| 1419 | ], |
| 1420 | }, |
| 1421 | }, |
| 1422 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata. |
| 1423 | "tags": [ # A list of project tags associated with the video during the upload. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1424 | "A String", |
| 1425 | ], |
| 1426 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1427 | "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. |
| 1428 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. |
| 1429 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video. |
| 1430 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. |
| 1431 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1432 | "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. |
| 1433 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. |
| 1434 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. |
| 1435 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
| 1436 | }, |
| 1437 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1438 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1439 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. |
| 1440 | }, |
| 1441 | "localizations": { # The localizations object contains localized versions of the basic details about the video, such as its title and description. |
| 1442 | "a_key": { # Localized versions of certain video properties (e.g. title). |
| 1443 | "title": "A String", # Localized version of the video's title. |
| 1444 | "description": "A String", # Localized version of the video's description. |
| 1445 | }, |
| 1446 | }, |
| 1447 | "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. |
| 1448 | "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update |
| 1449 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. |
| 1450 | "selfDeclaredMadeForKids": True or False, |
| 1451 | "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. |
| 1452 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update |
| 1453 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update |
| 1454 | "madeForKids": True or False, |
| 1455 | "privacyStatus": "A String", # The video's privacy status. |
| 1456 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format. |
| 1457 | "uploadStatus": "A String", # The status of the uploaded video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1458 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1459 | } |
| 1460 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1461 | onBehalfOfContentOwner: string, *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |
Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1462 | x__xgafv: string, V1 error format. |
| 1463 | Allowed values |
| 1464 | 1 - v1 error format |
| 1465 | 2 - v2 error format |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1466 | |
| 1467 | Returns: |
| 1468 | An object of the form: |
| 1469 | |
Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1470 | { # A *video* resource represents a YouTube video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1471 | "statistics": { # Statistics about the video, such as the number of times the video was viewed or liked. # The statistics object contains statistics about the video. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1472 | "likeCount": "A String", # The number of users who have indicated that they liked the video by giving it a positive rating. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1473 | "favoriteCount": "A String", # The number of users who currently have the video marked as a favorite video. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1474 | "viewCount": "A String", # The number of times the video has been viewed. |
| 1475 | "dislikeCount": "A String", # The number of users who have indicated that they disliked the video by giving it a negative rating. |
| 1476 | "commentCount": "A String", # The number of comments for the video. |
Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [diff] [blame] | 1477 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1478 | "ageGating": { # Age restriction details related to a video. This data can only be retrieved by the video owner. |
| 1479 | "videoGameRating": "A String", # Video game rating, if any. |
| 1480 | "alcoholContent": True or False, # Indicates whether or not the video has alcoholic beverage content. Only users of legal purchasing age in a particular country, as identified by ICAP, can view the content. |
| 1481 | "restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. |
| 1482 | }, |
| 1483 | "id": "A String", # The ID that YouTube uses to uniquely identify the video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1484 | "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1485 | "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. |
| 1486 | "rtcRating": "A String", # The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. |
| 1487 | "anatelRating": "A String", # The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. |
| 1488 | "eefilmRating": "A String", # The video's rating in Estonia. |
| 1489 | "mccaaRating": "A String", # The video's rating from Malta's Film Age-Classification Board. |
| 1490 | "chfilmRating": "A String", # The video's rating in Switzerland. |
| 1491 | "djctqRating": "A String", # The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. |
| 1492 | "kmrbRating": "A String", # The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. |
| 1493 | "mocRating": "A String", # The video's Ministerio de Cultura (Colombia) rating. |
| 1494 | "ifcoRating": "A String", # The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. |
| 1495 | "skfilmRating": "A String", # The video's rating in Slovakia. |
| 1496 | "djctqRatingReasons": [ # Reasons that explain why the video received its DJCQT (Brazil) rating. |
| 1497 | "A String", |
| 1498 | ], |
| 1499 | "fpbRating": "A String", # The video's rating from South Africa's Film and Publication Board. |
| 1500 | "smsaRating": "A String", # The video's rating from Statens medieråd (Sweden's National Media Council). |
| 1501 | "cncRating": "A String", # Rating system in France - Commission de classification cinematographique |
| 1502 | "acbRating": "A String", # The video's Australian Classification Board (ACB) or Australian Communications and Media Authority (ACMA) rating. ACMA ratings are used to classify children's television programming. |
| 1503 | "smaisRating": "A String", # The video's rating in Iceland. |
| 1504 | "agcomRating": "A String", # The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). |
| 1505 | "rteRating": "A String", # The video's rating from Ireland's Raidió Teilifís Éireann. |
| 1506 | "menaMpaaRating": "A String", # The rating system for MENA countries, a clone of MPAA. It is needed to prevent titles go live w/o additional QC check, since some of them can be inappropriate for the countries at all. See b/33408548 for more details. |
| 1507 | "egfilmRating": "A String", # The video's rating in Egypt. |
| 1508 | "mibacRating": "A String", # The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). |
| 1509 | "ecbmctRating": "A String", # Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
| 1510 | "fcoRating": "A String", # The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. |
| 1511 | "lsfRating": "A String", # The video's rating from Indonesia's Lembaga Sensor Film. |
| 1512 | "oflcRating": "A String", # The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. |
| 1513 | "bbfcRating": "A String", # The video's British Board of Film Classification (BBFC) rating. |
| 1514 | "tvpgRating": "A String", # The video's TV Parental Guidelines (TVPG) rating. |
| 1515 | "mdaRating": "A String", # The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). |
| 1516 | "cceRating": "A String", # The video's rating from Portugal's Comissão de Classificação de Espect´culos. |
| 1517 | "csaRating": "A String", # The video's rating from France's Conseil supérieur de l’audiovisuel, which rates broadcast content. |
| 1518 | "czfilmRating": "A String", # The video's rating in the Czech Republic. |
| 1519 | "ilfilmRating": "A String", # The video's rating in Israel. |
| 1520 | "cccRating": "A String", # The video's Consejo de Calificación Cinematográfica (Chile) rating. |
| 1521 | "nfvcbRating": "A String", # The video's rating from Nigeria's National Film and Video Censors Board. |
| 1522 | "nbcplRating": "A String", # The video's rating in Poland. |
| 1523 | "fcbmRating": "A String", # The video's rating from Malaysia's Film Censorship Board. |
| 1524 | "eirinRating": "A String", # The video's Eirin (映倫) rating. Eirin is the Japanese rating system. |
| 1525 | "russiaRating": "A String", # The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. |
| 1526 | "fmocRating": "A String", # This property has been deprecated. Use the contentDetails.contentRating.cncRating instead. |
| 1527 | "incaaRating": "A String", # The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. |
| 1528 | "mpaatRating": "A String", # The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html. |
| 1529 | "fpbRatingReasons": [ # Reasons that explain why the video received its FPB (South Africa) rating. |
| 1530 | "A String", |
| 1531 | ], |
| 1532 | "cicfRating": "A String", # The video's rating from the Commission de Contrôle des Films (Belgium). |
| 1533 | "cnaRating": "A String", # The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). |
| 1534 | "mccypRating": "A String", # The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. |
| 1535 | "icaaRating": "A String", # The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. |
| 1536 | "kijkwijzerRating": "A String", # The video's NICAM/Kijkwijzer rating from the Nederlands Instituut voor de Classificatie van Audiovisuele Media (Netherlands). |
| 1537 | "fskRating": "A String", # The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. |
| 1538 | "nbcRating": "A String", # The video's rating from the Maldives National Bureau of Classification. |
| 1539 | "resorteviolenciaRating": "A String", # The video's rating in Venezuela. |
| 1540 | "chvrsRating": "A String", # The video's Canadian Home Video Rating System (CHVRS) rating. |
| 1541 | "bfvcRating": "A String", # The video's rating from Thailand's Board of Film and Video Censors. |
| 1542 | "catvRating": "A String", # Rating system for Canadian TV - Canadian TV Classification System The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian English-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 1543 | "mpaaRating": "A String", # The video's Motion Picture Association of America (MPAA) rating. |
| 1544 | "moctwRating": "A String", # The video's rating from Taiwan's Ministry of Culture (文化部). |
| 1545 | "catvfrRating": "A String", # The video's rating from the Canadian Radio-Television and Telecommunications Commission (CRTC) for Canadian French-language broadcasts. For more information, see the Canadian Broadcast Standards Council website. |
| 1546 | "mekuRating": "A String", # The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). |
| 1547 | "medietilsynetRating": "A String", # The video's rating from Medietilsynet, the Norwegian Media Authority. |
| 1548 | "ytRating": "A String", # A rating that YouTube uses to identify age-restricted content. |
| 1549 | "bmukkRating": "A String", # The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). |
| 1550 | "pefilmRating": "A String", # The video's rating in Peru. |
| 1551 | "cbfcRating": "A String", # The video's Central Board of Film Certification (CBFC - India) rating. |
| 1552 | "nmcRating": "A String", # The National Media Council ratings system for United Arab Emirates. |
| 1553 | "mcstRating": "A String", # The video's rating system for Vietnam - MCST |
| 1554 | "rcnofRating": "A String", # The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film. |
| 1555 | "mtrcbRating": "A String", # The video's rating from the Movie and Television Review and Classification Board (Philippines). |
| 1556 | "nkclvRating": "A String", # The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). |
| 1557 | "nfrcRating": "A String", # The video's rating from the Bulgarian National Film Center. |
| 1558 | "cscfRating": "A String", # The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). |
| 1559 | "kfcbRating": "A String", # The video's rating from the Kenya Film Classification Board. |
| 1560 | "grfilmRating": "A String", # The video's rating in Greece. |
| 1561 | }, |
| 1562 | "countryRestriction": { # Rights management policy for YouTube resources. # The countryRestriction object contains information about the countries where a video is (or is not) viewable. |
| 1563 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 1564 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 1565 | "A String", |
| 1566 | ], |
| 1567 | }, |
| 1568 | "duration": "A String", # The length of the video. The tag value is an ISO 8601 duration in the format PT#M#S, in which the letters PT indicate that the value specifies a period of time, and the letters M and S refer to length in minutes and seconds, respectively. The # characters preceding the M and S letters are both integers that specify the number of minutes (or seconds) of the video. For example, a value of PT15M51S indicates that the video is 15 minutes and 51 seconds long. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1569 | "caption": "A String", # The value of captions indicates whether the video has captions or not. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1570 | "regionRestriction": { # DEPRECATED Region restriction of the video. # The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property. |
| 1571 | "allowed": [ # A list of region codes that identify countries where the video is viewable. If this property is present and a country is not listed in its value, then the video is blocked from appearing in that country. If this property is present and contains an empty list, the video is blocked in all countries. |
| 1572 | "A String", |
| 1573 | ], |
| 1574 | "blocked": [ # A list of region codes that identify countries where the video is blocked. If this property is present and a country is not listed in its value, then the video is viewable in that country. If this property is present and contains an empty list, the video is viewable in all countries. |
| 1575 | "A String", |
| 1576 | ], |
| 1577 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1578 | "definition": "A String", # The value of definition indicates whether the video is available in high definition or only in standard definition. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1579 | "licensedContent": True or False, # The value of is_license_content indicates whether the video is licensed content. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1580 | "projection": "A String", # Specifies the projection format of the video. |
| 1581 | "dimension": "A String", # The value of dimension indicates whether the video is available in 3D or in 2D. |
| 1582 | "hasCustomThumbnail": True or False, # Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1583 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1584 | "kind": "youtube#video", # Identifies what kind of resource this is. Value: the fixed string "youtube#video". |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1585 | "fileDetails": { # Describes original video file properties, including technical details about audio and video streams, but also metadata information like content length, digitization time, or geotagging information. # The fileDetails object encapsulates information about the video file that was uploaded to YouTube, including the file's resolution, duration, audio and video codecs, stream bitrates, and more. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1586 | "bitrateBps": "A String", # The uploaded video file's combined (video and audio) bitrate in bits per second. |
| 1587 | "durationMs": "A String", # The length of the uploaded video in milliseconds. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1588 | "fileSize": "A String", # The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1589 | "audioStreams": [ # A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
| 1590 | { # Information about an audio stream. |
| 1591 | "channelCount": 42, # The number of audio channels that the stream contains. |
| 1592 | "bitrateBps": "A String", # The audio stream's bitrate, in bits per second. |
| 1593 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
| 1594 | "codec": "A String", # The audio codec that the stream uses. |
| 1595 | }, |
| 1596 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1597 | "container": "A String", # The uploaded video file's container format. |
| 1598 | "videoStreams": [ # A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
| 1599 | { # Information about a video stream. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1600 | "codec": "A String", # The video codec that the stream uses. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1601 | "heightPixels": 42, # The encoded video content's height in pixels. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1602 | "bitrateBps": "A String", # The video stream's bitrate, in bits per second. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1603 | "vendor": "A String", # A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1604 | "rotation": "A String", # The amount that YouTube needs to rotate the original source content to properly display the video. |
| 1605 | "aspectRatio": 3.14, # The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
| 1606 | "frameRateFps": 3.14, # The video stream's frame rate, in frames per second. |
| 1607 | "widthPixels": 42, # The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1608 | }, |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1609 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1610 | "fileName": "A String", # The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
| 1611 | "fileType": "A String", # The uploaded file's type as detected by YouTube's video processing engine. Currently, YouTube only processes video files, but this field is present whether a video file or another type of file was uploaded. |
| 1612 | "creationTime": "A String", # The date and time when the uploaded video file was created. The value is specified in ISO 8601 format. Currently, the following ISO 8601 formats are supported: - Date only: YYYY-MM-DD - Naive time: YYYY-MM-DDTHH:MM:SS - Time with timezone: YYYY-MM-DDTHH:MM:SS+HH:MM |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1613 | }, |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1614 | "topicDetails": { # Freebase topic information related to the video. # The topicDetails object encapsulates information about Freebase topics associated with the video. |
| 1615 | "topicIds": [ # A list of Freebase topic IDs that are centrally associated with the video. These are topics that are centrally featured in the video, and it can be said that the video is mainly about each of these. You can retrieve information about each topic using the < a href="http://wiki.freebase.com/wiki/Topic_API">Freebase Topic API. |
| 1616 | "A String", |
| 1617 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1618 | "topicCategories": [ # A list of Wikipedia URLs that provide a high-level description of the video's content. |
| 1619 | "A String", |
| 1620 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1621 | "relevantTopicIds": [ # Similar to topic_id, except that these topics are merely relevant to the video. These are topics that may be mentioned in, or appear in the video. You can retrieve information about each topic using Freebase Topic API. |
| 1622 | "A String", |
| 1623 | ], |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1624 | }, |
| 1625 | "liveStreamingDetails": { # Details about the live streaming metadata. # The liveStreamingDetails object contains metadata about a live video broadcast. The object will only be present in a video resource if the video is an upcoming, live, or completed live broadcast. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1626 | "scheduledEndTime": "A String", # The time that the broadcast is scheduled to end. The value is specified in ISO 8601 format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1627 | "scheduledStartTime": "A String", # The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1628 | "activeLiveChatId": "A String", # The ID of the currently active live chat attached to this video. This field is filled only if the video is a currently live broadcast that has live chat. Once the broadcast transitions to complete this field will be removed and the live chat closed down. For persistent broadcasts that live chat id will no longer be tied to this video but rather to the new video being displayed at the persistent page. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1629 | "concurrentViewers": "A String", # The number of viewers currently watching the broadcast. The property and its value will be present if the broadcast has current viewers and the broadcast owner has not hidden the viewcount for the video. Note that YouTube stops tracking the number of concurrent viewers for a broadcast when the broadcast ends. So, this property would not identify the number of viewers watching an archived video of a live broadcast that already ended. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1630 | "actualEndTime": "A String", # The time that the broadcast actually ended. The value is specified in ISO 8601 format. This value will not be available until the broadcast is over. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1631 | "actualStartTime": "A String", # The time that the broadcast actually started. The value is specified in ISO 8601 format. This value will not be available until the broadcast begins. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1632 | }, |
| 1633 | "suggestions": { # Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions. # The suggestions object encapsulates suggestions that identify opportunities to improve the video quality or the metadata for the uploaded video. This data can only be retrieved by the video owner. |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1634 | "editorSuggestions": [ # A list of video editing operations that might improve the video quality or playback experience of the uploaded video. |
| 1635 | "A String", |
| 1636 | ], |
| 1637 | "processingErrors": [ # A list of errors that will prevent YouTube from successfully processing the uploaded video video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed. |
| 1638 | "A String", |
| 1639 | ], |
| 1640 | "processingWarnings": [ # A list of reasons why YouTube may have difficulty transcoding the uploaded video or that might result in an erroneous transcoding. These warnings are generated before YouTube actually processes the uploaded video file. In addition, they identify issues that are unlikely to cause the video processing to fail but that might cause problems such as sync issues, video artifacts, or a missing audio track. |
| 1641 | "A String", |
| 1642 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1643 | "tagSuggestions": [ # A list of keyword tags that could be added to the video's metadata to increase the likelihood that users will locate your video when searching or browsing on YouTube. |
| 1644 | { # A single tag suggestion with it's relevance information. |
| 1645 | "tag": "A String", # The keyword tag suggested for the video. |
| 1646 | "categoryRestricts": [ # A set of video categories for which the tag is relevant. You can use this information to display appropriate tag suggestions based on the video category that the video uploader associates with the video. By default, tag suggestions are relevant for all categories if there are no restricts defined for the keyword. |
| 1647 | "A String", |
| 1648 | ], |
| 1649 | }, |
| 1650 | ], |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1651 | "processingHints": [ # A list of suggestions that may improve YouTube's ability to process the video. |
| 1652 | "A String", |
| 1653 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1654 | }, |
| 1655 | "etag": "A String", # Etag of this resource. |
| 1656 | "recordingDetails": { # Recording information associated with the video. # The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
| 1657 | "location": { # Geographical coordinates of a point, in WGS84. # The geolocation information associated with the video. |
| 1658 | "latitude": 3.14, # Latitude in degrees. |
| 1659 | "longitude": 3.14, # Longitude in degrees. |
| 1660 | "altitude": 3.14, # Altitude above the reference ellipsoid, in meters. |
| 1661 | }, |
| 1662 | "recordingDate": "A String", # The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
| 1663 | "locationDescription": "A String", # The text description of the location where the video was recorded. |
| 1664 | }, |
| 1665 | "snippet": { # Basic details about a video, including title, description, uploader, thumbnails and category. # The snippet object contains basic details about the video, such as its title, description, and category. |
| 1666 | "thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail. |
| 1667 | "maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource. |
| 1668 | "url": "A String", # The thumbnail image's URL. |
| 1669 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1670 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1671 | }, |
| 1672 | "standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource. |
| 1673 | "url": "A String", # The thumbnail image's URL. |
| 1674 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1675 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1676 | }, |
| 1677 | "default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource. |
| 1678 | "url": "A String", # The thumbnail image's URL. |
| 1679 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1680 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1681 | }, |
| 1682 | "high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource. |
| 1683 | "url": "A String", # The thumbnail image's URL. |
| 1684 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1685 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1686 | }, |
| 1687 | "medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource. |
| 1688 | "url": "A String", # The thumbnail image's URL. |
| 1689 | "width": 42, # (Optional) Width of the thumbnail image. |
| 1690 | "height": 42, # (Optional) Height of the thumbnail image. |
| 1691 | }, |
| 1692 | }, |
| 1693 | "localized": { # Localized versions of certain video properties (e.g. title). # Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only) |
| 1694 | "title": "A String", # Localized version of the video's title. |
| 1695 | "description": "A String", # Localized version of the video's description. |
| 1696 | }, |
| 1697 | "liveBroadcastContent": "A String", # Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast. |
| 1698 | "defaultAudioLanguage": "A String", # The default_audio_language property specifies the language spoken in the video's default audio track. |
| 1699 | "categoryId": "A String", # The YouTube video category associated with the video. |
| 1700 | "description": "A String", # The video's description. @mutable youtube.videos.insert youtube.videos.update |
| 1701 | "tags": [ # A list of keyword tags associated with the video. Tags may contain spaces. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1702 | "A String", |
| 1703 | ], |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1704 | "channelId": "A String", # The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
| 1705 | "title": "A String", # The video's title. @mutable youtube.videos.insert youtube.videos.update |
| 1706 | "channelTitle": "A String", # Channel title for the channel that the video belongs to. |
| 1707 | "publishedAt": "A String", # The date and time that the video was uploaded. The value is specified in ISO 8601 format. |
| 1708 | "defaultLanguage": "A String", # The language of the videos's default snippet. |
| 1709 | }, |
| 1710 | "player": { # Player to be used for a video playback. # The player object contains information that you would use to play the video in an embedded player. |
| 1711 | "embedHeight": "A String", |
| 1712 | "embedHtml": "A String", # An <iframe> tag that embeds a player that will play the video. |
| 1713 | "embedWidth": "A String", # The embed width |
| 1714 | }, |
| 1715 | "monetizationDetails": { # Details about monetization of a YouTube Video. # The monetizationDetails object encapsulates information about the monetization status of the video. |
| 1716 | "access": { # Rights management policy for YouTube resources. # The value of access indicates whether the video can be monetized or not. |
| 1717 | "allowed": True or False, # The value of allowed indicates whether the access to the policy is allowed or denied by default. |
| 1718 | "exception": [ # A list of region codes that identify countries where the default policy do not apply. |
| 1719 | "A String", |
| 1720 | ], |
| 1721 | }, |
| 1722 | }, |
| 1723 | "projectDetails": { # Project specific details about the content of a YouTube Video. # The projectDetails object contains information about the project specific video metadata. |
| 1724 | "tags": [ # A list of project tags associated with the video during the upload. |
Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1725 | "A String", |
| 1726 | ], |
| 1727 | }, |
Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 1728 | "processingDetails": { # Describes processing status and progress and availability of some other Video resource parts. # The processingDetails object encapsulates information about YouTube's progress in processing the uploaded video file. The properties in the object identify the current processing status and an estimate of the time remaining until YouTube finishes processing the video. This part also indicates whether different types of data or content, such as file details or thumbnail images, are available for the video. The processingProgress object is designed to be polled so that the video uploaded can track the progress that YouTube has made in processing the uploaded video file. This data can only be retrieved by the video owner. |
| 1729 | "processingFailureReason": "A String", # The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed. |
| 1730 | "thumbnailsAvailability": "A String", # This value indicates whether thumbnail images have been generated for the video. |
| 1731 | "processingStatus": "A String", # The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed. |
| 1732 | "processingIssuesAvailability": "A String", # This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1733 | "processingProgress": { # Video processing progress and completion time estimate. # The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing. |
| 1734 | "partsTotal": "A String", # An estimate of the total number of parts that need to be processed for the video. The number may be updated with more precise estimates while YouTube processes the video. |
| 1735 | "partsProcessed": "A String", # The number of parts of the video that YouTube has already processed. You can estimate the percentage of the video that YouTube has already processed by calculating: 100 * parts_processed / parts_total Note that since the estimated number of parts could increase without a corresponding increase in the number of parts that have already been processed, it is possible that the calculated progress could periodically decrease while YouTube processes a video. |
| 1736 | "timeLeftMs": "A String", # An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
| 1737 | }, |
| 1738 | "tagSuggestionsAvailability": "A String", # This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1739 | "editorSuggestionsAvailability": "A String", # This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request. |
| 1740 | "fileDetailsAvailability": "A String", # This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request. |
| 1741 | }, |
| 1742 | "localizations": { # The localizations object contains localized versions of the basic details about the video, such as its title and description. |
| 1743 | "a_key": { # Localized versions of certain video properties (e.g. title). |
| 1744 | "title": "A String", # Localized version of the video's title. |
| 1745 | "description": "A String", # Localized version of the video's description. |
| 1746 | }, |
| 1747 | }, |
| 1748 | "status": { # Basic details about a video category, such as its localized title. Next Id: 17 # The status object contains information about the video's uploading, processing, and privacy statuses. |
| 1749 | "license": "A String", # The video's license. @mutable youtube.videos.insert youtube.videos.update |
| 1750 | "rejectionReason": "A String", # This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. |
| 1751 | "selfDeclaredMadeForKids": True or False, |
| 1752 | "failureReason": "A String", # This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed. |
| 1753 | "embeddable": True or False, # This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update |
| 1754 | "publicStatsViewable": True or False, # This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update |
| 1755 | "madeForKids": True or False, |
| 1756 | "privacyStatus": "A String", # The video's privacy status. |
| 1757 | "publishAt": "A String", # The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 format. |
| 1758 | "uploadStatus": "A String", # The status of the uploaded video. |
Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1759 | }, |
John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1760 | }</pre> |
| 1761 | </div> |
| 1762 | |
| 1763 | </body></html> |