凡是透過 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 用來識別影片上傳來源的 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 指明影片是否為即將播出/正在進行的現場直播。如果影片並非即將播出/正在進行的現場直播,則為「無」。 這個屬性的有效值如下:
|
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 分鐘且短一小時的影片,格式為 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à 每台加利福尼亞州議會 (AGCOM)。 這項屬性的有效值如下:
|
contentDetails.contentRating.anatelRating |
string 影片以 Anatel (Asociación Nacional de Televisión) 為智利電視的評等。 這項屬性的有效值如下:
|
contentDetails.contentRating.bbfcRating |
string 英國電影分級委員會 (BBFC) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.bfvcRating |
string 您的影片來自泰國電影委員會 (Video of Board of Film and Video enenns) 的評分。 這項屬性的有效值如下:
|
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 您的影片來自羅馬尼亞「CONNLIUL NATIONAL AL AUDIOVIZUALULUI」(CNA) 的評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.cncRating |
string 法國的分級系統 - 委託電影分級委員會 這項房源的有效值如下:
|
contentDetails.contentRating.csaRating |
string 影片來自法國的 Conseil supérieur de l?audiovisuel 分級,該標準為廣播內容評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.cscfRating |
cscf12 至 12cscf16 - 16cscf18 - 18cscf6 - 6cscf9 - 9cscfA - AcscfAl - ALcscfUnrated |
contentDetails.contentRating.czfilmRating |
string 影片在捷克共和國的內容分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.djctqRating |
string 這部影片的 留言 (Deaço de Justiça) 類別。 djctq10 – 10djctq12 至 12djctq14 - 14djctq16 - 16djctq18 - 18djctqL - 公升djctqUnrated |
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 屬性。影片的 Centre 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 - 阿根廷) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.kfcbRating |
string 肯亞電影分級委員會 (Kenya Film Classification Board) 的影片評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.kijkwijzerRating |
string voor de Classificatie van Audiovisuele Media (荷蘭)。 這項屬性的有效值為:
|
contentDetails.contentRating.kmrbRating |
string 影片的韓國媒體評議會 (南韓地區媒體分級委員會) 就參與了。KMRB 為韓國的影片評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.lsfRating |
string 影片為印尼 Lempacka Sensor Film 提供。 這項屬性的有效值如下:
|
contentDetails.contentRating.mccaaRating |
string 馬爾他電影年齡分級委員會的內容分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.mccypRating |
string 影片為丹麥電影協會 (Det Danske Filminstitut) 媒體評議會的兒童和青少年媒體分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.mcstRating |
string 影片在越南的分級系統 - MCST 這項房源的有效值如下:
|
contentDetails.contentRating.mdaRating |
string 影片於新加坡媒體發展局 (MDA) 所得到的評分,特別是電影電影委員會 (BFC)。 這項資產的有效值如下:
|
contentDetails.contentRating.medietilsynetRating |
string 影片為挪威媒體主管機關 Medietilsynet 提供。 這項屬性的有效值如下:
|
contentDetails.contentRating.mekuRating |
string 影片由芬蘭 Kansallinen Audiovisuaalinen Instituutti (國家音訊研究院) 評判。 這項資產的有效值如下:
|
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 美國電影協會 (Movie Picture Association of Film) 為電影預告片和預覽畫面提供的評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.mtrcbRating |
string 您的影片由電影及電視評鑑分級機構 (菲律賓) 所評估。 這項屬性的有效值如下:
|
contentDetails.contentRating.nbcRating |
string 馬爾地夫國家分類研究局的影片。 這個屬性的有效值如下:
|
contentDetails.contentRating.nfrcRating |
string 該影片在保加利亞國家電影中心的評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.nfvcbRating |
string 影片來自奈及利亞國家電影及影片審查委員會的評分。 這項屬性的有效值如下:
|
contentDetails.contentRating.nkclvRating |
nkclv12plus – 12 人以上nkclv18plus – 18 歲以上nkclv7plus – 7 次以上nkclvU - UnkclvUnrated |
contentDetails.contentRating.oflcRating |
string 影片的電影和文學分類辦公室 (OFLC - 紐西蘭) 分級。 這項屬性的有效值如下:
|
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 medierhatd (瑞典國家媒體委員會) 評判。 這項資產的有效值如下:
|
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 物件會封裝與影片相關的主題資訊。重要事項:請參閱 topicDetails.relevantTopicIds[] 和topicDetails.topicIds[] 屬性的定義以及修訂版本記錄,進一步瞭解與主題 ID 相關的近期異動。 |
topicDetails.topicIds[] |
list 重要事項:這項資源已於 2016 年 11 月 10 日淘汰。API 不會再傳回這個屬性的值,且現在所有與影片相關的主題現在都將由 topicDetails.relevantTopicIds[] 屬性值傳回。 |
topicDetails.relevantTopicIds[] |
list 與影片相關的主題 ID 清單。 這項資源已於 2016 年 11 月 10 日淘汰。這項政策將於 2017 年 11 月 10 日提供支援。 重要事項:由於 Freebase 和 Freebase API 已淘汰,主題 ID 已於 2017 年 2 月 27 日開始生效。屆時,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 實際處理上傳影片檔案之前產生。此外,這類 ID 也會發現某些問題,但這不一定表示影片處理作業失敗,但還是可能造成同步問題、視訊構件或缺少音軌等問題。 這個屬性的有效值如下:
|
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 本地化影片說明。 |