本頁面列出頻道擁有者可透過 YouTube Analytics 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 Analytics 群組和群組項目。
https://www.googleapis.com/auth/youtubepartner
查看及管理 YouTube 素材資源和相關內容。在 YouTube Analytics API 中,內容擁有者可使用這個範圍管理 YouTube Analytics 群組和群組項目。
注意: 管道報表目前不支援預估收益和廣告成效指標。因此,https://www.googleapis.com/auth/yt-analytics-monetary.readonly
範圍目前不會授予這些報表中的金錢資料存取權。
篩選器
下表說明支援的報表,並指出可用於每份報表的篩選器。在表格中,括號內的篩選器為選用項目。舉例來說,如果使用篩選選項 video(,country)
,就必須使用 video 篩選器,但 country 篩選器則為選用。
這個 API 也支援為 video
和 playlist
篩選器指定多個值。如果您為其中一個篩選器指定多個值,也可以將該篩選器新增至您為要求指定的維度清單。即使篩選器未列為特定報表的支援維度,也一樣適用。
請參閱 filters
參數定義,瞭解如何篩選特定值或值組合的 API 結果。
瞭解報表表格
本節說明定義 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) 提供使用者活動統計資料。針對這份報表,您必須將 filters
參數值設為 country==US
,或篩選特定省份/州。
播放詳細資料
播放詳細資料報表提供下列觀看屬性相關的統計資料:
觀看的是直播影片還是隨選影片?
觀眾是否訂閱影片擁有者的頻道?
觀看次數是在哪項 YouTube 產品上產生?
注意: liveOrOnDemand 維度和篩選器無法與 averageViewPercentage 指標搭配使用。因此,下列各個子區段都會列出兩份報表。其中一個報表支援「liveOrOnDemand」liveOrOnDemand 維度 (和篩選器),另一個報表則支援「averageViewPercentage」averageViewPercentage 指標。
按訂閱狀態劃分的使用者活動
這份報表會提供訂閱和未訂閱觀眾的使用者活動指標。統計資料可依時間範圍 (一天 或一個月 ) 分組,報表也可以依國家/地區 、大陸 或subContinent 進行篩選。
使用者活動 (按省份劃分,依訂閱狀態而定)
這份報表提供美國各州或哥倫比亞特區訂閱和非訂閱觀眾的使用者活動指標。這份報表支援的指標比先前的報表少。
播放詳細資料 (含選用時間維度)
這些報表的時間維度 (day 或 month ) 為選用項目,因為無論如何,您都需要使用 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」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 指標。
播放清單報表
播放清單報表包含與頻道擁有者播放清單中影片相關的使用者活動指標。這類報表有兩種版本,每個可用報表的版本說明請見以下各節:
每個部分的「建議」 分頁會說明擷取對應報表的偏好 API 要求格式。建議的報表支援更多指標,包括匯總影片指標 和播放清單內指標 。這類要求格式不會使用 isCurated
維度。
每個部分的「使用 isCurated
」 分頁說明舊版 API 要求格式,其中需要 isCurated
維度。這些報表僅支援播放清單內指標 。請注意,isCurated
維度已不適用於所有報表。下方的警告附註說明瞭淘汰時間表。
下列警告說明會詳細說明這兩個報表版本之間的差異。
重要事項: 請在 2024 年 6 月 30 日前更新頻道的播放清單報表,並在 2024 年 12 月 31 日前更新內容擁有者的播放清單報表。請注意下列變更:
isCurated
維度已淘汰。
管道報表 :自 2024 年 6 月 30 日起,我們將不再支援這個維度。
針對內容擁有者報表 ,系統將自 2024 年 12 月 31 日起停止支援這個維度。
從擷取播放清單報表要求中移除 isCurated
維度後,views
指標的行為會有所變更:
如果要求包含 isCurated
維度,views
指標會指出影片在播放清單中觀看次數。
如果要求不包含 isCurated
維度,views
指標會指定影片的總觀看次數,而 playlistViews
指標則會指出影片在播放清單中觀看次數。
因此,如要移除 isCurated
維度時保留向後相容性,您必須更新程式碼,讓程式碼只擷取播放清單報表的 playlistViews
指標,而非 views
指標。由於播放清單報表仍支援 views
指標 (但意義不同),因此如果您未更新指標名稱,API 仍會傳回資料。當然,您也可以修改應用程式,同時擷取及顯示 views
和 playlistViews
。
詳情請參閱修訂版本記錄 。
匯總影片指標
這些指標會提供使用者活動和曝光次數指標,彙整播放清單中所有影片的數據,而這些影片也屬於擁有播放清單的頻道。匯總資料不會計算其他頻道擁有的影片指標。因此,如果頻道建立的播放清單只包含其他頻道擁有的影片,這些播放清單的報表就不會提供這些指標的值。
如需 YouTube 支援的匯總影片指標清單,請參閱「支援的播放清單指標 」一節。
播放清單內指標
這些指標反映播放清單頁面中的使用者活動和參與度。這些指標包括播放清單中所有影片的觀看次數,不論影片屬於哪個頻道,但只計算在播放清單中發生的觀看次數。
支援的播放清單指標
重要事項: 如下表所示,views
指標會在每個播放清單報表的兩種可用版本中提供不同類型的資料。
在建議 的報表格式中,views
是匯總的影片指標。
在使用 isCurated
維度擷取的報表 中,views
是播放清單內的指標。
基本統計資料
這份報表提供與使用者與頻道播放清單中影片互動相關的統計資料。你可以篩選報表,只傳回特定播放清單的資料。
根據時間
這份報表提供與使用者與頻道播放清單中影片互動相關的統計資料。你可以篩選報表,只傳回特定播放清單的資料。
使用者地理位置
播放清單活動 (按國家/地區劃分)
這份報表提供與特定國家/地區使用者與頻道播放清單中影片互動相關的統計資料。
按省份劃分的播放清單活動
這份報表提供美國各州和哥倫比亞特區的播放清單活動統計資料。針對這份報表,您必須篩選結果,只傳回美國的資料。
播放位置
這份報表會提供與播放清單影片播放位置相關的網頁或應用程式類型統計資料。
播放位置詳細資料 (<= 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
範圍的存取權。
廣告成效報表會針對影片播放期間放送的廣告,提供以曝光次數為依據的指標。這些指標會計算每則廣告曝光,而每次播放影片可能會產生多個曝光。
以曝光為準的廣告成效指標如下:
此外,部分影片報表 支援下列以播放次數為準的廣告成效指標。不過,這些指標不會列入廣告成效報表。