List
|
|||||
|
|
Returns a list of videos that match the API request parameters
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View your YouTube account
- View and manage your assets and associated content on YouTube
Input
This building block consumes 13 input parameters
Name | Format | Description |
---|---|---|
part Required |
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 |
chart |
ENUMERATION |
The chart parameter identifies the chart that you want to retrieve |
hl |
STRING |
The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language |
id |
STRING |
The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID |
locale |
STRING |
DEPRECATED |
maxHeight |
INTEGER |
The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request |
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 |
maxWidth |
INTEGER |
The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request |
myRating |
ENUMERATION |
Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user |
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 |
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 |
regionCode |
STRING |
The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code |
videoCategoryId |
STRING |
The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category |
= Parameter name
= Format
part STRING Required 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 |
chart ENUMERATION The chart parameter identifies the chart that you want to retrieve |
hl STRING The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method. If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language |
id STRING The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) that are being retrieved. In a video resource, the id property specifies the video's ID |
locale STRING DEPRECATED |
maxHeight INTEGER The maxHeight parameter specifies a maximum height of the embedded player. If maxWidth is provided, maxHeight may not be reached in order to not violate the width request |
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 |
maxWidth INTEGER The maxWidth parameter specifies a maximum width of the embedded player. If maxHeight is provided, maxWidth may not be reached in order to not violate the height request |
myRating ENUMERATION Set this parameter's value to like or dislike to instruct the API to only return videos liked or disliked by the authenticated user |
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 |
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 |
regionCode STRING The regionCode parameter instructs the API to select a video chart available in the specified region. This parameter can only be used in conjunction with the chart parameter. The parameter value is an ISO 3166-1 alpha-2 country code |
videoCategoryId STRING The videoCategoryId parameter identifies the video category for which the chart should be retrieved. This parameter can only be used in conjunction with the chart parameter. By default, charts are not restricted to a particular category |
Output
This building block provides 193 output parameters
Name | Format | Description |
---|---|---|
etag |
STRING |
Etag of this resource |
eventId |
STRING |
Serialized EventId of the request which produced this response |
items[] |
OBJECT |
A video resource represents a YouTube video |
items[].ageGating |
OBJECT |
|
items[].ageGating.alcoholContent |
BOOLEAN |
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 |
items[].ageGating.restricted |
BOOLEAN |
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 |
items[].ageGating.videoGameRating |
ENUMERATION |
Video game rating, if any |
items[].contentDetails |
OBJECT |
Details about the content of a YouTube Video |
items[].contentDetails.caption |
ENUMERATION |
The value of captions indicates whether the video has captions or not |
items[].contentDetails.contentRating |
OBJECT |
Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 71 |
items[].contentDetails.contentRating.acbRating |
ENUMERATION |
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 |
items[].contentDetails.contentRating.agcomRating |
ENUMERATION |
The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM) |
items[].contentDetails.contentRating.anatelRating |
ENUMERATION |
The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television |
items[].contentDetails.contentRating.bbfcRating |
ENUMERATION |
The video's British Board of Film Classification (BBFC) rating |
items[].contentDetails.contentRating.bfvcRating |
ENUMERATION |
The video's rating from Thailand's Board of Film and Video Censors |
items[].contentDetails.contentRating.bmukkRating |
ENUMERATION |
The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur) |
items[].contentDetails.contentRating.catvRating |
ENUMERATION |
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 |
items[].contentDetails.contentRating.catvfrRating |
ENUMERATION |
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 |
items[].contentDetails.contentRating.cbfcRating |
ENUMERATION |
The video's Central Board of Film Certification (CBFC - India) rating |
items[].contentDetails.contentRating.cccRating |
ENUMERATION |
The video's Consejo de Calificación Cinematográfica (Chile) rating |
items[].contentDetails.contentRating.cceRating |
ENUMERATION |
The video's rating from Portugal's Comissão de Classificação de Espect´culos |
items[].contentDetails.contentRating.chfilmRating |
ENUMERATION |
The video's rating in Switzerland |
items[].contentDetails.contentRating.chvrsRating |
ENUMERATION |
The video's Canadian Home Video Rating System (CHVRS) rating |
items[].contentDetails.contentRating.cicfRating |
ENUMERATION |
The video's rating from the Commission de Contrôle des Films (Belgium) |
items[].contentDetails.contentRating.cnaRating |
ENUMERATION |
The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA) |
items[].contentDetails.contentRating.cncRating |
ENUMERATION |
Rating system in France - Commission de classification cinematographique |
items[].contentDetails.contentRating.csaRating |
ENUMERATION |
The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content |
items[].contentDetails.contentRating.cscfRating |
ENUMERATION |
The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF) |
items[].contentDetails.contentRating.czfilmRating |
ENUMERATION |
The video's rating in the Czech Republic |
items[].contentDetails.contentRating.djctqRating |
ENUMERATION |
The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating |
items[].contentDetails.contentRating.djctqRatingReasons[] |
ENUMERATION |
|
items[].contentDetails.contentRating.ecbmctRating |
ENUMERATION |
Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
items[].contentDetails.contentRating.eefilmRating |
ENUMERATION |
The video's rating in Estonia |
items[].contentDetails.contentRating.egfilmRating |
ENUMERATION |
The video's rating in Egypt |
items[].contentDetails.contentRating.eirinRating |
ENUMERATION |
The video's Eirin (映倫) rating. Eirin is the Japanese rating system |
items[].contentDetails.contentRating.fcbmRating |
ENUMERATION |
The video's rating from Malaysia's Film Censorship Board |
items[].contentDetails.contentRating.fcoRating |
ENUMERATION |
The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration |
items[].contentDetails.contentRating.fmocRating |
ENUMERATION |
This property has been deprecated. Use the contentDetails.contentRating.cncRating instead |
items[].contentDetails.contentRating.fpbRating |
ENUMERATION |
The video's rating from South Africa's Film and Publication Board |
items[].contentDetails.contentRating.fpbRatingReasons[] |
ENUMERATION |
|
items[].contentDetails.contentRating.fskRating |
ENUMERATION |
The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating |
items[].contentDetails.contentRating.grfilmRating |
ENUMERATION |
The video's rating in Greece |
items[].contentDetails.contentRating.icaaRating |
ENUMERATION |
The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating |
items[].contentDetails.contentRating.ifcoRating |
ENUMERATION |
The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information |
items[].contentDetails.contentRating.ilfilmRating |
ENUMERATION |
The video's rating in Israel |
items[].contentDetails.contentRating.incaaRating |
ENUMERATION |
The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating |
items[].contentDetails.contentRating.kfcbRating |
ENUMERATION |
The video's rating from the Kenya Film Classification Board |
items[].contentDetails.contentRating.kijkwijzerRating |
ENUMERATION |
voor de Classificatie van Audiovisuele Media (Netherlands) |
items[].contentDetails.contentRating.kmrbRating |
ENUMERATION |
The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea |
items[].contentDetails.contentRating.lsfRating |
ENUMERATION |
The video's rating from Indonesia's Lembaga Sensor Film |
items[].contentDetails.contentRating.mccaaRating |
ENUMERATION |
The video's rating from Malta's Film Age-Classification Board |
items[].contentDetails.contentRating.mccypRating |
ENUMERATION |
The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People |
items[].contentDetails.contentRating.mcstRating |
ENUMERATION |
The video's rating system for Vietnam - MCST |
items[].contentDetails.contentRating.mdaRating |
ENUMERATION |
The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC) |
items[].contentDetails.contentRating.medietilsynetRating |
ENUMERATION |
The video's rating from Medietilsynet, the Norwegian Media Authority |
items[].contentDetails.contentRating.mekuRating |
ENUMERATION |
The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute) |
items[].contentDetails.contentRating.menaMpaaRating |
ENUMERATION |
The rating system for MENA countries, a clone of MPAA. It is needed to |
items[].contentDetails.contentRating.mibacRating |
ENUMERATION |
The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy) |
items[].contentDetails.contentRating.mocRating |
ENUMERATION |
The video's Ministerio de Cultura (Colombia) rating |
items[].contentDetails.contentRating.moctwRating |
ENUMERATION |
The video's rating from Taiwan's Ministry of Culture (文化部) |
items[].contentDetails.contentRating.mpaaRating |
ENUMERATION |
The video's Motion Picture Association of America (MPAA) rating |
items[].contentDetails.contentRating.mpaatRating |
ENUMERATION |
The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html |
items[].contentDetails.contentRating.mtrcbRating |
ENUMERATION |
The video's rating from the Movie and Television Review and Classification Board (Philippines) |
items[].contentDetails.contentRating.nbcRating |
ENUMERATION |
The video's rating from the Maldives National Bureau of Classification |
items[].contentDetails.contentRating.nbcplRating |
ENUMERATION |
The video's rating in Poland |
items[].contentDetails.contentRating.nfrcRating |
ENUMERATION |
The video's rating from the Bulgarian National Film Center |
items[].contentDetails.contentRating.nfvcbRating |
ENUMERATION |
The video's rating from Nigeria's National Film and Video Censors Board |
items[].contentDetails.contentRating.nkclvRating |
ENUMERATION |
The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia) |
items[].contentDetails.contentRating.oflcRating |
ENUMERATION |
The video's Office of Film and Literature Classification (OFLC - New Zealand) rating |
items[].contentDetails.contentRating.pefilmRating |
ENUMERATION |
The video's rating in Peru |
items[].contentDetails.contentRating.rcnofRating |
ENUMERATION |
The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film |
items[].contentDetails.contentRating.resorteviolenciaRating |
ENUMERATION |
The video's rating in Venezuela |
items[].contentDetails.contentRating.rtcRating |
ENUMERATION |
The video's General Directorate of Radio, Television and Cinematography (Mexico) rating |
items[].contentDetails.contentRating.rteRating |
ENUMERATION |
The video's rating from Ireland's Raidió Teilifís Éireann |
items[].contentDetails.contentRating.russiaRating |
ENUMERATION |
The video's National Film Registry of the Russian Federation (MKRF - Russia) rating |
items[].contentDetails.contentRating.skfilmRating |
ENUMERATION |
The video's rating in Slovakia |
items[].contentDetails.contentRating.smaisRating |
ENUMERATION |
The video's rating in Iceland |
items[].contentDetails.contentRating.smsaRating |
ENUMERATION |
The video's rating from Statens medieråd (Sweden's National Media Council) |
items[].contentDetails.contentRating.tvpgRating |
ENUMERATION |
The video's TV Parental Guidelines (TVPG) rating |
items[].contentDetails.contentRating.ytRating |
ENUMERATION |
A rating that YouTube uses to identify age-restricted content |
items[].contentDetails.countryRestriction |
OBJECT |
Rights management policy for YouTube resources |
items[].contentDetails.countryRestriction.allowed |
BOOLEAN |
The value of allowed indicates whether the access to the policy is allowed or denied by default |
items[].contentDetails.countryRestriction.exception[] |
STRING |
|
items[].contentDetails.definition |
ENUMERATION |
The value of definition indicates whether the video is available in high definition or only in standard definition |
items[].contentDetails.dimension |
STRING |
The value of dimension indicates whether the video is available in 3D or in 2D |
items[].contentDetails.duration |
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 |
items[].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 |
items[].contentDetails.licensedContent |
BOOLEAN |
The value of is_license_content indicates whether the video is licensed content |
items[].contentDetails.projection |
ENUMERATION |
Specifies the projection format of the video |
items[].contentDetails.regionRestriction |
OBJECT |
DEPRECATED Region restriction of the video |
items[].contentDetails.regionRestriction.allowed[] |
STRING |
|
items[].contentDetails.regionRestriction.blocked[] |
STRING |
|
items[].etag |
STRING |
Etag of this resource |
items[].fileDetails |
OBJECT |
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 |
items[].fileDetails.audioStreams[] |
OBJECT |
Information about an audio stream |
items[].fileDetails.bitrateBps |
INTEGER |
The uploaded video file's combined (video and audio) bitrate in bits per second |
items[].fileDetails.container |
STRING |
The uploaded video file's container format |
items[].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:
|
items[].fileDetails.durationMs |
INTEGER |
The length of the uploaded video in milliseconds |
items[].fileDetails.fileName |
STRING |
The uploaded file's name. This field is present whether a video file or another type of file was uploaded |
items[].fileDetails.fileSize |
INTEGER |
The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded |
items[].fileDetails.fileType |
ENUMERATION |
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 |
items[].fileDetails.videoStreams[] |
OBJECT |
Information about a video stream |
items[].id |
STRING |
The ID that YouTube uses to uniquely identify the video |
items[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#video" |
items[].liveStreamingDetails |
OBJECT |
Details about the live streaming metadata |
items[].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 |
items[].liveStreamingDetails.actualEndTime |
DATE_TIME |
The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over |
items[].liveStreamingDetails.actualStartTime |
DATE_TIME |
The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins |
items[].liveStreamingDetails.concurrentViewers |
INTEGER |
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 |
items[].liveStreamingDetails.scheduledEndTime |
DATE_TIME |
The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely |
items[].liveStreamingDetails.scheduledStartTime |
DATE_TIME |
The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].localizations |
OBJECT |
List with all localizations |
items[].localizations.customKey |
OBJECT |
Add additional named properties |
items[].localizations.customKey.description |
STRING |
Localized version of the video's description |
items[].localizations.customKey.title |
STRING |
Localized version of the video's title |
items[].monetizationDetails |
OBJECT |
Details about monetization of a YouTube Video |
items[].monetizationDetails.access |
OBJECT |
Rights management policy for YouTube resources |
items[].monetizationDetails.access.allowed |
BOOLEAN |
The value of allowed indicates whether the access to the policy is allowed or denied by default |
items[].monetizationDetails.access.exception[] |
STRING |
|
items[].player |
OBJECT |
Player to be used for a video playback |
items[].player.embedHeight |
INTEGER |
|
items[].player.embedHtml |
STRING |
An |
items[].player.embedWidth |
INTEGER |
The embed width |
items[].processingDetails |
OBJECT |
Describes processing status and progress and availability of some other Video resource parts |
items[].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 |
items[].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 |
items[].processingDetails.processingFailureReason |
ENUMERATION |
The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed |
items[].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 |
items[].processingDetails.processingProgress |
OBJECT |
Video processing progress and completion time estimate |
items[].processingDetails.processingProgress.partsProcessed |
INTEGER |
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 |
items[].processingDetails.processingProgress.partsTotal |
INTEGER |
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 |
items[].processingDetails.processingProgress.timeLeftMs |
INTEGER |
An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video |
items[].processingDetails.processingStatus |
ENUMERATION |
The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed |
items[].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 |
items[].processingDetails.thumbnailsAvailability |
STRING |
This value indicates whether thumbnail images have been generated for the video |
items[].projectDetails |
OBJECT |
Project specific details about the content of a YouTube Video |
items[].projectDetails.tags[] |
STRING |
|
items[].recordingDetails |
OBJECT |
Recording information associated with the video |
items[].recordingDetails.location |
OBJECT |
Geographical coordinates of a point, in WGS84 |
items[].recordingDetails.location.altitude |
NUMBER |
Altitude above the reference ellipsoid, in meters |
items[].recordingDetails.location.latitude |
NUMBER |
Latitude in degrees |
items[].recordingDetails.location.longitude |
NUMBER |
Longitude in degrees |
items[].recordingDetails.locationDescription |
STRING |
The text description of the location where the video was recorded |
items[].recordingDetails.recordingDate |
DATE_TIME |
The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format |
items[].snippet |
OBJECT |
Basic details about a video, including title, description, uploader, thumbnails and category |
items[].snippet.categoryId |
STRING |
The YouTube video category associated with the video |
items[].snippet.channelId |
STRING |
The ID that YouTube uses to uniquely identify the channel that the video was uploaded to |
items[].snippet.channelTitle |
STRING |
Channel title for the channel that the video belongs to |
items[].snippet.defaultAudioLanguage |
STRING |
The default_audio_language property specifies the language spoken in the video's default audio track |
items[].snippet.defaultLanguage |
STRING |
The language of the videos's default snippet |
items[].snippet.description |
STRING |
The video's description |
items[].snippet.liveBroadcastContent |
ENUMERATION |
Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast |
items[].snippet.localized |
OBJECT |
Localized versions of certain video properties (e.g. title) |
items[].snippet.localized.description |
STRING |
Localized version of the video's description |
items[].snippet.localized.title |
STRING |
Localized version of the video's title |
items[].snippet.publishedAt |
DATE_TIME |
The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].snippet.tags[] |
STRING |
|
items[].snippet.thumbnails |
OBJECT |
Internal representation of thumbnails for a YouTube resource |
items[].snippet.title |
STRING |
The video's title |
items[].statistics |
OBJECT |
Statistics about the video, such as the number of times the video was viewed or liked |
items[].statistics.commentCount |
INTEGER |
The number of comments for the video |
items[].statistics.dislikeCount |
INTEGER |
The number of users who have indicated that they disliked the video by giving it a negative rating |
items[].statistics.favoriteCount |
INTEGER |
The number of users who currently have the video marked as a favorite video |
items[].statistics.likeCount |
INTEGER |
The number of users who have indicated that they liked the video by giving it a positive rating |
items[].statistics.viewCount |
INTEGER |
The number of times the video has been viewed |
items[].status |
OBJECT |
Basic details about a video category, such as its localized title |
items[].status.embeddable |
BOOLEAN |
This value indicates if the video can be embedded on another website |
items[].status.failureReason |
ENUMERATION |
This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed |
items[].status.license |
ENUMERATION |
The video's license |
items[].status.privacyStatus |
ENUMERATION |
The video's privacy status |
items[].status.publicStatsViewable |
BOOLEAN |
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 |
items[].status.publishAt |
DATE_TIME |
The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].status.rejectionReason |
ENUMERATION |
This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected |
items[].status.uploadStatus |
ENUMERATION |
The status of the uploaded video |
items[].suggestions |
OBJECT |
Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions |
items[].suggestions.editorSuggestions[] |
ENUMERATION |
|
items[].suggestions.processingErrors[] |
ENUMERATION |
|
items[].suggestions.processingHints[] |
ENUMERATION |
|
items[].suggestions.processingWarnings[] |
ENUMERATION |
|
items[].suggestions.tagSuggestions[] |
OBJECT |
A single tag suggestion with it's relevance information |
items[].topicDetails |
OBJECT |
Freebase topic information related to the video |
items[].topicDetails.relevantTopicIds[] |
STRING |
|
items[].topicDetails.topicCategories[] |
STRING |
|
items[].topicDetails.topicIds[] |
STRING |
|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse" |
nextPageToken |
STRING |
The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set |
pageInfo |
OBJECT |
Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
pageInfo.resultsPerPage |
INTEGER |
The number of results included in the API response |
pageInfo.totalResults |
INTEGER |
The total number of results in the result set |
prevPageToken |
STRING |
The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set |
tokenPagination |
OBJECT |
Stub token pagination template to suppress results |
visitorId |
STRING |
The visitorId identifies the visitor |
= Parameter name
= Format
etag STRING Etag of this resource |
eventId STRING Serialized EventId of the request which produced this response |
items[] OBJECT A video resource represents a YouTube video |
items[].ageGating OBJECT |
items[].ageGating.alcoholContent BOOLEAN 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 |
items[].ageGating.restricted BOOLEAN 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 |
items[].ageGating.videoGameRating ENUMERATION Video game rating, if any |
items[].contentDetails OBJECT Details about the content of a YouTube Video |
items[].contentDetails.caption ENUMERATION The value of captions indicates whether the video has captions or not |
items[].contentDetails.contentRating OBJECT Ratings schemes. The country-specific ratings are mostly for movies and shows. NEXT_ID: 71 |
items[].contentDetails.contentRating.acbRating ENUMERATION 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 |
items[].contentDetails.contentRating.agcomRating ENUMERATION The video's rating from Italy's Autorità per le Garanzie nelle Comunicazioni (AGCOM) |
items[].contentDetails.contentRating.anatelRating ENUMERATION The video's Anatel (Asociación Nacional de Televisión) rating for Chilean television |
items[].contentDetails.contentRating.bbfcRating ENUMERATION The video's British Board of Film Classification (BBFC) rating |
items[].contentDetails.contentRating.bfvcRating ENUMERATION The video's rating from Thailand's Board of Film and Video Censors |
items[].contentDetails.contentRating.bmukkRating ENUMERATION The video's rating from the Austrian Board of Media Classification (Bundesministerium für Unterricht, Kunst und Kultur) |
items[].contentDetails.contentRating.catvRating ENUMERATION 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 |
items[].contentDetails.contentRating.catvfrRating ENUMERATION 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 |
items[].contentDetails.contentRating.cbfcRating ENUMERATION The video's Central Board of Film Certification (CBFC - India) rating |
items[].contentDetails.contentRating.cccRating ENUMERATION The video's Consejo de Calificación Cinematográfica (Chile) rating |
items[].contentDetails.contentRating.cceRating ENUMERATION The video's rating from Portugal's Comissão de Classificação de Espect´culos |
items[].contentDetails.contentRating.chfilmRating ENUMERATION The video's rating in Switzerland |
items[].contentDetails.contentRating.chvrsRating ENUMERATION The video's Canadian Home Video Rating System (CHVRS) rating |
items[].contentDetails.contentRating.cicfRating ENUMERATION The video's rating from the Commission de Contrôle des Films (Belgium) |
items[].contentDetails.contentRating.cnaRating ENUMERATION The video's rating from Romania's CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA) |
items[].contentDetails.contentRating.cncRating ENUMERATION Rating system in France - Commission de classification cinematographique |
items[].contentDetails.contentRating.csaRating ENUMERATION The video's rating from France's Conseil supérieur de l?audiovisuel, which rates broadcast content |
items[].contentDetails.contentRating.cscfRating ENUMERATION The video's rating from Luxembourg's Commission de surveillance de la classification des films (CSCF) |
items[].contentDetails.contentRating.czfilmRating ENUMERATION The video's rating in the Czech Republic |
items[].contentDetails.contentRating.djctqRating ENUMERATION The video's Departamento de Justiça, Classificação, Qualificação e Títulos (DJCQT - Brazil) rating |
items[].contentDetails.contentRating.djctqRatingReasons[] ENUMERATION |
items[].contentDetails.contentRating.ecbmctRating ENUMERATION Rating system in Turkey - Evaluation and Classification Board of the Ministry of Culture and Tourism |
items[].contentDetails.contentRating.eefilmRating ENUMERATION The video's rating in Estonia |
items[].contentDetails.contentRating.egfilmRating ENUMERATION The video's rating in Egypt |
items[].contentDetails.contentRating.eirinRating ENUMERATION The video's Eirin (映倫) rating. Eirin is the Japanese rating system |
items[].contentDetails.contentRating.fcbmRating ENUMERATION The video's rating from Malaysia's Film Censorship Board |
items[].contentDetails.contentRating.fcoRating ENUMERATION The video's rating from Hong Kong's Office for Film, Newspaper and Article Administration |
items[].contentDetails.contentRating.fmocRating ENUMERATION This property has been deprecated. Use the contentDetails.contentRating.cncRating instead |
items[].contentDetails.contentRating.fpbRating ENUMERATION The video's rating from South Africa's Film and Publication Board |
items[].contentDetails.contentRating.fpbRatingReasons[] ENUMERATION |
items[].contentDetails.contentRating.fskRating ENUMERATION The video's Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - Germany) rating |
items[].contentDetails.contentRating.grfilmRating ENUMERATION The video's rating in Greece |
items[].contentDetails.contentRating.icaaRating ENUMERATION The video's Instituto de la Cinematografía y de las Artes Audiovisuales (ICAA - Spain) rating |
items[].contentDetails.contentRating.ifcoRating ENUMERATION The video's Irish Film Classification Office (IFCO - Ireland) rating. See the IFCO website for more information |
items[].contentDetails.contentRating.ilfilmRating ENUMERATION The video's rating in Israel |
items[].contentDetails.contentRating.incaaRating ENUMERATION The video's INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) rating |
items[].contentDetails.contentRating.kfcbRating ENUMERATION The video's rating from the Kenya Film Classification Board |
items[].contentDetails.contentRating.kijkwijzerRating ENUMERATION voor de Classificatie van Audiovisuele Media (Netherlands) |
items[].contentDetails.contentRating.kmrbRating ENUMERATION The video's Korea Media Rating Board (영상물등급위원회) rating. The KMRB rates videos in South Korea |
items[].contentDetails.contentRating.lsfRating ENUMERATION The video's rating from Indonesia's Lembaga Sensor Film |
items[].contentDetails.contentRating.mccaaRating ENUMERATION The video's rating from Malta's Film Age-Classification Board |
items[].contentDetails.contentRating.mccypRating ENUMERATION The video's rating from the Danish Film Institute's (Det Danske Filminstitut) Media Council for Children and Young People |
items[].contentDetails.contentRating.mcstRating ENUMERATION The video's rating system for Vietnam - MCST |
items[].contentDetails.contentRating.mdaRating ENUMERATION The video's rating from Singapore's Media Development Authority (MDA) and, specifically, it's Board of Film Censors (BFC) |
items[].contentDetails.contentRating.medietilsynetRating ENUMERATION The video's rating from Medietilsynet, the Norwegian Media Authority |
items[].contentDetails.contentRating.mekuRating ENUMERATION The video's rating from Finland's Kansallinen Audiovisuaalinen Instituutti (National Audiovisual Institute) |
items[].contentDetails.contentRating.menaMpaaRating ENUMERATION The rating system for MENA countries, a clone of MPAA. It is needed to |
items[].contentDetails.contentRating.mibacRating ENUMERATION The video's rating from the Ministero dei Beni e delle Attività Culturali e del Turismo (Italy) |
items[].contentDetails.contentRating.mocRating ENUMERATION The video's Ministerio de Cultura (Colombia) rating |
items[].contentDetails.contentRating.moctwRating ENUMERATION The video's rating from Taiwan's Ministry of Culture (文化部) |
items[].contentDetails.contentRating.mpaaRating ENUMERATION The video's Motion Picture Association of America (MPAA) rating |
items[].contentDetails.contentRating.mpaatRating ENUMERATION The rating system for trailer, DVD, and Ad in the US. See http://movielabs.com/md/ratings/v2.3/html/US_MPAAT_Ratings.html |
items[].contentDetails.contentRating.mtrcbRating ENUMERATION The video's rating from the Movie and Television Review and Classification Board (Philippines) |
items[].contentDetails.contentRating.nbcRating ENUMERATION The video's rating from the Maldives National Bureau of Classification |
items[].contentDetails.contentRating.nbcplRating ENUMERATION The video's rating in Poland |
items[].contentDetails.contentRating.nfrcRating ENUMERATION The video's rating from the Bulgarian National Film Center |
items[].contentDetails.contentRating.nfvcbRating ENUMERATION The video's rating from Nigeria's National Film and Video Censors Board |
items[].contentDetails.contentRating.nkclvRating ENUMERATION The video's rating from the Nacionãlais Kino centrs (National Film Centre of Latvia) |
items[].contentDetails.contentRating.oflcRating ENUMERATION The video's Office of Film and Literature Classification (OFLC - New Zealand) rating |
items[].contentDetails.contentRating.pefilmRating ENUMERATION The video's rating in Peru |
items[].contentDetails.contentRating.rcnofRating ENUMERATION The video's rating from the Hungarian Nemzeti Filmiroda, the Rating Committee of the National Office of Film |
items[].contentDetails.contentRating.resorteviolenciaRating ENUMERATION The video's rating in Venezuela |
items[].contentDetails.contentRating.rtcRating ENUMERATION The video's General Directorate of Radio, Television and Cinematography (Mexico) rating |
items[].contentDetails.contentRating.rteRating ENUMERATION The video's rating from Ireland's Raidió Teilifís Éireann |
items[].contentDetails.contentRating.russiaRating ENUMERATION The video's National Film Registry of the Russian Federation (MKRF - Russia) rating |
items[].contentDetails.contentRating.skfilmRating ENUMERATION The video's rating in Slovakia |
items[].contentDetails.contentRating.smaisRating ENUMERATION The video's rating in Iceland |
items[].contentDetails.contentRating.smsaRating ENUMERATION The video's rating from Statens medieråd (Sweden's National Media Council) |
items[].contentDetails.contentRating.tvpgRating ENUMERATION The video's TV Parental Guidelines (TVPG) rating |
items[].contentDetails.contentRating.ytRating ENUMERATION A rating that YouTube uses to identify age-restricted content |
items[].contentDetails.countryRestriction OBJECT Rights management policy for YouTube resources |
items[].contentDetails.countryRestriction.allowed BOOLEAN The value of allowed indicates whether the access to the policy is allowed or denied by default |
items[].contentDetails.countryRestriction.exception[] STRING |
items[].contentDetails.definition ENUMERATION The value of definition indicates whether the video is available in high definition or only in standard definition |
items[].contentDetails.dimension STRING The value of dimension indicates whether the video is available in 3D or in 2D |
items[].contentDetails.duration 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 |
items[].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 |
items[].contentDetails.licensedContent BOOLEAN The value of is_license_content indicates whether the video is licensed content |
items[].contentDetails.projection ENUMERATION Specifies the projection format of the video |
items[].contentDetails.regionRestriction OBJECT DEPRECATED Region restriction of the video |
items[].contentDetails.regionRestriction.allowed[] STRING |
items[].contentDetails.regionRestriction.blocked[] STRING |
items[].etag STRING Etag of this resource |
items[].fileDetails OBJECT 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 |
items[].fileDetails.audioStreams[] OBJECT Information about an audio stream |
items[].fileDetails.bitrateBps INTEGER The uploaded video file's combined (video and audio) bitrate in bits per second |
items[].fileDetails.container STRING The uploaded video file's container format |
items[].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:
|
items[].fileDetails.durationMs INTEGER The length of the uploaded video in milliseconds |
items[].fileDetails.fileName STRING The uploaded file's name. This field is present whether a video file or another type of file was uploaded |
items[].fileDetails.fileSize INTEGER The uploaded file's size in bytes. This field is present whether a video file or another type of file was uploaded |
items[].fileDetails.fileType ENUMERATION 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 |
items[].fileDetails.videoStreams[] OBJECT Information about a video stream |
items[].id STRING The ID that YouTube uses to uniquely identify the video |
items[].kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#video" |
items[].liveStreamingDetails OBJECT Details about the live streaming metadata |
items[].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 |
items[].liveStreamingDetails.actualEndTime DATE_TIME The time that the broadcast actually ended. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast is over |
items[].liveStreamingDetails.actualStartTime DATE_TIME The time that the broadcast actually started. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. This value will not be available until the broadcast begins |
items[].liveStreamingDetails.concurrentViewers INTEGER 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 |
items[].liveStreamingDetails.scheduledEndTime DATE_TIME The time that the broadcast is scheduled to end. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. If the value is empty or the property is not present, then the broadcast is scheduled to continue indefinitely |
items[].liveStreamingDetails.scheduledStartTime DATE_TIME The time that the broadcast is scheduled to begin. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].localizations OBJECT List with all localizations |
items[].localizations.customKey OBJECT Add additional named properties |
items[].localizations.customKey.description STRING Localized version of the video's description |
items[].localizations.customKey.title STRING Localized version of the video's title |
items[].monetizationDetails OBJECT Details about monetization of a YouTube Video |
items[].monetizationDetails.access OBJECT Rights management policy for YouTube resources |
items[].monetizationDetails.access.allowed BOOLEAN The value of allowed indicates whether the access to the policy is allowed or denied by default |
items[].monetizationDetails.access.exception[] STRING |
items[].player OBJECT Player to be used for a video playback |
items[].player.embedHeight INTEGER |
items[].player.embedHtml STRING An |
items[].player.embedWidth INTEGER The embed width |
items[].processingDetails OBJECT Describes processing status and progress and availability of some other Video resource parts |
items[].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 |
items[].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 |
items[].processingDetails.processingFailureReason ENUMERATION The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed |
items[].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 |
items[].processingDetails.processingProgress OBJECT Video processing progress and completion time estimate |
items[].processingDetails.processingProgress.partsProcessed INTEGER 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 |
items[].processingDetails.processingProgress.partsTotal INTEGER 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 |
items[].processingDetails.processingProgress.timeLeftMs INTEGER An estimate of the amount of time, in millseconds, that YouTube needs to finish processing the video |
items[].processingDetails.processingStatus ENUMERATION The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed |
items[].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 |
items[].processingDetails.thumbnailsAvailability STRING This value indicates whether thumbnail images have been generated for the video |
items[].projectDetails OBJECT Project specific details about the content of a YouTube Video |
items[].projectDetails.tags[] STRING |
items[].recordingDetails OBJECT Recording information associated with the video |
items[].recordingDetails.location OBJECT Geographical coordinates of a point, in WGS84 |
items[].recordingDetails.location.altitude NUMBER Altitude above the reference ellipsoid, in meters |
items[].recordingDetails.location.latitude NUMBER Latitude in degrees |
items[].recordingDetails.location.longitude NUMBER Longitude in degrees |
items[].recordingDetails.locationDescription STRING The text description of the location where the video was recorded |
items[].recordingDetails.recordingDate DATE_TIME The date and time when the video was recorded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format |
items[].snippet OBJECT Basic details about a video, including title, description, uploader, thumbnails and category |
items[].snippet.categoryId STRING The YouTube video category associated with the video |
items[].snippet.channelId STRING The ID that YouTube uses to uniquely identify the channel that the video was uploaded to |
items[].snippet.channelTitle STRING Channel title for the channel that the video belongs to |
items[].snippet.defaultAudioLanguage STRING The default_audio_language property specifies the language spoken in the video's default audio track |
items[].snippet.defaultLanguage STRING The language of the videos's default snippet |
items[].snippet.description STRING The video's description |
items[].snippet.liveBroadcastContent ENUMERATION Indicates if the video is an upcoming/active live broadcast. Or it's "none" if the video is not an upcoming/active live broadcast |
items[].snippet.localized OBJECT Localized versions of certain video properties (e.g. title) |
items[].snippet.localized.description STRING Localized version of the video's description |
items[].snippet.localized.title STRING Localized version of the video's title |
items[].snippet.publishedAt DATE_TIME The date and time that the video was uploaded. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].snippet.tags[] STRING |
items[].snippet.thumbnails OBJECT Internal representation of thumbnails for a YouTube resource |
items[].snippet.title STRING The video's title |
items[].statistics OBJECT Statistics about the video, such as the number of times the video was viewed or liked |
items[].statistics.commentCount INTEGER The number of comments for the video |
items[].statistics.dislikeCount INTEGER The number of users who have indicated that they disliked the video by giving it a negative rating |
items[].statistics.favoriteCount INTEGER The number of users who currently have the video marked as a favorite video |
items[].statistics.likeCount INTEGER The number of users who have indicated that they liked the video by giving it a positive rating |
items[].statistics.viewCount INTEGER The number of times the video has been viewed |
items[].status OBJECT Basic details about a video category, such as its localized title |
items[].status.embeddable BOOLEAN This value indicates if the video can be embedded on another website |
items[].status.failureReason ENUMERATION This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed |
items[].status.license ENUMERATION The video's license |
items[].status.privacyStatus ENUMERATION The video's privacy status |
items[].status.publicStatsViewable BOOLEAN 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 |
items[].status.publishAt DATE_TIME The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
items[].status.rejectionReason ENUMERATION This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected |
items[].status.uploadStatus ENUMERATION The status of the uploaded video |
items[].suggestions OBJECT Specifies suggestions on how to improve video content, including encoding hints, tag suggestions, and editor suggestions |
items[].suggestions.editorSuggestions[] ENUMERATION |
items[].suggestions.processingErrors[] ENUMERATION |
items[].suggestions.processingHints[] ENUMERATION |
items[].suggestions.processingWarnings[] ENUMERATION |
items[].suggestions.tagSuggestions[] OBJECT A single tag suggestion with it's relevance information |
items[].topicDetails OBJECT Freebase topic information related to the video |
items[].topicDetails.relevantTopicIds[] STRING |
items[].topicDetails.topicCategories[] STRING |
items[].topicDetails.topicIds[] STRING |
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#videoListResponse" |
nextPageToken STRING The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set |
pageInfo OBJECT Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
pageInfo.resultsPerPage INTEGER The number of results included in the API response |
pageInfo.totalResults INTEGER The total number of results in the result set |
prevPageToken STRING The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set |
tokenPagination OBJECT Stub token pagination template to suppress results |
visitorId STRING The visitorId identifies the visitor |