凡是透過
videos.insert
端點上傳的影片,如果是透過 2020 年 7 月 28 日之後建立的未經驗證 API 專案,都會限制為私人瀏覽模式。如要解除這項限制,每個 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, "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 } } }
屬性
下表定義了這個資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源的類型。值為 youtube#video 。 |
etag |
etag 這項資源的 Etag。 |
id |
string YouTube 用來識別影片的專屬 ID。 |
snippet |
object snippet 物件包含影片的基本詳細資料,例如標題、說明和類別。 |
snippet.publishedAt |
datetime 影片發布日期和時間。請注意,這可能與影片上傳時間不同。舉例來說,如果影片上傳時設為私人影片,但之後轉為公開,這個屬性就會指定影片公開的時間。 以下是幾種特殊情況:
|
snippet.channelId |
string YouTube 用來識別影片上傳頻道的 ID。 |
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 前方的 # 會以小時為單位指定影片長度,其他所有詳細資料則與上述相同。如果影片長度至少一天,字母 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 影片的葡萄牙 CCE 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.chfilmRating |
string 影片在瑞士的分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.chvrsRating |
string 影片的加拿大家庭錄影帶分級系統 (CHVRS) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.cicfRating |
string 由比利時電影評級委員會 (Commission de 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 影片的 Departamento 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 (映倫) 分級。Eirin 是日本的分級制度。 這個屬性的有效值如下:
|
contentDetails.contentRating.fcbmRating |
string 影片的馬來西亞電影審查委員會分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.fcoRating |
string 由香港電影、報刊及物品管理處評定的影片分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.fmocRating |
string 這項屬性已於 2015 年 11 月 2 日淘汰。請改用 contentDetails.contentRating.cncRating 屬性。影片的國家電影與動畫圖像中心 (法國文化部) 評級。 這個屬性的有效值如下:
|
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 這部影片的分級為 Cinematografía y de las Artes Audiovisuales (ICAA - 西班牙) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.ifcoRating |
string 影片的愛爾蘭電影分級辦公室 (IFCO - 愛爾蘭) 分級。詳情請參閱 IFCO 網站。 這個屬性的有效值如下:
|
contentDetails.contentRating.ilfilmRating |
string 影片在以色列的評級。 這個屬性的有效值如下:
|
contentDetails.contentRating.incaaRating |
string 該影片的 INCAA (Inseacho 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 由印尼的 Lembaga Sensor Film 評定的影片分級。 這個屬性適用的有效值如下:
|
contentDetails.contentRating.mccaaRating |
string 影片的馬爾他電影分級委員會分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mccypRating |
string 該影片是來自丹麥電影協會 (Det Danske Filmins Institute) 兒童與青少年媒體委員會的分級。 這項資源的有效值如下:
|
contentDetails.contentRating.mcstRating |
string 越南的影片分級系統 - MCST 這項屬性的有效值如下:
|
contentDetails.contentRating.mdaRating |
string 該影片來自新加坡媒體發展局 (MDA) 的分級,具體來說就是電影審查委員會 (BFC)。 這個屬性的有效值如下:
|
contentDetails.contentRating.medietilsynetRating |
string 該影片自挪威媒體管理局 Medietilsynet 的分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mekuRating |
string 芬蘭國家視聽研究所 (National Audiovisual Institute) 的影片分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mibacRating |
string 由意大利文化遺產、旅遊和觀光部 (MiBACT) 評定的影片分級。 這個屬性可用的值如下:
|
contentDetails.contentRating.mocRating |
string 影片的 Cultura (哥倫比亞) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.moctwRating |
string 這部影片是來自臺灣文化部 (Ministry of Culture of Culture) 的分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mpaaRating |
string 影片的美國電影協會 (MPAA) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mpaatRating |
string 美國電影協會對電影預告片和預覽片的評級。 這個屬性的有效值如下:
|
contentDetails.contentRating.mtrcbRating |
string 該影片自 Movie and Television Review and Classification Board (菲律賓) 的分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.nbcRating |
string 由馬爾地文迪內閣分級局評定的影片分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.nfrcRating |
string 保加利亞國家電影中心的影片分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.nfvcbRating |
string 由奈及利亞國家電影和錄影帶審查委員會評定的影片分級。 這個屬性適用的有效值如下:
|
contentDetails.contentRating.nkclvRating |
string 該影片根據美國拉脫維亞國家電影中心 (Nacion 所選的 lais Kino centrs) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.oflcRating |
string 此影片的辦公室與文學分類 (OFLC - 紐西蘭) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.pefilmRating |
string 影片在秘魯的評級。 這個屬性的有效值如下:
|
contentDetails.contentRating.resorteviolenciaRating |
string 影片在委內瑞拉的評級。 這個屬性的有效值如下:
|
contentDetails.contentRating.rtcRating |
string 影片的墨西哥廣播電視電影總署 (General Directorate of Radio, Television and Cinematography) 分級。 這個屬性的有效值如下:
|
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 影片的 TV Parental Guidelines (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 要求時,系統才會傳回屬性值。 |
status.containsSyntheticMedia |
boolean 在 videos.insert 或 videos.update 要求中,這個屬性可讓頻道擁有者揭露影片含有逼真的變造或合成 (A/S) 內容。進一步瞭解 YouTube 與 A/S 內容相關的政策。以下是 A/S 內容的例子:
|
statistics |
object statistics 物件包含影片的統計資料。 |
statistics.viewCount |
unsigned long 影片的觀看次數。 |
statistics.likeCount |
unsigned long 表示喜歡影片的使用者人數。 |
statistics.dislikeCount |
unsigned long 注意:自 2021 年 12 月 13 日起,
statistics.dislikeCount 屬性已設為不公開。也就是說,只有在 API 要求經過影片擁有者驗證時,屬性才會納入 API 回應。詳情請參閱修訂版本記錄。表示不喜歡影片的使用者人數。 |
statistics.favoriteCount |
unsigned long 注意:此屬性已淘汰。這項淘汰作業已於 2015 年 8 月 28 日生效。屬性的值現在一律設為 0 。 |
statistics.commentCount |
unsigned long 影片的留言數。 |
paidProductPlacementDetails |
object paidProductPlacementDetails 物件包含影片中有關付費商品置入的資訊。 |
paidProductPlacementDetails.hasPaidProductPlacement |
boolean 如果內容使用付費商品置入,請設為 true 。預設為 false 。 |
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 日。 重要事項:由於 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 這個值表示影片處理引擎是否產生可改善 YouTube 處理影片能力的建議、說明影片處理問題的警告,或是導致影片處理問題的錯誤。您可以透過在 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 會在直播結束後停止追蹤直播的同時觀看人數。因此,這個屬性不會識別觀看已結束的直播影片封存檔的觀眾人數。 YouTube Data API 傳回的同時觀看人數可能與透過 YouTube 數據分析處理後的同時觀看人數不同。如要進一步瞭解直播指標,請前往 YouTube 說明中心。
|
liveStreamingDetails.activeLiveChatId |
string 這部影片目前連結的有效直播聊天室 ID。只有在影片為目前進行聊天室的現場直播時,系統才會填寫這個欄位。直播結束後,系統會移除這個欄位,並關閉聊天室。對於持續直播,聊天室 ID 將不再與該影片連結,而是連結至持續頁面顯示的新影片。 |
localizations |
object localizations 物件含有影片中繼資料的翻譯。 |
localizations.(key) |
object 與鍵值相關聯的本地化文字語言。這個值是包含 BCP-47 語言代碼的字串。 |
localizations.(key).title |
string 本地化的影片標題。 |
localizations.(key).description |
string 本地化的影片說明。 |