All videos uploaded via the
videos.insert
endpoint from unverified API projects created after 28 July 2020 will be restricted to private
viewing mode. To lift this restriction, each API project must
undergo an audit to verify
compliance with the Terms of
Service. Please see the API
Revision History for more details.
A video
resource represents a YouTube video.
Methods
The API supports the following methods for videos
resources:
- getRating
- Retrieves the ratings that the authorized user gave to a list of specified videos. Try it now.
- list
- Returns a list of videos that match the API request parameters. Try it now.
- insert
- Uploads a video to YouTube and optionally sets the video's metadata.
- update
- Updates a video's metadata. Try it now.
- delete
- Deletes a YouTube video. Try it now.
- rate
- Add a like or dislike rating to a video or remove a rating from a video. Try it now.
- reportAbuse
- Report a video for containing abusive content. Try it now.
Resource representation
The following JSON structure shows the format of a videos
resource:
{ "kind": "youtube#video", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "tags": [ string ], "categoryId": string, "liveBroadcastContent": string, "defaultLanguage": string, "localized": { "title": string, "description": string }, "defaultAudioLanguage": string }, "contentDetails": { "duration": string, "dimension": string, "definition": string, "caption": string, "licensedContent": boolean, "regionRestriction": { "allowed": [ string ], "blocked": [ string ] }, "contentRating": { "acbRating": string, "agcomRating": string, "anatelRating": string, "bbfcRating": string, "bfvcRating": string, "bmukkRating": string, "catvRating": string, "catvfrRating": string, "cbfcRating": string, "cccRating": string, "cceRating": string, "chfilmRating": string, "chvrsRating": string, "cicfRating": string, "cnaRating": string, "cncRating": string, "csaRating": string, "cscfRating": string, "czfilmRating": string, "djctqRating": string, "djctqRatingReasons": [, string ], "ecbmctRating": string, "eefilmRating": string, "egfilmRating": string, "eirinRating": string, "fcbmRating": string, "fcoRating": string, "fmocRating": string, "fpbRating": string, "fpbRatingReasons": [, string ], "fskRating": string, "grfilmRating": string, "icaaRating": string, "ifcoRating": string, "ilfilmRating": string, "incaaRating": string, "kfcbRating": string, "kijkwijzerRating": string, "kmrbRating": string, "lsfRating": string, "mccaaRating": string, "mccypRating": string, "mcstRating": string, "mdaRating": string, "medietilsynetRating": string, "mekuRating": string, "mibacRating": string, "mocRating": string, "moctwRating": string, "mpaaRating": string, "mpaatRating": string, "mtrcbRating": string, "nbcRating": string, "nbcplRating": string, "nfrcRating": string, "nfvcbRating": string, "nkclvRating": string, "oflcRating": string, "pefilmRating": string, "rcnofRating": string, "resorteviolenciaRating": string, "rtcRating": string, "rteRating": string, "russiaRating": string, "skfilmRating": string, "smaisRating": string, "smsaRating": string, "tvpgRating": string, "ytRating": string }, "projection": string, "hasCustomThumbnail": boolean }, "status": { "uploadStatus": string, "failureReason": string, "rejectionReason": string, "privacyStatus": string, "publishAt": datetime, "license": string, "embeddable": boolean, "publicStatsViewable": boolean, "madeForKids": boolean, "selfDeclaredMadeForKids": boolean, "containsSyntheticMedia": boolean }, "statistics": { "viewCount": string, "likeCount": string, "dislikeCount": string, "favoriteCount": string, "commentCount": string }, "paidProductPlacementDetails": { "hasPaidProductPlacement": boolean }, "player": { "embedHtml": string, "embedHeight": long, "embedWidth": long }, "topicDetails": { "topicIds": [ string ], "relevantTopicIds": [ string ], "topicCategories": [ string ] }, "recordingDetails": { "recordingDate": datetime }, "fileDetails": { "fileName": string, "fileSize": unsigned long, "fileType": string, "container": string, "videoStreams": [ { "widthPixels": unsigned integer, "heightPixels": unsigned integer, "frameRateFps": double, "aspectRatio": double, "codec": string, "bitrateBps": unsigned long, "rotation": string, "vendor": string } ], "audioStreams": [ { "channelCount": unsigned integer, "codec": string, "bitrateBps": unsigned long, "vendor": string } ], "durationMs": unsigned long, "bitrateBps": unsigned long, "creationTime": string }, "processingDetails": { "processingStatus": string, "processingProgress": { "partsTotal": unsigned long, "partsProcessed": unsigned long, "timeLeftMs": unsigned long }, "processingFailureReason": string, "fileDetailsAvailability": string, "processingIssuesAvailability": string, "tagSuggestionsAvailability": string, "editorSuggestionsAvailability": string, "thumbnailsAvailability": string }, "suggestions": { "processingErrors": [ string ], "processingWarnings": [ string ], "processingHints": [ string ], "tagSuggestions": [ { "tag": string, "categoryRestricts": [ string ] } ], "editorSuggestions": [ string ] }, "liveStreamingDetails": { "actualStartTime": datetime, "actualEndTime": datetime, "scheduledStartTime": datetime, "scheduledEndTime": datetime, "concurrentViewers": unsigned long, "activeLiveChatId": string }, "localizations": { (key): { "title": string, "description": string } } }
Properties
The following table defines the properties that appear in this resource:
Properties | |
---|---|
kind |
string Identifies the API resource's type. The value will be youtube#video . |
etag |
etag The Etag of this resource. |
id |
string The ID that YouTube uses to uniquely identify the video. |
snippet |
object The snippet object contains basic details about the video, such as its title, description, and category. |
snippet.publishedAt |
datetime The date and time that the video was published. Note that this time might be different than the time that the video was uploaded. For example, if a video is uploaded as a private video and then made public at a later time, this property will specify the time that the video was made public. There are a couple of special cases:
|
snippet.channelId |
string The ID that YouTube uses to uniquely identify the channel that the video was uploaded to. |
snippet.title |
string The video's title. The property value has a maximum length of 100 characters and may contain all valid UTF-8 characters except < and >. You must set a value for this property if you call the videos.update method and are updating the snippet part of a video resource. |
snippet.description |
string The video's description. The property value has a maximum length of 5000 bytes and may contain all valid UTF-8 characters except < and >. |
snippet.thumbnails |
object 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. |
snippet.thumbnails.(key) |
object Valid key values are:
|
snippet.thumbnails.(key).url |
string The image's URL. |
snippet.thumbnails.(key).width |
unsigned integer The image's width. |
snippet.thumbnails.(key).height |
unsigned integer The image's height. |
snippet.channelTitle |
string Channel title for the channel that the video belongs to. |
snippet.tags[] |
list A list of keyword tags associated with the video. Tags may contain spaces. The property value has a maximum length of 500 characters. Note the following rules regarding the way the character limit is calculated:
|
snippet.categoryId |
string The YouTube video category associated with the video. You must set a value for this property if you call the videos.update method and are updating the snippet part of a video resource. |
snippet.liveBroadcastContent |
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. Valid values for this property are:
|
snippet.defaultLanguage |
string The language of the text in the video resource's snippet.title and snippet.description properties. |
snippet.localized |
object The snippet.localized object contains either a localized title and description for the video or the title in the default language for the video's metadata.
localizations object to add, update, or delete localized titles. |
snippet.localized.title |
string The localized video title. |
snippet.localized.description |
string The localized video description. |
snippet.defaultAudioLanguage |
string The default_audio_language property specifies the language spoken in the video's default audio track. |
contentDetails |
object The contentDetails object contains information about the video content, including the length of the video and an indication of whether captions are available for the video. |
contentDetails.duration |
string The length of the video. The property value is an ISO 8601 duration. For example, for a video that is at least one minute long and less than one hour long, the duration is 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 PT15M33S indicates that the video is 15 minutes and 33 seconds long.If the video is at least one hour long, the duration is in the format PT#H#M#S , in which the # preceding the letter H specifies the length of the video in hours and all of the other details are the same as described above. If the video is at least one day long, the letters P and T are separated, and the value's format is P#DT#H#M#S . Please refer to the ISO 8601 specification for complete details. |
contentDetails.dimension |
string Indicates whether the video is available in 3D or in 2D. |
contentDetails.definition |
string Indicates whether the video is available in high definition ( HD ) or only in standard definition.Valid values for this property are:
|
contentDetails.caption |
string Indicates whether captions are available for the video. Valid values for this property are:
|
contentDetails.licensedContent |
boolean Indicates whether the video represents licensed content, which means that the content was uploaded to a channel linked to a YouTube content partner and then claimed by that partner. |
contentDetails.regionRestriction |
object 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. |
contentDetails.regionRestriction.allowed[] |
list 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. |
contentDetails.regionRestriction.blocked[] |
list 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. |
contentDetails.contentRating |
object Specifies the ratings that the video received under various rating schemes. |
contentDetails.contentRating.acbRating |
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. Valid values for this property are:
|
contentDetails.contentRating.agcomRating |
string The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM). Valid values for this property are:
|
contentDetails.contentRating.anatelRating |
string The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television. Valid values for this property are:
|
contentDetails.contentRating.bbfcRating |
string The video's British Board of Film Classification (BBFC) rating. Valid values for this property are:
|
contentDetails.contentRating.bfvcRating |
string The video's rating from Thailand's Board of Film and Video Censors. Valid values for this property are:
|
contentDetails.contentRating.bmukkRating |
string The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur). Valid values for this property are:
|
contentDetails.contentRating.catvRating |
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. Valid values for this property are:
|
contentDetails.contentRating.catvfrRating |
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. Valid values for this property are:
|
contentDetails.contentRating.cbfcRating |
string The video's Central Board of Film Certification (CBFC - India) rating. Valid values for this property are:
|
contentDetails.contentRating.cccRating |
string The video's Consejo de Calificación Cinematográfica (Chile) rating. Valid values for this property are:
|
contentDetails.contentRating.cceRating |
string The video's rating from Portugal's Comissão de Classificação de Espect´culos. Valid values for this property are:
|
contentDetails.contentRating.chfilmRating |
string The video's rating in Switzerland. Valid values for this property are:
|
contentDetails.contentRating.chvrsRating |
string The video's Canadian Home Video Rating System (CHVRS) rating. Valid values for this property are:
|
contentDetails.contentRating.cicfRating |
string The video's rating from the Commission de Contrôle des Films (Belgium). Valid values for this property are:
|
contentDetails.contentRating.cnaRating |
string The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA). Valid values for this property are:
|
contentDetails.contentRating.cncRating |
string Rating system in France - Commission de classification cinematographique Valid values for this property are:
|
contentDetails.contentRating.csaRating |
string The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content. Valid values for this property are:
|
contentDetails.contentRating.cscfRating |
string The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF). Valid values for this property are:
|
contentDetails.contentRating.czfilmRating |
string The video's rating in the Czech Republic. Valid values for this property are:
|
contentDetails.contentRating.djctqRating |
string The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating. Valid values for this property are:
|
contentDetails.contentRating.djctqRatingReasons[] |
list Reasons that explain why the video received its DJCQT (Brazil) rating. |
contentDetails.contentRating.ecbmctRating |
string Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism Valid values for this property are:
|
contentDetails.contentRating.eefilmRating |
string The video's rating in Estonia. Valid values for this property are:
|
contentDetails.contentRating.egfilmRating |
string The video's rating in Egypt. Valid values for this property are:
|
contentDetails.contentRating.eirinRating |
string The video's Eirin (映倫) rating. Eirin is the Japanese rating system. Valid values for this property are:
|
contentDetails.contentRating.fcbmRating |
string The video's rating from Malaysia's Film Censorship Board. Valid values for this property are:
|
contentDetails.contentRating.fcoRating |
string The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration. Valid values for this property are:
|
contentDetails.contentRating.fmocRating |
string This property has been deprecated as of November 2, 2015. Use the contentDetails.contentRating.cncRating property instead.The video's Centre national du cinéma et de l'image animé (French Ministry of Culture) rating. Valid values for this property are:
|
contentDetails.contentRating.fpbRating |
string The video's rating from South Africa's Film and Publication Board. Valid values for this property are:
|
contentDetails.contentRating.fpbRatingReasons[] |
list Reasons that explain why the video received its FPB (South Africa) rating. |
contentDetails.contentRating.fskRating |
string The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating. Valid values for this property are:
|
contentDetails.contentRating.grfilmRating |
string The video's rating in Greece. Valid values for this property are:
|
contentDetails.contentRating.icaaRating |
string The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating. Valid values for this property are:
|
contentDetails.contentRating.ifcoRating |
string The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information. Valid values for this property are:
|
contentDetails.contentRating.ilfilmRating |
string The video's rating in Israel. Valid values for this property are:
|
contentDetails.contentRating.incaaRating |
string The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating. Valid values for this property are:
|
contentDetails.contentRating.kfcbRating |
string The video's rating from the Kenya Film Classification Board. Valid values for this property are:
|
contentDetails.contentRating.kijkwijzerRating |
string voor de Classificatie van Audiovisuele Media (Netherlands). Valid values for this property are:
|
contentDetails.contentRating.kmrbRating |
string The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea. Valid values for this property are:
|
contentDetails.contentRating.lsfRating |
string The video's rating from Indonesia's Lembaga Sensor Film. Valid values for this property are:
|
contentDetails.contentRating.mccaaRating |
string The video's rating from Malta's Film Age-Classification Board. Valid values for this property are:
|
contentDetails.contentRating.mccypRating |
string The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People. Valid values for this property are:
|
contentDetails.contentRating.mcstRating |
string The video's rating system for Vietnam - MCST Valid values for this property are:
|
contentDetails.contentRating.mdaRating |
string The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC). Valid values for this property are:
|
contentDetails.contentRating.medietilsynetRating |
string The video's rating from Medietilsynet, the Norwegian Media Authority. Valid values for this property are:
|
contentDetails.contentRating.mekuRating |
string The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute). Valid values for this property are:
|
contentDetails.contentRating.mibacRating |
string The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy). Valid values for this property are:
|
contentDetails.contentRating.mocRating |
string The video's Ministerio de Cultura (Colombia) rating. Valid values for this property are:
|
contentDetails.contentRating.moctwRating |
string The video's rating from Taiwan's Ministry of Culture (文化部). Valid values for this property are:
|
contentDetails.contentRating.mpaaRating |
string The video's Motion Picture Association of America (MPAA) rating. Valid values for this property are:
|
contentDetails.contentRating.mpaatRating |
string The Motion Picture Association of America's rating for movie trailers and preview. Valid values for this property are:
|
contentDetails.contentRating.mtrcbRating |
string The video's rating from the Movie and Television Review and Classification Board (Philippines). Valid values for this property are:
|
contentDetails.contentRating.nbcRating |
string The video's rating from the Maldives National Bureau of Classification. Valid values for this property are:
|
contentDetails.contentRating.nfrcRating |
string The video's rating from the Bulgarian National Film Center. Valid values for this property are:
|
contentDetails.contentRating.nfvcbRating |
string The video's rating from Nigeria's National Film and Video Censors Board. Valid values for this property are:
|
contentDetails.contentRating.nkclvRating |
string The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia). Valid values for this property are:
|
contentDetails.contentRating.oflcRating |
string The video's Office of Film and Literature Classification (OFLC - New Zealand) rating. Valid values for this property are:
|
contentDetails.contentRating.pefilmRating |
string The video's rating in Peru. Valid values for this property are:
|
contentDetails.contentRating.resorteviolenciaRating |
string The video's rating in Venezuela. Valid values for this property are:
|
contentDetails.contentRating.rtcRating |
string The video's General Directorate of Radio, Television and Cinematography (Mexico) rating. Valid values for this property are:
|
contentDetails.contentRating.rteRating |
string The video's rating from Ireland's Raidió Teilifís Éireann. Valid values for this property are:
|
contentDetails.contentRating.russiaRating |
string The video's National Film Registry of the Russian Federation (MKRF - Russia) rating. Valid values for this property are:
|
contentDetails.contentRating.skfilmRating |
string The video's rating in Slovakia. Valid values for this property are:
|
contentDetails.contentRating.smaisRating |
string The video's rating in Iceland. Valid values for this property are:
|
contentDetails.contentRating.smsaRating |
string The video's rating from Statens medieråd (Sweden's National Media Council). Valid values for this property are:
|
contentDetails.contentRating.tvpgRating |
string The video's TV Parental Guidelines (TVPG) rating. Valid values for this property are:
|
contentDetails.contentRating.ytRating |
string A rating that YouTube uses to identify age-restricted content. Valid values for this property are:
|
contentDetails.projection |
string Specifies the projection format of the video. Valid values for this property are:
|
contentDetails.hasCustomThumbnail |
boolean Indicates whether the video uploader has provided a custom thumbnail image for the video. This property is only visible to the video uploader. |
status |
object The status object contains information about the video's uploading, processing, and privacy statuses. |
status.uploadStatus |
string The status of the uploaded video. Valid values for this property are:
|
status.failureReason |
string This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.Valid values for this property are:
|
status.rejectionReason |
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.Valid values for this property are:
|
status.privacyStatus |
string The video's privacy status. Valid values for this property are:
|
status.publishAt |
datetime 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. Note the following two additional points about this property's behavior:
|
status.license |
string The video's license. Valid values for this property are:
|
status.embeddable |
boolean This value indicates whether the video can be embedded on another website. |
status.publicStatsViewable |
boolean This value indicates whether the extended video statistics on the video's watch page are publicly viewable. By default, those statistics are viewable, and statistics like a video's viewcount and ratings will still be publicly visible even if this property's value is set to false . |
status.madeForKids |
boolean This value indicates whether the video is designated as child-directed, and it contains the current "made for kids" status of the video. For example, the status might be determined based on the value of the selfDeclaredMadeForKids property. See the
YouTube Help Center for more
information about setting the audience for your channel, videos, or broadcasts.
|
status.selfDeclaredMadeForKids |
boolean In a videos.insert or
videos.update request, this
property allows the channel owner to designate the video as being child-directed. In a
videos.list request, the property
value is only returned if the channel owner authorized the API request. |
status.containsSyntheticMedia |
boolean In a videos.insert or
videos.update request, this
property allows the channel owner to disclose that a video contains realistic Altered or
Synthetic (A/S) content. Learn more about
YouTube
policies related to A/S content.Examples of A/S content include videos that:
|
statistics |
object The statistics object contains statistics about the video. |
statistics.viewCount |
unsigned long The number of times the video has been viewed. |
statistics.likeCount |
unsigned long The number of users who have indicated that they liked the video. |
statistics.dislikeCount |
unsigned long Note: The
statistics.dislikeCount property was
made private as of December 13, 2021. This means that the property is included in an API
response only if the API request was authenticated by the video owner. See the
revision history for more information.The number of users who have indicated that they disliked the video. |
statistics.favoriteCount |
unsigned long Note: This property has been deprecated. The deprecation is effective as of August 28, 2015. The property's value is now always set to 0 . |
statistics.commentCount |
unsigned long The number of comments for the video. |
paidProductPlacementDetails |
object The paidProductPlacementDetails object contains information about paid product placement in the video. |
paidProductPlacementDetails.hasPaidProductPlacement |
boolean Set to true if the content uses paid product placement. Defaults to false . |
player |
object The player object contains information that you would use to play the video in an embedded player. |
player.embedHtml |
string An <iframe> tag that embeds a player that plays the video. |
player.embedHeight |
long The height of the embedded player returned in the player.embedHtml property. This property is only returned if the request specified a value for the maxHeight and/or maxWidth parameters and the video's aspect ratio is known. |
player.embedWidth |
long The width of the embedded player returned in the player.embedHtml property. This property is only returned if the request specified a value for the maxHeight and/or maxWidth parameters and the video's aspect ratio is known. |
topicDetails |
object The topicDetails object encapsulates information about topics associated with the video.Important: See the definitions of the topicDetails.relevantTopicIds[] and topicDetails.topicIds[] properties as well as the revision history for more details about upcoming changes related to topic IDs. |
topicDetails.topicIds[] |
list Important: This property has been deprecated as of November 10, 2016. The API no longer returns values for this property, and any topics associated with a video are now returned by the topicDetails.relevantTopicIds[] property value. |
topicDetails.relevantTopicIds[] |
list A list of topic IDs that are relevant to the video. This property has been deprecated as of November 10, 2016. It will be supported until November 10, 2017. Important: Due to the deprecation of Freebase and the Freebase API, topic IDs started working differently as of February 27, 2017. At that time, YouTube started returning a small set of curated topic IDs. |
topicDetails.topicCategories[] |
list A list of Wikipedia URLs that provide a high-level description of the video's content. |
recordingDetails |
object The recordingDetails object encapsulates information about the location, date and address where the video was recorded. |
recordingDetails.locationDescription |
string This property has been deprecated as of June 1, 2017. Please see the deprecation announcement for more details. The text description of the location where the video was recorded. |
recordingDetails.location |
object The geolocation information associated with the video. Note that the child property values identify the location that the video owner wants to associate with the video. The value is editable, searchable on public videos, and might be displayed to users for public videos. |
recordingDetails.location.latitude |
double This property has been deprecated as of June 1, 2017. Please see the deprecation announcement for more details. Latitude in degrees. |
recordingDetails.location.longitude |
double This property has been deprecated as of June 1, 2017. Please see the deprecation announcement for more details. Longitude in degrees. |
recordingDetails.location.altitude |
double This property has been deprecated as of July 9, 2018. Please see the deprecation announcement for more details. Altitude above the reference ellipsoid, in meters. |
recordingDetails.recordingDate |
datetime The date and time when the video was recorded. The value is specified in ISO 8601 ( YYYY-MM-DDThh:mm:ss.sssZ ) format. |
fileDetails |
object 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.The fileDetails object will only be returned if the processingDetails.fileAvailability property has a value of available . |
fileDetails.fileName |
string The uploaded file's name. This field is present whether a video file or another type of file was uploaded. |
fileDetails.fileSize |
unsigned long The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded. |
fileDetails.fileType |
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. Valid values for this property are:
|
fileDetails.container |
string The uploaded video file's container format. |
fileDetails.videoStreams[] |
list A list of video streams contained in the uploaded video file. Each item in the list contains detailed metadata about a video stream. |
fileDetails.videoStreams[].widthPixels |
unsigned integer The encoded video content's width in pixels. You can calculate the video's encoding aspect ratio as width_pixels / height_pixels . |
fileDetails.videoStreams[].heightPixels |
unsigned integer The encoded video content's height in pixels. |
fileDetails.videoStreams[].frameRateFps |
double The video stream's frame rate, in frames per second. |
fileDetails.videoStreams[].aspectRatio |
double The video content's display aspect ratio, which specifies the aspect ratio in which the video should be displayed. |
fileDetails.videoStreams[].codec |
string The video codec that the stream uses. |
fileDetails.videoStreams[].bitrateBps |
unsigned long The video stream's bitrate, in bits per second. |
fileDetails.videoStreams[].rotation |
string The amount that YouTube needs to rotate the original source content to properly display the video. Valid values for this property are:
|
fileDetails.videoStreams[].vendor |
string A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
fileDetails.audioStreams[] |
list A list of audio streams contained in the uploaded video file. Each item in the list contains detailed metadata about an audio stream. |
fileDetails.audioStreams[].channelCount |
unsigned integer The number of audio channels that the stream contains. |
fileDetails.audioStreams[].codec |
string The audio codec that the stream uses. |
fileDetails.audioStreams[].bitrateBps |
unsigned long The audio stream's bitrate, in bits per second. |
fileDetails.audioStreams[].vendor |
string A value that uniquely identifies a video vendor. Typically, the value is a four-letter vendor code. |
fileDetails.durationMs |
unsigned long The length of the uploaded video in milliseconds. |
fileDetails.bitrateBps |
unsigned long The uploaded video file's combined (video and audio) bitrate in bits per second. |
fileDetails.creationTime |
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:
|
processingDetails |
object 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. |
processingDetails.processingStatus |
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. Valid values for this property are:
|
processingDetails.processingProgress |
object 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 . |
processingDetails.processingProgress.partsTotal |
unsigned long 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. |
processingDetails.processingProgress.partsProcessed |
unsigned long 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. |
processingDetails.processingProgress.timeLeftMs |
unsigned long An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video. |
processingDetails.processingFailureReason |
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 .Valid values for this property are:
|
processingDetails.fileDetailsAvailability |
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. |
processingDetails.processingIssuesAvailability |
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. |
processingDetails.tagSuggestionsAvailability |
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. |
processingDetails.editorSuggestionsAvailability |
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. |
processingDetails.thumbnailsAvailability |
string This value indicates whether thumbnail images have been generated for the video. |
suggestions |
object 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. The suggestions object will only be returned if the processingDetails.tagSuggestionsAvailability property or the processingDetails.editorSuggestionsAvailability property has a value of available . |
suggestions.processingErrors[] |
list A list of errors that will prevent YouTube from successfully processing the uploaded video. These errors indicate that, regardless of the video's current processing status, eventually, that status will almost certainly be failed .Valid values for this property are:
|
suggestions.processingWarnings[] |
list 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 do not necessarily indicate that video processing will fail but that still might cause problems such as sync issues, video artifacts, or a missing audio track. Valid values for this property are:
|
suggestions.processingHints[] |
list A list of suggestions that may improve YouTube's ability to process the video. Valid values for this property are:
|
suggestions.tagSuggestions[] |
list 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. |
suggestions.tagSuggestions[].tag |
string The keyword tag suggested for the video. |
suggestions.tagSuggestions[].categoryRestricts[] |
list 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. |
suggestions.editorSuggestions[] |
list A list of video editing operations that might improve the video quality or playback experience of the uploaded video. Valid values for this property are:
|
liveStreamingDetails |
object 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. |
liveStreamingDetails.actualStartTime |
datetime 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. |
liveStreamingDetails.actualEndTime |
datetime 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. |
liveStreamingDetails.scheduledStartTime |
datetime The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 format. |
liveStreamingDetails.scheduledEndTime |
datetime 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. |
liveStreamingDetails.concurrentViewers |
unsigned long 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. The concurrent viewer counts that the YouTube Data API returns might
differ from the processed, despammed concurrent viewer counts available through YouTube
Analytics. Learn more about live streaming metrics in the
YouTube Help Center.
|
liveStreamingDetails.activeLiveChatId |
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. |
localizations |
object The localizations object contains translations of the video's metadata. |
localizations.(key) |
object The language of the localized text associated with the key value. The value is a string that contains a BCP-47 language code. |
localizations.(key).title |
string The localized video title. |
localizations.(key).description |
string The localized video description. |