ทรัพยากร report
จะระบุอินสแตนซ์ที่เฉพาะเจาะจงของรายงาน ทรัพยากรจะระบุระยะเวลาที่รายงานมีข้อมูล รวมถึง URL ที่ดาวน์โหลดรายงานได้
วิธีการ
ตารางต่อไปนี้แสดงวิธีที่ API รองรับสําหรับทรัพยากร report
รายการ
วิธีการ | |
---|---|
get |
เรียกดูข้อมูลเมตาของรายงานที่ต้องการ |
list |
แสดงรายการรายงานที่สร้างขึ้นสําหรับงานการรายงานที่ระบุ |
การแสดงทรัพยากร JSON
โครงสร้าง JSON ด้านล่างแสดงรูปแบบทรัพยากร report
ดังนี้
{ "id": string, "jobId": string, "startTime": timestamp, "endTime": timestamp, "createTime": timestamp, "jobExpireTime": timestamp, "downloadUrl": string }
พร็อพเพอร์ตี้
ตารางต่อไปนี้กําหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้
พร็อพเพอร์ตี้ | |
---|---|
id |
string รหัสที่ YouTube กําหนดเพื่อระบุรายงานที่ไม่ซ้ํากัน แต่ละรายงานจะเชื่อมโยงกับงานเดียว แต่งานอาจเชื่อมโยงกับรหัสรายงานจํานวนมาก |
jobId |
string รหัสของงานที่สร้างรายงานนี้ |
startTime |
timestamp จุดเริ่มต้นของระยะเวลาที่ครอบคลุมอินสแตนซ์รายงาน ค่าที่รวมอยู่เป็นการประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่ถูกต้องเป็นไมโครวินาที ตัวอย่าง: "2015-10-02T15:01:23.045678Z" |
endTime |
timestamp วันที่สิ้นสุดของระยะเวลาที่อินสแตนซ์รายงานครอบคลุม ค่าพิเศษคือการประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความแม่นยําเป็นไมโครวินาที ตัวอย่าง: "2015-10-02T15:01:23.045678Z" |
createTime |
timestamp วันที่และเวลาที่สร้างงาน ค่าพร็อพเพอร์ตี้เป็นการประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่ถูกต้องเป็นไมโครวินาที ตัวอย่าง: "2015-10-02T15:01:23.045678Z" |
jobExpireTime |
timestamp วันที่และเวลาที่งานที่เชื่อมโยงกับรายงานหมดอายุหรือหมดอายุ ค่าพร็อพเพอร์ตี้เป็นการประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่ถูกต้องเป็นไมโครวินาที ตัวอย่าง: "2015-10-02T15:01:23.045678Z" พร็อพเพอร์ตี้นี้จะมีค่าหากประเภทรายงานที่เชื่อมโยงกับงานของรายงานเลิกใช้งานแล้ว หรือดาวน์โหลดรายงานที่สร้างขึ้นสําหรับงานนั้นมาเป็นเวลานานแล้ว ค่านี้จะมีวันที่ YouTube ไม่สร้างรายงานใหม่สําหรับงานนั้นๆ อีกต่อไป หากคุณมีงานที่ระบุวันที่หมดอายุ คุณควรอัปเดตระบบให้หยุดขอรายงานภายในวันที่ดังกล่าว ในบางกรณี รายงานทดแทนอาจพร้อมให้ใช้งาน |
downloadUrl |
string URL ที่ดาวน์โหลดรายงานได้ ค่าของพร็อพเพอร์ตี้มีอักขระได้สูงสุด 1, 000 ตัว หากต้องการดึงรายงาน ให้ส่งคําขอ HTTP GET ไปยัง URL นี้ ในคําขอ ให้ตั้งค่าส่วนหัวคําขอ HTTP Authorization โดยใช้โทเค็นการให้สิทธิ์เป็นค่าส่วนหัว
การใช้ gzip คุณสามารถลดแบนด์วิดท์ที่จําเป็นในการดาวน์โหลดรายงานด้วยการเปิดใช้การบีบอัด gzip ในคําขอดาวน์โหลด แม้ว่าแอปพลิเคชันจะต้องใช้เวลา CPU มากขึ้นในการบีบอัดการตอบสนองของ API แต่การใช้ทรัพยากรเครือข่ายน้อยลงมักมีน้ําหนักเกินต้นทุนนั้นมีประโยชน์มาก หากต้องการได้รับการตอบกลับที่เข้ารหัสแบบ gzip ให้ตั้งค่าส่วนหัวของคําขอ HTTP Accept-Encoding: gzip |