YouTube Reporting API

ส่วน Reporting API ของ YouTube จะช่วยให้นักพัฒนาซอฟต์แวร์ตั้งเวลางานการรายงานแล้วดาวน์โหลดรายงานจํานวนมากที่สร้างขึ้นได้ API รองรับชุดรายงานที่กําหนดไว้ล่วงหน้า ซึ่งแต่ละรายงานจะมีชุดข้อมูล YouTube Analytics ที่ครอบคลุมสําหรับช่องหรือเจ้าของเนื้อหา

ขั้นตอนด้านล่างนี้จะอธิบายวิธีกําหนดเวลาการรายงานงานและเรียกข้อมูลรายงาน

  1. เรียกใช้เมธอด reportTypes.list() เพื่อเรียกรายการรายงานที่ช่องหรือเจ้าของเนื้อหาสามารถเรียกข้อมูลได้
  2. เรียกเมธอด jobs.create() เพื่อระบุรายงานที่ควรสร้างสําหรับช่องหรือเจ้าของเนื้อหา จากนั้นคุณสามารถใช้ jobs.list() และ jobs.delete() ของ API เพื่อดึงข้อมูลหรือเปลี่ยนรายการรายงานที่กําลังสร้างได้
  3. เรียกใช้เมธอด jobs.reports.list() เพื่อเรียกรายการรายงานที่สร้างขึ้นสําหรับงานหนึ่งๆ ทรัพยากรแต่ละรายการในการตอบกลับมีพร็อพเพอร์ตี้ downloadUrl ที่ระบุ URL ที่ดาวน์โหลดรายงานได้
  4. ส่งคําขอ GET ที่ได้รับอนุญาตเพื่อดึงรายงานจาก URL การดาวน์โหลด

การให้สิทธิ์

คําขอ API การรายงานของ YouTube ทั้งหมดต้องได้รับอนุญาต โปรดดูคู่มือการให้สิทธิ์ซึ่งอธิบายวิธีใช้โปรโตคอล OAuth 2.0 เพื่อเรียกข้อมูลโทเค็นการให้สิทธิ์

คําขอ API การรายงานของ YouTube ใช้ขอบเขตการให้สิทธิ์ต่อไปนี้

กล้องติดปืน
https://www.googleapis.com/auth/yt-analytics.readonly ดูรายงาน YouTube Analytics สําหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้จะช่วยให้เข้าถึงเมตริกกิจกรรมของผู้ใช้ เช่น จํานวนการดูและการให้คะแนน
https://www.googleapis.com/auth/yt-analytics-monetary.readonly ดูรายงานทางการเงินของ YouTube Analytics สําหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้จะทําให้คุณเข้าถึงเมตริกกิจกรรมของผู้ใช้และเมตริกรายได้โดยประมาณและประสิทธิภาพของโฆษณาได้

ประเภททรัพยากร

ส่วนต่อไปนี้จะให้คําอธิบายทั่วไปเกี่ยวกับทรัพยากรและวิธีการของ API URI เมธอดทั้งหมดที่แสดงในตารางจะสัมพันธ์กับ https://youtubereporting.googleapis.com

งาน

วิธีการ
create POST /v1/jobs
สร้างงานการรายงาน การสร้างงานการรายงานคือการสั่งให้ YouTube สร้างรายงานดังกล่าวแบบรายวัน รายงานนี้จะพร้อมใช้งานภายใน 24 ชั่วโมงหลังจากสร้างงาน
delete DELETE /v1/jobs/{jobId}
ลบงานการรายงาน
get GET /v1/jobs/{jobId}
ดึงข้อมูลเกี่ยวกับงานการรายงานที่เจาะจงซึ่งได้กําหนดเวลาให้ช่องหรือเจ้าของเนื้อหา
list GET /v1/jobs
แสดงรายการงานการรายงานที่มีการกําหนดเวลาสําหรับช่องหรือเจ้าของเนื้อหา ทรัพยากรแต่ละรายการในการตอบกลับมีพร็อพเพอร์ตี้ id ซึ่งระบุรหัสที่ YouTube ใช้เพื่อระบุงานที่ไม่ซ้ํากัน คุณต้องมีรหัสดังกล่าวเพื่อเรียกข้อมูลรายการรายงานที่สร้างมาเพื่องานหรือลบงานออก

jobs.reports

วิธีการ
get GET /v1/jobs/{jobId}/reports/{reportId}
ดึงข้อมูลเมตาสําหรับรายงานที่ต้องการ
list GET /v1/jobs/{jobId}/reports
แสดงรายงานที่สร้างขึ้นสําหรับงานการรายงานที่ระบุ

ประเภทรายงาน

วิธีการ
list GET /v1/reportTypes
แสดงรายการประเภทรายงานที่ช่องหรือเจ้าของเนื้อหาสามารถเรียกข้อมูลได้