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 相關聯。 |
jobId |
string 建立這份報表的工作 ID。 |
startTime |
timestamp 報表例項的開始日期。其中包含的值為 RFC3339 UTC「Zulu」格式的時間戳記,以微秒的精確度表示。範例: "2015-10-02T15:01:23.045678Z" 。 |
endTime |
timestamp 報表例項的期間結束。專屬值為 RFC3339 UTC 的「Zulu」格式中的時間戳記,準確單位為微秒。範例: "2015-10-02T15:01:23.045678Z" 。 |
createTime |
timestamp 建立工作的日期和時間。屬性值為 RFC3339 UTC 「Zulu」格式的時間戳記,以微秒的精確度表示。範例: "2015-10-02T15:01:23.045678Z" 。 |
jobExpireTime |
timestamp 與報表相關聯的工作已過期或即將到期的日期和時間。屬性值為 RFC3339 UTC 「Zulu」格式的時間戳記,以微秒的精確度表示。範例: "2015-10-02T15:01:23.045678Z" 。如果與工作相關的報表類型已淘汰,或為該工作產生的報表已有一段時間沒有下載,則此屬性擁有一個值。這個值會標示 YouTube 停止為工作產生新報表的日期。 如果你有可識別到期日的職缺,請更新系統,要求在該日期以前停止索取報告。在某些情況下,或許會提供替代報表。 |
downloadUrl |
string 可下載報告的網址。屬性值的長度上限為 1000 個字元。 如要擷取報告,請傳送 HTTP GET 要求至這個網址。在要求中,使用授權權杖做為標頭值來設定 Authorization HTTP 要求標頭。使用 gzip 只要針對下載要求啟用 gzip 壓縮功能,即可降低下載報表所需的頻寬。雖然您的應用程式需要額外的 CPU 時間才能解壓縮 API 回應,但減少網路資源的優勢通常可超過成本。 如要接收 gzip 編碼的回應,請將 Accept-Encoding: gzip |