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 สำหรับดาวน์โหลด

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

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

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

ขอบเขต
https://www.googleapis.com/auth/yt-analytics.readonly ดูรายงานข้อมูลวิเคราะห์ YouTube สำหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้ให้สิทธิ์เข้าถึงเมตริกกิจกรรมของผู้ใช้ เช่น จำนวนการดูและจำนวนการให้คะแนน
https://www.googleapis.com/auth/yt-analytics-monetary.readonly ดูรายงานด้านการเงินของข้อมูลวิเคราะห์ YouTube สำหรับเนื้อหา 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
แสดงรายงานที่สร้างขึ้นสำหรับงานการรายงานที่ระบุ

reportTypes

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