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
},
"brandPartner": {
"channelId": string,
"channelHandle": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}屬性
下表定義這項資源中顯示的屬性:
| 屬性 | |
|---|---|
kind |
string識別 API 資源的類型。值為 youtube#video。 |
etag |
etag這項資源的 Etag。 |
id |
stringYouTube 用來識別影片的專屬 ID。 |
snippet |
objectsnippet 物件包含影片的基本詳細資料,例如標題、說明和類別。 |
snippet.publishedAt |
datetime影片的發布日期和時間。這個時間可能與影片上傳時間不同。舉例來說,如果影片上傳時設為私人,之後才設為公開,這個屬性就會指定影片設為公開的時間。 以下是幾種特殊情況:
|
snippet.channelId |
stringYouTube 用來識別影片上傳頻道的專屬 ID。這個值可能會隨著時間變動,例如影片重新指派給其他頻道 (例如主題頻道或藝人頻道)。 |
snippet.title |
string影片標題。屬性值的長度上限為 100 個字元,可包含所有有效的 UTF-8 字元,但 < 和 > 除外。如果您呼叫 videos.update 方法,並更新 video 資源的 snippet 部分,則必須為這個屬性設定值。 |
snippet.description |
string影片說明。屬性值的長度上限為 5,000 個位元組,可包含所有有效的 UTF-8 字元,但 < 和 > 除外。 只要在說明文字中加入格式正確的時間戳記 (例如 00:00),即可建立影片章節。 |
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 |
stringvideo 資源的 snippet.title 和 snippet.description 屬性中文字的語言。 |
snippet.localized |
objectsnippet.localized 物件包含影片的本地化標題和說明,或影片中繼資料預設語言的標題。
localizations 物件新增、更新或刪除本地化標題。 |
snippet.localized.title |
string本地化的影片標題。 |
snippet.localized.description |
string本地化影片說明。 |
snippet.defaultAudioLanguage |
stringdefault_audio_language 屬性會指定影片預設音軌中使用的語言。 |
contentDetails |
objectcontentDetails 物件包含影片內容的相關資訊,包括影片長度,以及影片是否提供字幕。 |
contentDetails.duration |
string影片長度。屬性值為 ISO 8601 格式的持續時間。舉例來說,如果影片長度至少一分鐘,但不到一小時,則長度格式為 PT#M#S,其中字母 PT 表示該值指定的是時間長度,而字母 M 和 S 分別代表長度 (以分鐘和秒為單位)。M 和 S 字母前面的 # 字元都是整數,用於指定影片的分鐘數 (或秒數)。舉例來說,如果值為 PT15M33S,表示影片長度為 15 分 33 秒。如果影片長度至少一小時,則時間長度會採用 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 |
objectregionRestriction 物件包含影片可 (或不可) 觀看的國家/地區資訊。物件會包含 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泰國電影與影片審查委員會 (Board of Film and Video Censors) 評定的影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.bmukkRating |
string奧地利媒體分級委員會 (Bundesministerium für Unterricht, Kunst und Kultur) 針對影片的分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.catvRating |
string加拿大電視分級制度 - 加拿大電視分級制度 (Canadian TV Classification System) 加拿大廣播電視及通訊委員會 (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影片的比利時電影審查委員會 (Commission de Contrôle des Films) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.cnaRating |
string羅馬尼亞 CONSILIUL NATIONAL AL AUDIOVIZUALULUI (CNA) 影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.cncRating |
string法國分級制度 - Commission de classification cinematographique 這項屬性的有效值如下:
|
contentDetails.contentRating.csaRating |
string影片的法國高等視聽委員會 (Conseil supérieur de l'audiovisuel) 分級,該委員會負責為廣播內容分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.cscfRating |
string影片的盧森堡電影分級監督委員會 (CSCF) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.czfilmRating |
string影片在捷克的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.djctqRating |
string影片的巴西司法部、分級、資格和標題 (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 屬性。影片的法國國家電影與動畫中心 (法國文化部) 分級。 這個屬性的有效值如下:
|
contentDetails.contentRating.fpbRating |
string影片在南非電影與出版委員會 (Film and Publication Board) 的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.fpbRatingReasons[] |
list影片獲得 FPB (南非) 分級的原因。 |
contentDetails.contentRating.fskRating |
string影片的 Freiwillige Selbstkontrolle der Filmwirtschaft (FSK - 德國) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.grfilmRating |
string影片在希臘的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.icaaRating |
string影片的西班牙電影與視聽藝術協會 (ICAA) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.ifcoRating |
string影片的愛爾蘭電影分級辦公室 (IFCO - 愛爾蘭) 分級。詳情請參閱 IFCO 網站。 這項屬性的有效值如下:
|
contentDetails.contentRating.ilfilmRating |
string影片在以色列的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.incaaRating |
string影片的 INCAA (Instituto Nacional de Cine y Artes Audiovisuales - Argentina) 分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.kfcbRating |
string肯亞電影分級委員會 (Kenya Film Classification Board) 的影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.kijkwijzerRating |
stringvoor de Classificatie van Audiovisuele Media (荷蘭)。 這項屬性的有效值如下:
|
contentDetails.contentRating.kmrbRating |
string影片的韓國影像物等級委員會 (영상물등급위원회) 分級。KMRB 負責韓國的影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.lsfRating |
string印尼 Lembaga Sensor Film 授予的影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.mccaaRating |
string馬爾他電影年齡分級委員會 (Film Age-Classification Board) 針對影片的分級。 這項屬性的有效值如下:
|
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美國電影協會對電影預告片和預覽影片的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.mtrcbRating |
string影片在菲律賓影視審查與分級委員會 (MTRCB) 的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.nbcRating |
string馬爾地夫國家分類局 (Maldives National Bureau of Classification) 的影片分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.nfrcRating |
string保加利亞國家電影中心對影片的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.nfvcbRating |
string奈及利亞國家電影和影片審查委員會 (National Film and Video Censors Board) 評定的影片分級。 這項屬性的有效值如下:
|
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 |
stringStatens medieråd (瑞典國家媒體委員會) 為影片評定的分級。 這項屬性的有效值如下:
|
contentDetails.contentRating.tvpgRating |
string影片的美國電視節目分級 (TVPG) 評等。 這項屬性的有效值如下:
|
contentDetails.contentRating.ytRating |
stringYouTube 用來識別年齡限制內容的分級。 這項屬性的有效值如下:
|
contentDetails.projection |
string指定影片的投影格式。 這項屬性的有效值如下:
|
contentDetails.hasCustomThumbnail |
boolean指出影片上傳者是否為影片提供自訂縮圖。只有影片上傳者才能看到這項屬性。 |
status |
objectstatus 物件包含影片的上傳、處理和隱私權狀態資訊。 |
status.uploadStatus |
string上傳影片的狀態。 這項屬性的有效值如下:
|
status.failureReason |
string這個值說明影片上傳失敗的原因。只有在 uploadStatus 屬性指出上傳失敗時,才會顯示這個屬性。這個屬性的有效值如下:
|
status.rejectionReason |
string這個值說明 YouTube 拒絕上傳影片的原因。只有在 uploadStatus 屬性指出上傳遭拒時,才會顯示這項屬性。這項屬性的有效值如下:
|
status.privacyStatus |
string影片的隱私權狀態。在 videos.insert 要求中,如未指定這項屬性的值,上傳影片的隱私狀態預設為 public。根據創作者帳戶設定,某些上傳內容可能會預設為private,詳情請參閱 YouTube 說明中心。透過未經驗證的 API 專案上傳的影片,不會限制為私人觀看模式。這項屬性的有效值如下:
|
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 |
objectstatistics 物件包含影片的統計資料。 |
statistics.viewCount |
unsigned long影片的觀看次數。 無論是長篇影片、直播或 Shorts, 對於所有影片格式 (長篇影片、直播和 Shorts), |
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影片的留言數。 |
paidProductPlacementDetails |
objectpaidProductPlacementDetails 物件包含影片中付費商品置入的相關資訊。 |
paidProductPlacementDetails.hasPaidProductPlacement |
boolean如果內容使用付費商品置入,請設為 true。如果內容未使用付費商品置入,請設為 false。 |
player |
objectplayer 物件包含在嵌入式播放器中播放影片所需的資訊。 |
player.embedHtml |
string內嵌播放器來播放影片的 <iframe> 標記。 |
player.embedHeight |
longplayer.embedHtml 屬性傳回的嵌入式播放器高度。只有在要求指定 maxHeight 和/或 maxWidth 參數的值,且影片的顯示比例已知時,系統才會傳回這項屬性。 |
player.embedWidth |
longplayer.embedHtml 屬性傳回的內嵌播放器寬度。只有在要求指定 maxHeight 和/或 maxWidth 參數的值,且影片的顯示比例已知時,系統才會傳回這項屬性。 |
topicDetails |
objecttopicDetails 物件會封裝與影片相關主題的資訊。重要事項:請參閱 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 |
objectrecordingDetails 物件會封裝影片錄製地點、日期和地址的相關資訊。 |
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 |
objectfileDetails 物件會封裝上傳至 YouTube 的影片檔案相關資訊,包括檔案的解析度、時間長度、音訊和影片轉碼器、串流位元率等。只有影片擁有者可以擷取這項資料。只有在 processingDetails.fileAvailability 屬性的值為 available 時,系統才會傳回 fileDetails 物件。 |
fileDetails.fileName |
string上傳檔案的名稱。無論上傳的是影片檔案或其他類型的檔案,都會顯示這個欄位。 |
fileDetails.fileSize |
unsigned long上傳檔案的大小,以位元組為單位。無論上傳的是影片檔案或其他類型的檔案,都會顯示這個欄位。 |
fileDetails.fileType |
stringYouTube 影片處理引擎偵測到的上傳檔案類型。目前 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 |
stringYouTube 必須旋轉原始來源內容的角度,才能正確顯示影片。 這項屬性的有效值如下:
|
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 |
objectprocessingDetails 物件會封裝 YouTube 處理上傳影片檔案的進度資訊。物件中的屬性會指出目前的處理狀態,以及 YouTube 完成影片處理作業的預估剩餘時間。這部分也會指出影片是否提供不同類型的資料或內容,例如檔案詳細資料或縮圖。processingProgress 物件的設計目的是輪詢,讓上傳的影片可以追蹤 YouTube 處理上傳影片檔案的進度。只有影片擁有者可以擷取這項資料。 |
processingDetails.processingStatus |
string影片的處理狀態。這個值代表 YouTube 是否能處理影片,或影片是否仍在處理中。 這個屬性的有效值如下:
|
processingDetails.processingProgress |
objectprocessingProgress 物件包含 YouTube 處理影片的進度資訊。只有在影片的處理狀態為 processing 時,這些值才具有意義。 |
processingDetails.processingProgress.partsTotal |
unsigned long預估影片需要處理的部分總數。YouTube 處理影片時,可能會更新這項數據,提供更精確的預估值。 |
processingDetails.processingProgress.partsProcessed |
unsigned longYouTube 已處理的影片部分數量。你可以透過以下公式,估算 YouTube 已處理的影片百分比: 100 * parts_processed / parts_total請注意,預估片段數量可能會增加,但已處理的片段數量不一定會增加,因此在 YouTube 處理影片時,計算出的進度可能會不時減少。 |
processingDetails.processingProgress.timeLeftMs |
unsigned longYouTube 預估完成影片處理所需的時間,以毫秒為單位。 |
processingDetails.processingFailureReason |
stringYouTube 無法處理影片的原因。只有在 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 |
objectsuggestions 物件會封裝建議,指出可改善上傳影片畫質或中繼資料的機會。只有影片擁有者可以擷取這項資料。只有在 processingDetails.tagSuggestionsAvailability 屬性或 processingDetails.editorSuggestionsAvailability 屬性的值為 available 時,系統才會傳回 suggestions 物件。 |
suggestions.processingErrors[] |
list這份清單列出會導致 YouTube 無法成功處理上傳影片的錯誤。這些錯誤表示無論影片目前的處理狀態為何,最終狀態幾乎可以確定是 failed。這個屬性的有效值如下:
|
suggestions.processingWarnings[] |
listYouTube 可能無法轉碼上傳影片,或轉碼錯誤的原因。YouTube 實際處理上傳的影片檔案前,會先產生這些警告。此外,這類訊息也會指出不一定會導致影片處理失敗,但仍可能造成同步問題、影片不自然感或音軌遺失等問題。 這項屬性的有效值如下:
|
suggestions.processingHints[] |
list這份建議清單可協助 YouTube 提升影片處理能力。 這個屬性的有效值如下:
|
suggestions.tagSuggestions[] |
list可新增至影片中繼資料的關鍵字標記清單,有助於提高使用者在 YouTube 搜尋或瀏覽時找到影片的可能性。 |
suggestions.tagSuggestions[].tag |
string建議用於影片的關鍵字標記。 |
suggestions.tagSuggestions[].categoryRestricts[] |
list與代碼相關的一組影片類別。你可以根據影片上傳者為影片設定的類別,顯示合適的標記建議。根據預設,如果關鍵字沒有定義任何限制,則標記建議會與所有類別相關。 |
suggestions.editorSuggestions[] |
list影片編輯作業清單,可能改善上傳影片的畫質或播放體驗。 這項屬性的有效值如下:
|
liveStreamingDetails |
objectliveStreamingDetails 物件包含即時影像廣播的中繼資料。只有在影片是即將開始、正在進行或已結束的現場直播時,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 將不再與這部影片連結,而是與持續性頁面上顯示的新影片連結。 |
brandPartner |
objectbrandPartner 物件包含與影片連結的品牌合作夥伴詳細資料,用於創作者提出的品牌合作夥伴存取權 (CI BPA)。 |
brandPartner.channelId |
string品牌合作夥伴的外部頻道 ID。這個欄位必須以「UC」開頭。建立存取權時,必須設定 channelId 或 channelHandle,但回應中只會傳回 channelId。 |
brandPartner.channelHandle |
string品牌合作夥伴的頻道帳號代碼。這個欄位必須以「@」開頭。建立存取權時,必須設定 channelId 或 channelHandle,但回應中只會傳回 channelId。 |
localizations |
objectlocalizations 物件包含影片中繼資料的翻譯。 |
localizations.(key) |
object與鍵值相關聯的本地化文字語言。這個值是包含 BCP-47 語言代碼的字串。 |
localizations.(key).title |
string本地化的影片標題。 |
localizations.(key).description |
string本地化影片說明。 |