对于在 2020 年 7 月 28 日之后创建的未经验证的 API 项目,通过
videos.insert
端点上传的所有视频将仅限私享观看模式。要解除此限制,每个 API 项目都必须接受审核,以验证是否符合服务条款。如需了解详情,请参阅 API 修订历史记录。
video
资源表示 YouTube 视频。
方法
该 API 支持 videos
资源的以下方法:
资源表示法
以下 JSON 结构显示了 videos
资源的格式:
{ "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 }, "statistics": { "viewCount": string, "likeCount": string, "dislikeCount": string, "favoriteCount": string, "commentCount": string }, "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 } } }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源类型。值为 youtube#video 。 |
etag |
etag 此资源的 Etag。 |
id |
string YouTube 用于唯一标识视频的 ID。 |
snippet |
object snippet 对象包含视频的基本详情,例如标题、说明和类别。 |
snippet.publishedAt |
datetime 视频发布的日期和时间。请注意,这个时间可能与视频上传的时间不同。例如,如果某视频在上传后作为私享视频上传,之后又变为公开状态,则此媒体资源会指定该视频公开的时间。 以下两种特殊情况:
|
snippet.channelId |
string YouTube 用它来唯一标识要将视频上传到的频道。 |
snippet.title |
string 视频的标题。该属性值的长度上限为 100 个字符,并且可以包含除 < 和 > 以外的所有有效 UTF-8 字符。如果您调用 videos.update 方法并更新 video 资源的 snippet 部分,则必须为此属性设置值。 |
snippet.description |
string 视频的说明。该属性值的长度上限为 5000 字节,并可以包含除 < 和 > 以外的所有有效 UTF-8 字符。 |
snippet.thumbnails |
object 与视频相关联的缩略图的地图。对于映射中的每个对象,键是缩略图的名称,而值是包含缩略图的其他信息的对象。 |
snippet.thumbnails.(key) |
object 有效的键值对包括:
|
snippet.thumbnails.(key).url |
string 图片的网址。 |
snippet.thumbnails.(key).width |
unsigned integer 图片的宽度。 |
snippet.thumbnails.(key).height |
unsigned integer 图片的高度。 |
snippet.channelTitle |
string 视频所属的频道的标题。 |
snippet.tags[] |
list 与视频相关联的关键字标记的列表。标签可以包含空格。属性值的长度上限为 500 个字符。请注意关于字符数限制的计算规则:
|
snippet.categoryId |
string 与视频相关的 YouTube 视频类别。如果您调用 videos.update 方法并更新 video 资源的 snippet 部分,则必须为此属性设置值。 |
snippet.liveBroadcastContent |
string 指明视频是即将开始的直播还是正在进行的直播。或者,如果视频不是即将开始/正在进行的直播,则值为“none”。 此属性的有效值包括:
|
snippet.defaultLanguage |
string video 资源的 snippet.title 和 snippet.description 属性中的文本语言。 |
snippet.localized |
object snippet.localized 对象包含视频的本地化标题和说明,或者视频元数据的默认语言标题。
localizations 对象添加、更新或删除本地化标题。 |
snippet.localized.title |
string 本地化的视频标题。 |
snippet.localized.description |
string 本地化的视频说明。 |
snippet.defaultAudioLanguage |
string default_audio_language 属性用于指定视频的默认音轨中所用的语言。 |
contentDetails |
object contentDetails 对象包含视频内容的相关信息,包括视频的时长以及指示视频是否有字幕的指示元素。 |
contentDetails.duration |
string 视频的长度。属性值为 ISO 8601 时长。例如,对于时长至少为 1 分钟的视频,时长小于 1 小时的视频,那么时长的格式为 PT#M#S ,其中字母 PT 表示该值表示一个时间段,字母 M 和 S 分别表示时长(以分钟和秒为单位)。M 和 S 字母前面的 # 字符都是整数,用于指定视频的分钟数(或秒数)。例如,值 PT15M33S 表示视频为 15 分 33 秒。如果视频时长至少为 1 小时,那么时长将采用 PT#H#M#S 格式,其中字母 H 前面的 # 指定视频的时长(以小时为单位),所有其他详细信息都与上述相同。如果视频时长至少为 1 天,那么字母 P 和 T 是分开的,该值的格式为 P#DT#H#M#S 。如需了解完整详情,请参阅 ISO 8601 规范。 |
contentDetails.dimension |
string 指示视频是 3D 还是 2D 格式。 |
contentDetails.definition |
string 指明视频是采用高清格式 ( HD ) 还是只提供标清画质。此属性的有效值包括:
|
contentDetails.caption |
string 指明视频是否有字幕。 此属性的有效值包括:
|
contentDetails.licensedContent |
boolean 指明视频是否表示已获许可的内容,表示内容上传到了某个与 YouTube 内容合作伙伴关联的频道,然后由该合作伙伴提出版权主张。 |
contentDetails.regionRestriction |
object regionRestriction 对象包含视频可供观看(或无法观看)的国家/地区的相关信息。该对象将包含 contentDetails.regionRestriction.allowed 属性或 contentDetails.regionRestriction.blocked 属性。 |
contentDetails.regionRestriction.allowed[] |
list 用于标识视频可观看的国家/地区的地区代码列表。如果此属性存在且某个国家/地区未在其值中列出,则系统会禁止该视频在该国家/地区播放。如果此属性存在且包含空列表,则视频在所有国家/地区禁播。 |
contentDetails.regionRestriction.blocked[] |
list 用于标识视频禁播的国家/地区的地区代码列表。如果此属性存在且某个国家/地区未列在值中,则该视频在该国家/地区可供观看。如果此属性存在且包含空列表,则视频在所有国家/地区都有效。 |
contentDetails.contentRating |
object 指定视频在各种分级制度下收到的分级。 |
contentDetails.contentRating.acbRating |
string 视频的澳大利亚分类委员会 (ACB) 或澳大利亚通信媒体管理局 (ACMA) 分级。ACMA 分级用于对儿童电视节目进行归类。 此属性的有效值包括:
|
contentDetails.contentRating.agcomRating |
string 该视频来自意大利 Autorità per le Garanzie nelle Comunicazioni (AGCOM) 的评分。 此属性的有效值包括:
|
contentDetails.contentRating.anatelRating |
string 该视频的智利电视台 Anatel (Asociación Nacional de Televisión) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.bbfcRating |
string 该视频的英国电影分级委员会 (BBFC) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.bfvcRating |
string 该视频由泰国电影委员会和视频审查委员会评定。 此属性的有效值包括:
|
contentDetails.contentRating.bmukkRating |
string 该视频由奥地利媒体分级委员会 (Bundesministerium für Unterricht, Kunst und Kultur) 评定。 此属性的有效值包括:
|
contentDetails.contentRating.catvRating |
string 加拿大电视分级系统 - 加拿大电视分类系统:加拿大广播电视和电视委员会 (CRTC) 针对加拿大英语广播分级为视频分级。如需了解详情,请访问加拿大广播标准委员会网站。 此属性的有效值包括:
|
contentDetails.contentRating.catvfrRating |
string 视频由加拿大无线电和电视委员会 (CRTC) 针对加拿大法语广播分级。如需了解详情,请访问加拿大广播标准委员会网站。 此属性的有效值包括:
|
contentDetails.contentRating.cbfcRating |
string 该视频获得了美国中央电影委员会 (CBFC) 的分级。 此属性的有效值包括:
|
contentDetails.contentRating.cccRating |
string 该视频的 Consejo de Calificación Cinematográfica(智利)分级为。 此属性的有效值包括:
|
contentDetails.contentRating.cceRating |
string 葡萄牙 Comissão de Classificação de Espect `culos 对该视频的评分。 此属性的有效值:
|
contentDetails.contentRating.chfilmRating |
string 视频在瑞士的分级。 此属性的有效值包括:
|
contentDetails.contentRating.chvrsRating |
string 该视频的加拿大家庭视频分级系统 (CHVRS) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.cicfRating |
string 视频来自 Contrôle des Films(比利时)电影分级。 此属性的有效值包括:
|
contentDetails.contentRating.cnaRating |
string 视频来自罗马尼亚的 CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA)。 此属性的有效值包括:
|
contentDetails.contentRating.cncRating |
string 法国的分级制度 - 佣金分类电影制片 此属性的有效值包括:
|
contentDetails.contentRating.csaRating |
string 视频由法国的 Conseil supérieur de l?audiovisuel 分级,用于对广播内容进行分级。 此属性的有效值包括:
|
contentDetails.contentRating.cscfRating |
string 视频是卢森堡佣金监管委员会 (CSCF) 给出的评分。 此属性的有效值包括:
|
contentDetails.contentRating.czfilmRating |
string 视频在捷克的分级。 此属性的有效值包括:
|
contentDetails.contentRating.djctqRating |
string 该视频的 Leaveamento de Justiça、Classificação、Qualificação e Títulos(DJCQT - 巴西)分级。 此属性的有效值包括:
|
contentDetails.contentRating.djctqRatingReasons[] |
list 视频获得 DJCQT(巴西)分级的原因。 |
contentDetails.contentRating.ecbmctRating |
string 土耳其的分级制度 - 文化和旅游部评估与分类委员会 此媒体资源的有效值包括:
|
contentDetails.contentRating.eefilmRating |
string 视频在爱沙尼亚的评分。 此属性的有效值包括:
|
contentDetails.contentRating.egfilmRating |
string 视频在埃及的评分。 此属性的有效值包括:
|
contentDetails.contentRating.eirinRating |
string 该视频的爱尔兰艾工评分。Eirin 是日本分级制度。 此媒体资源的有效值包括:
|
contentDetails.contentRating.fcbmRating |
string 视频由马来西亚电影审查委员会评定。 此属性的有效值包括:
|
contentDetails.contentRating.fcoRating |
string 该视频是香港电影、报纸和物品管理局给出的评分。 此属性的有效值:
|
contentDetails.contentRating.fmocRating |
string 此属性自 2015 年 11 月 2 日起已弃用。请改用 contentDetails.contentRating.cncRating 资源。该视频的 National du cinéma et de l'image animé(法国文化部)分级。 此资源的有效值包括:
|
contentDetails.contentRating.fpbRating |
string 该视频由南非电影和出版物委员会分级。 此属性的有效值包括:
|
contentDetails.contentRating.fpbRatingReasons[] |
list 视频获得 FPB(南非)分级的原因。 |
contentDetails.contentRating.fskRating |
string 该视频的 Freiwillige Selbstkontrolle der Filmwirtschaft(FSK - 德国)分级。 此属性的有效值包括:
|
contentDetails.contentRating.grfilmRating |
string 视频在希腊的分级。 此属性的有效值包括:
|
contentDetails.contentRating.icaaRating |
string 该视频在 Instituto de la Cinematografía y de las Artes Audiovisuales(ICAA - 西班牙)分级中。 此属性的有效值包括:
|
contentDetails.contentRating.ifcoRating |
string 视频的爱尔兰电影分级委员会 (IFCO - Ireland) 分级。如需了解详情,请参阅 IFCO 网站。 此属性的有效值包括:
|
contentDetails.contentRating.ilfilmRating |
string 视频在以色列的分级。 此属性的有效值包括:
|
contentDetails.contentRating.incaaRating |
string 视频的 IncAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.kfcbRating |
string 视频来自肯尼亚电影分级委员会的分级。 此属性的有效值包括:
|
contentDetails.contentRating.kijkwijzerRating |
string voor de Classificatie van Audiovisuele Media(荷兰) 此属性的有效值包括:
|
contentDetails.contentRating.kmrbRating |
string 韩国的韩国媒体评定委员会 (韩语) 的分级。KMRB 为韩国境内的视频分级。 此媒体资源的有效值包括:
|
contentDetails.contentRating.lsfRating |
string 该视频由印度尼西亚的《兰巴加传感胶片》提供的评分。 此属性的有效值包括:
|
contentDetails.contentRating.mccaaRating |
string 马耳他电影年龄分级委员会提供的视频分级。 此属性的有效值包括:
|
contentDetails.contentRating.mccypRating |
string 视频由丹麦电影学院 (Det Danske Filminstitut) 儿童和青年媒体委员会 (Det Danske Filminstitut) 儿童和年轻人媒体委员会评定。 此属性的有效值:
|
contentDetails.contentRating.mcstRating |
string 视频在越南的分级系统 - MCST 此媒体资源的有效值包括:
|
contentDetails.contentRating.mdaRating |
string 新加坡媒体开发管理局 (MDA) 对该视频的分级,尤其是“电影审查委员会”(BFC)。 此属性的有效值包括:
|
contentDetails.contentRating.medietilsynetRating |
string 视频来自挪威媒体管理局 Medietilsynet。 此属性的有效值包括:
|
contentDetails.contentRating.mekuRating |
string 视频评分来自芬兰坎萨林音像学院(国家视听研究所)。 此属性的有效值包括:
|
contentDetails.contentRating.mibacRating |
string 视频在 Ministero dei Beni e delle Attivitàculturali e del Turismo(意大利)上的评分如下。 此属性的有效值包括:
|
contentDetails.contentRating.mocRating |
string 视频的 Ministerio de Cultura(哥伦比亚)分级。 此属性的有效值:
|
contentDetails.contentRating.moctwRating |
string 该视频来自台湾文化部。 此属性的有效值包括:
|
contentDetails.contentRating.mpaaRating |
string 美国电影协会 (MPAA) 分级视频。 此属性的有效值:
|
contentDetails.contentRating.mpaatRating |
string 美国电影协会对电影预告片和预告片的评分。 此属性的有效值:
|
contentDetails.contentRating.mtrcbRating |
string 影片和电视评价与分类委员会(菲律宾)对该视频的评分。 此属性的有效值包括:
|
contentDetails.contentRating.nbcRating |
string 视频由马尔代夫国家分级局给出的分级。 此属性的有效值包括:
|
contentDetails.contentRating.nfrcRating |
string 视频来自保加利亚国家电影中心。 此属性的有效值包括:
|
contentDetails.contentRating.nfvcbRating |
string 视频来自尼日利亚国家电影和视频审查委员会的分级。 此属性的有效值包括:
|
contentDetails.contentRating.nkclvRating |
string 该视频的分级机构是拉脱维亚国家电影中心。 此属性的有效值包括:
|
contentDetails.contentRating.oflcRating |
string 该视频是否属于美国电影与文学分级办公室 (OFLC - New Zealand) 的分级。 此属性的有效值包括:
|
contentDetails.contentRating.pefilmRating |
string 该视频在秘鲁的评分。 此属性的有效值包括:
|
contentDetails.contentRating.resorteviolenciaRating |
string 视频在委内瑞拉的评分。 此属性的有效值包括:
|
contentDetails.contentRating.rtcRating |
string 该视频的电台、电视和电影总局(墨西哥)分级。 此属性的有效值包括:
|
contentDetails.contentRating.rteRating |
string 该视频由爱尔兰的 Raidió Teilifís Éireann 评定。 此属性的有效值包括:
|
contentDetails.contentRating.russiaRating |
string 该视频在俄罗斯联邦国家电影分级机构 (MKRF - 俄罗斯) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.skfilmRating |
string 视频在斯洛伐克的分级。 此属性的有效值包括:
|
contentDetails.contentRating.smaisRating |
string 视频在冰岛的评分。 此属性的有效值包括:
|
contentDetails.contentRating.smsaRating |
string 视频由 Statens medieråd(瑞典国家媒体委员会)决定。 此属性的有效值包括:
|
contentDetails.contentRating.tvpgRating |
string 该视频的电视家长指导 (TVPG) 分级。 此属性的有效值包括:
|
contentDetails.contentRating.ytRating |
string YouTube 用来识别有年龄限制的内容的分级。 此属性的有效值包括:
|
contentDetails.projection |
string 指定视频的投影格式。 此属性的有效值包括:
|
contentDetails.hasCustomThumbnail |
boolean 指明视频上传者是否已为视频提供自定义缩略图。只有视频上传者才能看到此属性。 |
status |
object status 对象包含视频的上传、处理和隐私权状态方面的信息。 |
status.uploadStatus |
string 已上传视频的状态。 此属性的有效值包括:
|
status.failureReason |
string 此值说明了视频未能上传的原因。仅当 uploadStatus 属性指明上传失败时,此属性才会显示。此属性的有效值包括:
|
status.rejectionReason |
string 此值说明了 YouTube 拒绝上传的视频的原因。仅当 uploadStatus 属性指明上传遭拒时,此属性才会显示。此属性的有效值包括:
|
status.privacyStatus |
string 视频的隐私状态。 此属性的有效值包括:
|
status.publishAt |
datetime 安排视频发布时间的日期和时间。仅当视频的隐私状态为“私享”时,才能进行此设置。该值采用 ISO 8601 格式指定。请注意关于此行为的另外两点:
|
status.license |
string 视频的许可。 此属性的有效值包括:
|
status.embeddable |
boolean 此值用于指明视频是否可以嵌入到其他网站中。 |
status.publicStatsViewable |
boolean 该值用于指明视频观看页面上的扩展视频统计信息是否可供公开查看。默认情况下,这些统计信息是可见的,即使此属性的值设为 false ,视频观看次数和评分等统计信息仍会公开显示。 |
status.madeForKids |
boolean 此值用于指明视频是否被标识为面向儿童的内容,并包含视频当前的“面向儿童的内容”状态。例如,状态可以根据 selfDeclaredMadeForKids 属性的值来确定。如需详细了解如何为您的频道、视频或广播设置观众群,请访问 YouTube 帮助中心。 |
status.selfDeclaredMadeForKids |
boolean 在 videos.insert 或 videos.update 请求中,此属性可让频道所有者将视频标识为面向儿童的内容。在 videos.list 请求中,只有当频道所有者对 API 请求进行授权时,才会返回属性值。 |
statistics |
object statistics 对象包含视频的相关统计信息。 |
statistics.viewCount |
unsigned long 视频的观看次数。 |
statistics.likeCount |
unsigned long 表明自己喜欢该视频的用户数量。 |
statistics.dislikeCount |
unsigned long 注意:
statistics.dislikeCount 属性已于 2021 年 12 月 13 日设为私有。这意味着,仅当 API 请求通过视频所有者的身份验证时,该属性才会包含在 API 响应中。如需了解详情,请参阅修订历史记录。表明自己不喜欢该视频的用户数量。 |
statistics.favoriteCount |
unsigned long 注意:此属性已被弃用。此弃用于 2015 年 8 月 28 日生效。现在,该属性的值始终设为 0 。 |
statistics.commentCount |
unsigned long 视频的评论数。 |
player |
object player 对象包含您用于在嵌入式播放器中播放视频的信息。 |
player.embedHtml |
string 用于嵌入播放视频的播放器的 <iframe> 标记。 |
player.embedHeight |
long 在 player.embedHtml 属性中返回的嵌入式播放器的高度。仅当请求为 maxHeight 和/或 maxWidth 参数指定了值且视频的宽高比已知时,系统才会返回此属性。 |
player.embedWidth |
long 在 player.embedHtml 属性中返回的嵌入式播放器的宽度。仅当请求为 maxHeight 和/或 maxWidth 参数指定了值且视频的宽高比已知时,系统才会返回此属性。 |
topicDetails |
object topicDetails 对象用于封装与视频相关联的主题的相关信息。重要提示:如需详细了解与主题 ID 相关的即将发生的变更,请参阅 topicDetails.relevantTopicIds[] 和 topicDetails.topicIds[] 属性的定义以及修订历史记录。 |
topicDetails.topicIds[] |
list 重要提示:此属性自 2016 年 11 月 10 日起已弃用。现在,该 API 不再返回此属性的值,并且与视频相关联的任何主题现在都会由 topicDetails.relevantTopicIds[] 属性值返回。 |
topicDetails.relevantTopicIds[] |
list 与视频相关的主题 ID 的列表。 此属性自 2016 年 11 月 10 日起已弃用。我们将于 2017 年 11 月 10 日停止支持此 API。 重要提示:由于 Freebase 和 Freebase API 已弃用,因此从 2017 年 2 月 27 日开始,主题 ID 的运作方式有所不同。当时,YouTube 已开始返回一小部分精选主题 ID。 |
topicDetails.topicCategories[] |
list 维基百科视频列表,提供视频内容的简要说明。 |
recordingDetails |
object recordingDetails 对象封装了录制视频的位置、日期和地址的相关信息。 |
recordingDetails.locationDescription |
string 此属性自 2017 年 6 月 1 日起已弃用。如需了解详情,请参阅弃用公告。 录制视频的位置的文本说明。 |
recordingDetails.location |
object 与视频相关的地理位置信息。请注意,子属性值用于标识视频所有者想与视频相关联的位置。此值是可修改的,可在公开视频中搜索到,并且可能会针对公开视频向用户显示。 |
recordingDetails.location.latitude |
double 此属性自 2017 年 6 月 1 日起已弃用。如需了解详情,请参阅弃用公告。 纬度(以度为单位)。 |
recordingDetails.location.longitude |
double 此属性自 2017 年 6 月 1 日起已弃用。如需了解详情,请参阅弃用公告。 经度(以度为单位)。 |
recordingDetails.location.altitude |
double 此属性自 2018 年 7 月 9 日起已弃用。如需了解详情,请参阅弃用公告。 参考椭圆形上方的海拔高度(以米为单位)。 |
recordingDetails.recordingDate |
datetime 录制视频的日期和时间。该值采用 ISO 8601 ( YYYY-MM-DDThh:mm:ss.sssZ ) 格式指定。 |
fileDetails |
object fileDetails 对象用于封装与已上传到 YouTube 的视频文件相关的信息,包括文件的分辨率、时长、音频和视频编解码器、直播码率等等。该数据只能由视频所有者检索。仅当 processingDetails.fileAvailability 属性的值为 available 时,系统才会返回 fileDetails 对象。 |
fileDetails.fileName |
string 已上传文件的名称。无论视频文件是上传还是其他类型的文件,此字段都存在。 |
fileDetails.fileSize |
unsigned long 已上传文件的大小(以字节为单位)。无论视频文件是上传还是其他类型的文件,此字段都存在。 |
fileDetails.fileType |
string 由 YouTube 的视频处理引擎检测到的上传文件的类型。目前,YouTube 只处理视频文件,但无论上传视频还是其他类型的文件,此字段都存在。 此属性的有效值包括:
|
fileDetails.container |
string 上传的视频文件的容器格式。 |
fileDetails.videoStreams[] |
list 已上传视频文件中包含的视频流列表。列表中的每项内容都包含视频流的详细元数据。 |
fileDetails.videoStreams[].widthPixels |
unsigned integer 经过编码的视频内容的宽度(以像素为单位)。您可以按 width_pixels /height_pixels 计算视频的编码宽高比。 |
fileDetails.videoStreams[].heightPixels |
unsigned integer 经过编码的视频内容的高度(以像素为单位)。 |
fileDetails.videoStreams[].frameRateFps |
double 视频流的帧速率,以每秒帧数为单位。 |
fileDetails.videoStreams[].aspectRatio |
double 视频内容的显示宽高比,用于指定视频的显示宽高比。 |
fileDetails.videoStreams[].codec |
string 该流使用的视频编解码器。 |
fileDetails.videoStreams[].bitrateBps |
unsigned long 视频流的比特率(以每秒比特数为单位)。 |
fileDetails.videoStreams[].rotation |
string YouTube 需要轮播原始来源内容才能正确展示视频。 此属性的有效值包括:
|
fileDetails.videoStreams[].vendor |
string 用于唯一标识视频供应商的值。通常,该值是包含四个字母的供应商代码。 |
fileDetails.audioStreams[] |
list 所上传视频文件中包含的音频流列表。列表中的每项内容都包含有关音频流的详细元数据。 |
fileDetails.audioStreams[].channelCount |
unsigned integer 流中包含的音频通道的数量。 |
fileDetails.audioStreams[].codec |
string 该流使用的音频编解码器。 |
fileDetails.audioStreams[].bitrateBps |
unsigned long 音频流的比特率(单位:每秒比特数)。 |
fileDetails.audioStreams[].vendor |
string 用于唯一标识视频供应商的值。通常,该值是包含四个字母的供应商代码。 |
fileDetails.durationMs |
unsigned long 已上传的视频的时长(以毫秒为单位)。 |
fileDetails.bitrateBps |
unsigned long 上传的视频文件(视频和音频)的组合比特率(每秒比特数)。 |
fileDetails.creationTime |
string 上传的视频文件的创建日期和时间。该值采用 ISO 8601 格式指定。目前,支持以下 ISO 8601 格式:
|
processingDetails |
object processingDetails 对象可封装 YouTube 处理已上传视频文件的进度信息。该对象中的属性标识当前处理状态以及 YouTube 处理完视频后的剩余时间的估算值。此部分还会指出视频是否可以使用不同类型的数据或内容(例如文件详细信息或缩略图)。系统会对 processingProgress 对象进行轮询,以便跟踪上传的视频能否跟踪 YouTube 处理已上传视频文件的进度。该数据只能由视频所有者检索。 |
processingDetails.processingStatus |
string 视频的处理状态。此值可表明 YouTube 是否能够处理该视频,或者视频是否仍在处理中。 此属性的有效值包括:
|
processingDetails.processingProgress |
object processingProgress 对象包含 YouTube 处理视频时所取得的进度。仅当视频的处理状态为 processing 时,这些值才相关。 |
processingDetails.processingProgress.partsTotal |
unsigned long 需要为视频处理的部分的总数。在 YouTube 处理视频期间,此数值可能会进行更精准的估算。 |
processingDetails.processingProgress.partsProcessed |
unsigned long YouTube 已处理的视频部分的数量。通过计算,可以估算出 YouTube 已处理的视频所占的百分比: 100 * parts_processed / parts_total 请注意,由于已处理的片段数没有相应地增加,因此估算出的片段数可能会增加,因此在 YouTube 处理视频时,计算得出的进度可能会定期减少。 |
processingDetails.processingProgress.timeLeftMs |
unsigned long 估算 YouTube 处理完视频所需的时间(以毫秒为单位)。 |
processingDetails.processingFailureReason |
string YouTube 无法处理视频的原因。仅当 processingStatus 属性值为 failed 时,此属性才具有值。此属性的有效值为:
|
processingDetails.fileDetailsAvailability |
string 此值表示上传的视频是否可以使用文件详细信息。您可以通过在 videos.list() 请求中请求 fileDetails 部分来检索视频的文件详细信息。 |
processingDetails.processingIssuesAvailability |
string 此值用于指明视频处理引擎是否生成了有助于提升视频处理能力的建议、说明视频处理问题的警告或导致视频处理问题的错误。您可以通过在 videos.list() 请求中请求 suggestions 部分来检索这些建议。 |
processingDetails.tagSuggestionsAvailability |
string 此值用于指明视频是否提供关键字(标签)建议。您可以在视频的元数据中添加标记,以便其他用户更轻松地找到该视频。您可以通过在 videos.list() 请求中请求 suggestions 部分来检索这些建议。 |
processingDetails.editorSuggestionsAvailability |
string 此值用于指明视频是否具有可提升视频质量或播放体验的视频编辑建议。您可以通过在 videos.list() 请求中请求 suggestions 部分来检索这些建议。 |
processingDetails.thumbnailsAvailability |
string 该值表示系统是否为视频生成了缩略图。 |
suggestions |
object suggestions 对象封装了有助于识别所上传视频的画质或元数据的建议。该数据只能由视频所有者检索。仅当 processingDetails.tagSuggestionsAvailability 属性或 processingDetails.editorSuggestionsAvailability 属性的值为 available 时,系统才会返回 suggestions 对象。 |
suggestions.processingErrors[] |
list 一份错误列表,将会导致 YouTube 无法成功处理上传的视频。这些错误表明,无论视频的当前处理状态如何,最终该状态几乎肯定是 failed 。此属性的有效值包括:
|
suggestions.processingWarnings[] |
list 列举 YouTube 可能对上传的视频进行转码或导致转码出错的原因。这些警告是在 YouTube 实际处理上传的视频文件之前生成的。此外,它们还可以指出一些问题,这些问题不一定表示视频处理会失败,但仍然可能会导致同步问题、视频伪影或缺少音轨等问题。 此属性的有效值包括:
|
suggestions.processingHints[] |
list 可能会提高 YouTube 处理视频能力的建议列表。 此属性的有效值包括:
|
suggestions.tagSuggestions[] |
list 一系列可以添加到视频元数据中的关键字标记,以提高用户在 YouTube 上搜索或浏览内容时找到您视频的可能性。 |
suggestions.tagSuggestions[].tag |
string 为视频建议的关键字标签。 |
suggestions.tagSuggestions[].categoryRestricts[] |
list 与代码相关的一组视频类别。您可以根据视频上传者与视频相关联的视频类别,使用此信息来显示适当的标签建议。默认情况下,如果没有为关键字定义限制,则标签建议适用于所有类别。 |
suggestions.editorSuggestions[] |
list 可改善所上传视频的画质或播放体验的视频编辑操作列表。 此属性的有效值包括:
|
liveStreamingDetails |
object liveStreamingDetails 对象包含实时视频广播的元数据。仅当视频是即将开始、正在直播或已完成的直播时,对象才会出现在 video 资源中。 |
liveStreamingDetails.actualStartTime |
datetime 直播实际开始的时间。该值采用 ISO 8601 格式指定。直播开始前,此值不可用。 |
liveStreamingDetails.actualEndTime |
datetime 直播实际结束的时间。该值采用 ISO 8601 格式指定。广播结束后,此值才可用。 |
liveStreamingDetails.scheduledStartTime |
datetime 安排开始直播的时间。该值采用 ISO 8601 格式指定。 |
liveStreamingDetails.scheduledEndTime |
datetime 安排直播结束时间的时间。该值采用 ISO 8601 格式指定。如果该值为空或该属性不存在,则系统会安排继续无限期广播。 |
liveStreamingDetails.concurrentViewers |
unsigned long 当前观看直播的观看者人数。如果广播有当前观看者,并且广播所有者没有隐藏视频的观看次数,则该属性及其值就会显示。请注意,YouTube 会在直播结束后停止跟踪同时观看的观看者人数。因此,此属性不会标识正在观看已结束的直播归档视频的观看者人数。 |
liveStreamingDetails.activeLiveChatId |
string 当前附加至此视频的实时聊天内容的 ID。仅当视频当前为包含实时聊天的直播时,系统才会填充此字段。直播转换完成后,此字段将被移除,实时聊天也随之关闭。对于持续广播,实时聊天 ID 将不再与此视频关联,而与永久页面显示的新视频关联。 |
localizations |
object localizations 对象包含视频元数据的翻译。 |
localizations.(key) |
object 与键值对相关联的本地化文本的语言。该值是一个包含 BCP-47 语言代码的字符串。 |
localizations.(key).title |
string 本地化的视频标题。 |
localizations.(key).description |
string 本地化的视频说明。 |