Reports

ทรัพยากร 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 กำหนดเพื่อระบุรายงานโดยไม่ซ้ำกัน รายงานแต่ละฉบับจะเชื่อมโยงกับงาน 1 รายการ แม้ว่างานหนึ่งอาจเชื่อมโยงกับรหัสรายงานหลายรายการก็ตาม
jobId string
รหัสของงานที่สร้างรายงานนี้
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
URL ที่รายงานจะดาวน์โหลดรายงานได้ ค่าพร็อพเพอร์ตี้มีความยาวได้สูงสุด 1, 000 อักขระ

หากต้องการเรียกรายงาน ให้ส่งคำขอ HTTP GET ไปยัง URL นี้ ในคำขอ ให้ตั้งค่าส่วนหัวของคำขอ HTTP Authorization โดยใช้โทเค็นการให้สิทธิ์เป็นค่าส่วนหัว

การใช้ gzip

คุณสามารถลดแบนด์วิดท์ที่จำเป็นในการดาวน์โหลดรายงานโดยเปิดใช้การบีบอัด gzip ในคำขอดาวน์โหลด แม้ว่าแอปพลิเคชันของคุณจะต้องใช้เวลา CPU เพิ่มขึ้นในการยกเลิกการบีบอัดการตอบสนองของ API แต่ข้อดีของการใช้ทรัพยากรเครือข่ายที่น้อยลงมักจะประหยัดค่าใช้จ่ายได้มากกว่า

หากต้องการรับการตอบกลับที่เข้ารหัส gzip ให้ตั้งค่าส่วนหัวของคำขอ HTTP Accept-Encoding เป็น gzip ดังที่แสดงในตัวอย่างต่อไปนี้

Accept-Encoding: gzip