本頁列出頻道擁有者可透過 YouTube 數據分析 API 擷取的報表。頻道報表會提供指定頻道的指標,並評估影片觀看次數、評分和訂閱人數等項目。
擷取報表
如要擷取管道報表,您必須在 API 要求中將 ids
參數值設為下列其中一個值:
-
channel==MINE
- API 會傳回已驗證使用者 YouTube 頻道的資料。
-
channel==CHANNEL_ID
:將 CHANNEL_ID
設為要擷取資料的頻道專屬頻道 ID。授權要求的使用者必須是頻道擁有者。
頻道 ID 目前是以字母 UC
開頭的字串,但格式可能會變更。(你可以在 YouTube 頻道的進階帳戶設定頁面中找到頻道 ID,也可以使用 YouTube Data API's channels.list
方法,以程式輔助方式擷取頻道 ID)。
授權
所有 YouTube Analytics API 要求皆須獲得授權。授權指南說明如何使用 OAuth 2.0 通訊協定擷取授權權杖。
YouTube Analytics API 要求會使用下列授權範圍:
範圍 |
https://www.googleapis.com/auth/yt-analytics.readonly |
查看您 YouTube 內容的 YouTube 數據分析報表。這個範圍可存取使用者活動指標,例如觀看次數和評分次數。 |
https://www.googleapis.com/auth/yt-analytics-monetary.readonly |
查看您 YouTube 內容的 YouTube 數據分析金額報表。這個範圍可存取使用者活動指標,以及預估收益和廣告成效指標。 |
https://www.googleapis.com/auth/youtube |
管理 YouTube 帳戶。在 YouTube Analytics API 中,頻道擁有者可使用這個範圍管理 YouTube 數據分析群組和群組項目。 |
https://www.googleapis.com/auth/youtubepartner |
查看及管理 YouTube 上的資產和相關內容。在 YouTube Analytics API 中,內容擁有者可使用這個範圍管理 YouTube 數據分析群組和群組項目。 |
注意:頻道報表目前不支援預估收益和廣告成效指標。因此,https://www.googleapis.com/auth/yt-analytics-monetary.readonly
範圍目前不會授予存取這些報表中貨幣資料的權限。
篩選器
說明支援報表的表格會列出各報表可使用的篩選器。表格中以半形括號顯示的篩選器為選用篩選器。舉例來說,如果是篩選選項 video(,country)
,則必須使用影片篩選器,國家/地區篩選器則為選用。
此外,API 也支援為 video
和 playlist
篩選器指定多個值。如果您為其中一個篩選器指定多個值,也可以將該篩選器新增至您為要求指定的維度清單。即使篩選器未列為特定報表的支援維度,也是如此。
如要完整瞭解如何依特定值或值集篩選 API 結果,請參閱 filters
參數定義。
瞭解報表表格
本節說明定義 API 支援報表的表格所使用的格式和術語。下表列出使用時間維度和 averageViewPercentage 指標時,播放詳細資料影片報表支援的維度、指標和篩選器。
表格包含兩個維度資料列、一個指標資料列和三個篩選條件資料列。對於維度和篩選器,只要組合符合表格中的使用規則,API 要求中就能合併每個資料列的值。舉例來說,這份報表的有效 dimensions
參數值包括:
dimensions=day
dimensions=day,subscribedStatus
dimensions=month,subscribedStatus,youtubeProduct
dimensions=month,youtubeProduct
不過,參數值 day,month
無效,因為它使用兩個時間維度,而要求必須使用 0 或 1。
報表表格術語
表格會使用下列術語,指出維度是必要還是選用:
- 下列字詞表示必須提供值:
- 必要:您必須加入值。
- 只能使用 1 個:你必須從群組中加入一個值。
- 使用 1 個以上:您可以納入群組中的任何或所有值,但至少須納入一個。
- 下列字詞表示值為選用:
- 選用:您可以選擇納入值。
- 使用 0 或 1:你可以選擇納入群組中的一個值。
- 使用 0 個以上的值:您可以選擇納入群組中的任何或所有值。
影片報表
基本數據
基本使用者活動統計資料
這份報表提供與使用者在頻道中進行的動作相關的統計資料。您可以篩選報表,只傳回特定影片或國家/地區的資料。
美國各州的基本使用者活動統計資料
這份報表提供特定美國州別或哥倫比亞特區的統計資料。請注意,這份報表僅支援上述國家/地區專屬報表中的部分指標。
根據時間
特定時間範圍內的使用者活動 (按國家/地區劃分)
這份報表提供特定時間間隔內,使用者在頻道上執行動作的相關統計資料。您可以篩選報表,只傳回特定影片或國家/地區的資料。
特定時間範圍內,美國各州的使用者活動
這份報表提供特定美國州別或哥倫比亞特區的使用者活動統計資料。請注意,這份報表僅支援上述國家/地區專屬報表中的部分指標。
使用者地理位置
使用者活動 (按國家/地區)
這份報表提供頻道在各個國家/地區的使用者活動統計資料。您可以篩選報表,只傳回特定影片的資料。
使用者活動 (依省分組)
這份報表提供美國各州和哥倫比亞特區的使用者活動統計資料。
如要產生這份報表,請將 filters
參數值設為 country==US
。
依城市劃分的使用者活動 (最多 250 項結果)
注意:如要產生這份報表,請將 maxResults
參數設為小於或等於 250
的整數值。與大多數其他報表不同,這份報表也需要您為 sort
要求參數指定值。
這份報表提供按城市劃分的使用者活動統計資料。
按 DMA 劃分的使用者活動
這份報表提供指定市場區域 (DMA) 的使用者活動統計資料。如要取得這份報表,您必須將 filters
參數值設為 country==US
,或是篩選特定省份 (美國州別)。
播放詳細資料
播放詳細資料報表提供與下列觀看屬性相關的統計資料:
- 觀看的是直播影片還是隨選影片?
- 觀眾是否訂閱影片所屬頻道?
- 觀看次數是在哪個 YouTube 產品上產生?
注意:liveOrOnDemand 維度和篩選器無法與 averageViewPercentage 指標一併使用。因此,下列每個小節都會列出兩份報表。其中一份報表支援 liveOrOnDemand 維度 (和篩選器),另一份則支援 averageViewPercentage 指標。
使用者活動 (按訂閱狀態劃分)
這份報表提供訂閱者和非訂閱者的使用者活動指標。統計資料可依時間範圍 (天或月) 分組,報表也可依國家/地區、洲或subContinent篩選。
各省份使用者活動 (依訂閱狀態劃分)
這份報表提供美國各州或哥倫比亞特區的訂閱者和非訂閱者觀眾使用者活動指標。這份報表支援的指標比舊版報表少。
播放詳細資料 (可選時間維度)
這些報表可選擇是否加入時間維度 (天或月),因為無論如何,您都必須使用 startDate
和 endDate
要求參數,指定報表涵蓋的日期範圍。如果維度存在,表示您希望報表中的資料依日期、月份等彙整。
這份報表會提供特定時間間隔的播放詳細統計資料。支援 liveOrOnDemand 維度 (和篩選器)。
這份報表會提供特定時間間隔的播放詳細統計資料。支援 averageViewPercentage 指標。
依國家/地區劃分的播放詳細資料
這份報表提供各國家/地區的播放詳細資料統計數據。支援 liveOrOnDemand 維度 (和篩選器)。
以下報表與前一個類似,這個版本新增了averageViewPercentage指標的支援,但不支援將liveOrOnDemand做為維度或篩選器。
各省份的播放詳細資料
這份報表提供美國各州和哥倫比亞特區的播放詳細統計資料。支援 liveOrOnDemand 維度 (和篩選器)。
以下報表與前一個類似,這個版本新增了averageViewPercentage指標的支援,但不支援將liveOrOnDemand做為維度或篩選器。
播放位置
影片播放位置報表
這份報表提供影片播放次數的統計資料,並依據播放影片的頁面或應用程式類型分類。
播放位置詳細資料 (最多 25 項結果)
注意:如要產生這份報表,請將 maxResults
參數設為 25
以下的整數值。與大多數其他報表不同,這份報表也需要您為 sort
要求參數指定值。
這份報表會找出為頻道影片帶來最多觀看次數或觀看時間的嵌入式影片播放器。
流量來源
流量來源
這份報表會根據觀眾觀看影片內容的方式,匯總觀看統計資料。舉例來說,這項指標會指出 Google 搜尋或相關影片連結帶來的觀看次數。
注意:如果「查詢的影片數量」X「日期範圍內的天數」超過 50,000,這份報表就會傳回錯誤。舉例來說,如果查詢擷取 500 個影片 ID 的資料,最多可要求 100 天的資料。如要減少要求傳回的列數,請將查詢拆分為多個查詢,並指定較少的影片或設定較短的日期範圍。
流量來源詳細資料 (最多 25 項結果)
注意:如要產生這份報表,請將 maxResults
參數設為 25
以下的整數值。與大多數其他報表不同,這份報表也需要您為 sort
要求參數指定值。
這份報表會根據為頻道內容帶來最多觀看次數的參照網址,彙整觀看統計資料。參照連結網址會依流量來源類型分類,而 insightTrafficSourceDetail 維度的定義會指出報表適用的流量來源。舉例來說,如果將 insightTrafficSourceType 篩選器設為 ADVERTISING
,報表就會列出為頻道內容帶來最多觀看次數或觀看時間的廣告類型。
注意:這份報表僅支援特定流量來源。VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
和 NO_LINK_EMBEDDED
流量來源就是不支援的來源。
裝置類型和作業系統
裝置類型
這份報表會根據觀眾觀看影片內容的方式,匯總觀看統計資料。舉例來說,這項指標會顯示行動裝置或遊戲主機的觀看次數。
作業系統
這份報表會根據觀眾的作業系統匯總觀看統計資料。舉例來說,這項資料會指出在 Android 裝置或 PlayStation 上發生的觀看次數。
作業系統和裝置類型
這份報表會根據觀眾的作業系統和裝置類型,匯總觀看統計資料。舉例來說,這項指標會指出在 Android 平板電腦或 Windows 桌機上發生的觀看次數。
觀眾客層
這份報表會根據觀眾的年齡層和性別匯總觀看統計資料。
參與度和內容分享
這份報表會顯示頻道影片在不同社群平台上的分享頻率統計資料。
觀眾續看率
這份報表會評估影片留住觀眾的能力,並顯示特定片段的觀看頻率。elapsedVideoTimeRatio
維度會測量相應指標值經過的影片時間量。指標可分為兩類:
-
觀眾續看率
這些指標會顯示影片吸引觀眾駐足觀看的成效。
-
詳細觀看統計資料
這些指標會提供影片特定部分的觀看次數資訊。
注意:這份報表不支援為 video
篩選器指定以半形逗號分隔的值清單;值必須指定單一影片 ID。
同時觀看人數 (直播)
這份報表會顯示單一直播影片在特定時間點的同時線上人數。
篩選器會指定影片。位置維度通常代表一分鐘。
熱門影片
注意:如要使用這些報表,請將 maxResults
參數設為 200
以下的整數值。2013 年 1 月 1 日前的資料僅適用於前 10 大影片。與大多數其他報表不同,這些報表也需要您為 sort
要求參數指定值。
熱門影片 (可選用區域篩選器,最多 200 個結果)
這份報表會列出頻道的熱門影片,你可以篩選報表,依國家/地區、洲別或subContinent列出熱門影片。
各州熱門影片 (最多 200 個結果)
這份報表會列出頻道在特定美國州或哥倫比亞特區的熱門影片。請注意,這份報表僅支援上述國家/地區專屬報表中的部分指標。
訂閱者或未訂閱者的熱門影片(最多 200 個結果)
這份報表會列出頻道最受訂閱者或未訂閱者歡迎的影片。你可以篩選報表,依國家/地區、洲別或subContinent列出熱門影片。先前的報表可讓您擷取特定美國州別中,訂閱者或未訂閱者的熱門影片,但支援的指標比這份報表少。
依 YouTube 產品列出的熱門影片 (最多 200 個結果)
這份報表會列出頻道的熱門影片,並支援播放詳細資料和地理位置篩選器。這份報表與前一份報表類似,但支援的指標較少,並新增了 youtubeProduct 篩選器。
熱門影片 (含播放詳細資料篩選器) (<= 200 個結果)
這份報表會列出頻道熱門影片,並依據任何或所有播放詳細資料維度進行篩選:liveOrOnDemand、subscribedStatus 和 youtubeProduct。與先前的報表不同,這份報表支援 liveOrOnDemand 篩選器,但不支援 averageViewPercentage 指標。
播放清單報表
播放清單報表包含與使用者活動相關的指標,這些活動與頻道擁有者播放清單中的影片有關。這些報表有兩個版本,以下各節將說明每個版本:
匯總影片指標
這些指標提供使用者活動和曝光指標,彙整播放清單中所有影片的資料,且這些影片也屬於播放清單所屬的頻道。系統不會在匯總中計算其他頻道擁有的影片指標。因此,如果頻道建立的播放清單只包含其他頻道的影片,這些播放清單的報表就不會提供這些指標的值。
如需 YouTube 支援的匯總影片指標清單,請參閱「支援的播放清單指標」一節。
播放清單內指標
這些指標反映使用者在播放清單頁面中的活動和參與度。這些指標包括播放清單中所有影片的觀看次數,無論影片屬於哪個頻道,但只會計算在播放清單中發生的觀看次數。
支援的播放清單指標
基本數據
這份報表提供使用者與頻道播放清單中影片互動的相關統計資料。您可以篩選報表,只傳回特定播放清單的資料。
根據時間
這份報表提供使用者與頻道播放清單中影片互動的相關統計資料。您可以篩選報表,只傳回特定播放清單的資料。
使用者地理位置
各國家/地區的播放清單活動
這份報表提供特定國家/地區使用者與頻道播放清單中影片互動的相關統計資料。
按省份劃分的播放清單活動
這份報表提供美國各州和哥倫比亞特區的播放清單活動統計資料。
這份報表必須篩選結果,只傳回美國的資料。
播放位置
這份報表提供統計資料,說明播放清單影片的播放次數來自哪種網頁或應用程式。
播放位置詳細資料 (最多 25 項結果)
注意:如要產生這份報表,請將 maxResults
參數設為 25
以下的整數值。與大多數其他報表不同,這份報表也需要您為 sort
要求參數指定值。
這份報表會找出嵌入式影片播放器,並顯示頻道播放清單中的影片透過這些播放器獲得的觀看次數或觀看時間。
流量來源
這份報表會根據觀眾觀看播放清單內容的方式,匯總觀看統計資料。
舉例來說,這項指標會指出 Google 搜尋帶來的觀看次數。
流量來源詳細資料 (最多 25 項結果)
注意:如要產生這份報表,請將 maxResults
參數設為 25
以下的整數值。與大多數其他報表不同,這份報表也需要您為 sort
要求參數指定值。
這份報表會根據為頻道播放清單中的影片帶來最多觀看次數的參照網址,匯總觀看統計資料。推薦來源會依流量來源類型分類,而 insightTrafficSourceDetail 維度的定義會指出報表適用的流量來源。
舉例來說,如果將 insightTrafficSourceType 篩選器設為 ADVERTISING
,報表就會列出為頻道播放清單帶來最多觀看次數或觀看時間的廣告類型。
注意:這份報表僅支援特定流量來源。VIDEO_REMIXES
、NOTIFICATION
、END_SCREEN
、CAMPAIGN_CARD
、VIDEO_REMIXES
和 NO_LINK_EMBEDDED
流量來源就是不支援的來源。
裝置類型和作業系統
裝置類型
這份報表會根據觀眾觀看播放清單中影片的方式,匯總觀看統計資料。舉例來說,這項指標會顯示在行動裝置或遊戲主機上發生的觀看次數。
作業系統
這份報表會根據觀眾的作業系統匯總觀看統計資料。舉例來說,這項資料會指出在 Android 裝置或 PlayStation 上發生的觀看次數。
作業系統和裝置類型
這份報表會根據觀眾的作業系統和裝置類型,匯總觀看統計資料。
舉例來說,這項功能會指出 Android 平板電腦或 Windows 電腦裝置的觀看次數。
觀眾客層
觀看時間最長的播放清單
注意:如要使用這些報表,請將 maxResults
參數設為 200
以下的整數值。2013 年 1 月 1 日之前的資料僅適用於前 10 名的播放清單。與大多數其他報表不同,這些報表也需要您為 sort
要求參數指定值。
這份報表會根據指定的篩選和排序條件,列出頻道熱門播放清單。
會員報表
取消會籍
這份報表會顯示使用者取消頻道會員的原因。
注意:廣告成效報表需要授權權杖,才能授予 https://www.googleapis.com/auth/yt-analytics-monetary.readonly
範圍的存取權。
廣告成效報表會提供影片播放期間放送廣告的曝光次數指標。這些指標會計算每次廣告曝光,而每次播放影片可能會產生多次曝光。
以曝光為準的廣告成效指標包括:
此外,部分影片報表支援下列以播放為準的廣告成效指標。不過,廣告成效報表不會納入這些指標。