YouTube Reporting API

開發人員可透過 YouTube Reporting API 排定報表工作，然後下載產生的大量報表。這項 API 支援一組預先定義的報表，每份報表都包含頻道或內容擁有者的完整 YouTube 數據分析資料。

以下步驟說明如何安排報表工作排程及擷取報表：

  1. 呼叫 reportTypes.list() 方法，擷取頻道或內容擁有者可擷取的報表清單。
  2. 呼叫 jobs.create() 方法，找出應為頻道或內容擁有者產生的報表。您隨後可以使用 API 的 jobs.list() 和 jobs.delete()，擷取或變更要產生的報表清單。
  3. 呼叫 jobs.reports.list() 方法，擷取特定工作產生的報表清單。回應中的每個資源都包含 downloadUrl 屬性，用於指定可下載報表的網址。
  4. 傳送已授權的 GET 要求，從下載網址擷取報表。

授權

所有 YouTube Reporting API 要求皆須獲得授權。授權指南說明如何使用 OAuth 2.0 通訊協定擷取授權權杖。

YouTube Reporting API 要求會使用下列授權範圍：

範圍 說明
https://www.googleapis.com/auth/yt-analytics.readonly 查看您 YouTube 內容的 YouTube 數據分析報表。這個範圍可存取使用者活動指標，例如觀看次數和評分次數。
https://www.googleapis.com/auth/yt-analytics-monetary.readonly 查看您 YouTube 內容的 YouTube 數據分析金額報表。這個範圍可存取使用者活動指標，以及預估收益和廣告成效指標。

資源類型

以下各節將提供 API 資源和方法的一般說明。表格中顯示的所有方法 URI 皆與 https://youtubereporting.googleapis.com 相關。

jobs

方法
create POST /v1/jobs
建立報表工作。建立報表工作後，YouTube 就會每天產生報表。工作建立後 24 小時內，您就能查看報表。
delete DELETE /v1/jobs/{jobId}
刪除報表工作。
get GET /v1/jobs/{jobId}
擷取已排定頻道或內容擁有者使用的特定報表工作相關資訊。
list GET /v1/jobs
列出已為頻道或內容擁有者排定的報表工作。回應中的每個資源都包含 id 屬性，指定 YouTube 用來識別工作的專屬 ID。您需要這個 ID 才能擷取為工作產生的報表清單，或刪除工作。

jobs.reports

方法
get GET /v1/jobs/{jobId}/reports/{reportId}
擷取特定報表的中繼資料。
list GET /v1/jobs/{jobId}/reports
列出為指定報表工作產生的報表。

reportTypes

方法
list GET /v1/reportTypes
傳回頻道或內容擁有者可擷取的報表類型清單。