Reports

report 資源會識別報表的特定例項。資源會顯示報表內包含資料的時間範圍和報表下載網址。

方法

下表列出 API 為 report 資源支援的方法。

方法
get	擷取特定報表的中繼資料。
list	列出系統為指定報表工作產生的報表。

JSON 資源表示法

以下 JSON 結構顯示 report 資源的格式：

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

屬性

下表定義了這個資源中顯示的屬性：

屬性
id	string YouTube 為報表指派的專屬 ID。每份報表都與單一工作相關聯，但同一工作可能會與多個報表 ID 建立關聯。
jobId	string 建立這份報表的工作 ID。
startTime	timestamp 報表執行個體涵蓋時間範圍的開始時間。內含值是採用 RFC3339 UTC「Zulu」的時間戳記格式，精確到微秒。範例："2015-10-02T15:01:23.045678Z"。
endTime	timestamp 報表執行個體涵蓋時間範圍的結束時間。這個專屬值是採用 RFC3339 世界標準時間「Zulu」的時間戳記格式，精確到微秒。範例："2015-10-02T15:01:23.045678Z"。
createTime	timestamp 工作的建立的日期和時間。屬性值是 RFC3339 世界標準時間「Zulu」的時間戳記格式，精確到微秒。範例："2015-10-02T15:01:23.045678Z"。
jobExpireTime	timestamp 與報表相關聯的工作日期和時間為過期或將失效。屬性值是 RFC3339 世界標準時間「Zulu」的時間戳記格式，精確到微秒。示例："2015-10-02T15:01:23.045678Z"。 如果與報表工作相關聯的報表類型已淘汰，或是系統長時間未下載替該工作產生的報表，這個屬性就會包含一個值。此值標示的是在該日期之後，YouTube 將不再為該工作產生新報告。 如果您的工作認得到期日，則應更新系統，在該日期之前停止要求報告。在某些情況下，系統會提供替換報告。
downloadUrl	string 報表可下載的網址。屬性值的長度上限為 1000 個半形字元。 如要擷取報表，請傳送 HTTP GET 要求至這個網址。在要求中，使用授權權杖做為標頭值，設定 Authorization HTTP 要求標頭。 使用 gzip 您可以對下載請求啟用 gzip 壓縮，降低下載報表所需的頻寬。雖然應用程式需要額外的 CPU 作業時間才能解壓縮 API 回應，但使用較少的網路資源的好處通常會比該成本高。 如要接收 gzip 編碼回應，請將 Accept-Encoding HTTP 要求標頭設為 gzip，如以下範例所示： Accept-Encoding: gzip