API Reference

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

API รองรับฟังก์ชัน 2 ประเภทดังนี้

  • การดึงข้อมูลรายงาน – เมธอด reports.query ของ API จะดึงรายงาน YouTube Analytics

  • การจัดการกลุ่ม YouTube Analytics - กลุ่ม YouTube Analytics เป็นคอลเล็กชันที่กําหนดเองที่มีช่อง วิดีโอ เพลย์ลิสต์ หรือชิ้นงานได้สูงสุด 500 รายการ API รองรับหลากหลายวิธีในการสร้าง ดึงข้อมูล และอัปเดตกลุ่ม YouTube Analytics จากนั้นเจ้าของช่องและเนื้อหาจะใช้เมธอด reports.query เพื่อดึงข้อมูลรวมสําหรับสินค้าทั้งหมดในกลุ่มได้ ซึ่งจะช่วยในการวิเคราะห์ประสิทธิภาพ

หน้านี้แสดงภาพรวมคร่าวๆ ของทรัพยากร API และวิธีที่เปิดใช้ฟังก์ชันเหล่านี้

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

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

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

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

การดึงข้อมูลรายงาน

เมธอด reports.query ของ API ช่วยให้คุณเรียกดูรายงานต่างๆ ของ YouTube Analytics ได้ คําขอแต่ละรายการใช้พารามิเตอร์การค้นหาเพื่อระบุรหัสช่องหรือเจ้าของเนื้อหา วันที่เริ่มต้น วันที่สิ้นสุด และเมตริกอย่างน้อย 1 รายการ คุณยังระบุพารามิเตอร์การค้นหาเพิ่มเติม เช่น มิติข้อมูล ตัวกรอง และวิธีการจัดเรียงได้ด้วย

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://youtubeanalytics.googleapis.com/v2
query GET /reports ดึงรายงาน YouTube Analytics คําขอ API แต่ละรายการจะใช้พารามิเตอร์การค้นหาเพื่อระบุรหัสช่องหรือเจ้าของเนื้อหา วันที่เริ่มต้น วันที่สิ้นสุด และเมตริกอย่างน้อย 1 รายการ คุณยังระบุพารามิเตอร์การค้นหาเพิ่มเติม เช่น มิติข้อมูล ตัวกรอง หรือวิธีการจัดเรียงได้ด้วย
  • เมตริกคือการวัดกิจกรรมของผู้ใช้แต่ละครั้ง เช่น ยอดดูวิดีโอ หรือการให้คะแนน (การกดชอบและไม่ชอบ)
  • มิติข้อมูลเป็นเกณฑ์ทั่วไปที่ใช้รวบรวมข้อมูล เช่น วันที่ของกิจกรรมของผู้ใช้ หรือประเทศของผู้ใช้ ในรายงาน ข้อมูลแต่ละแถวจะมีชุดค่าผสมของค่ามิติข้อมูลที่ไม่ซ้ํากัน
  • ตัวกรองคือค่ามิติข้อมูลที่ระบุที่จะดึงข้อมูล ตัวอย่างเช่น คุณอาจเรียกข้อมูลสําหรับประเทศ วิดีโอ หรือกลุ่มวิดีโอที่เจาะจง
รายการรายงานแชแนลและรายงานเจ้าของเนื้อหาที่รองรับจะกําหนดชุดค่าผสมของเมตริก มิติข้อมูล และตัวกรองที่ถูกต้อง

การจัดการกลุ่ม

API มีแหล่งข้อมูล 2 อย่างในการสร้างและจัดการกลุ่ม YouTube Analytics ได้แก่

Groups

ทรัพยากร group แสดงถึงกลุ่ม YouTube Analytics ซึ่งเป็นคอลเล็กชันที่กําหนดเองของช่อง วิดีโอ เพลย์ลิสต์ หรือชิ้นงานได้สูงสุด 500 รายการ

รายการทั้งหมดในกลุ่มต้องแสดงถึงทรัพยากรประเภทเดียวกัน เช่น คุณไม่สามารถสร้างกลุ่มที่มีวิดีโอ 100 รายการและเพลย์ลิสต์ 100 รายการ

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

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ โปรดดูการแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://youtubeanalytics.googleapis.com/v2
list GET /groups แสดงผลรายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API ตัวอย่างเช่น คุณสามารถเรียกดูกลุ่มทั้งหมดที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เป็นเจ้าของ หรือจะเรียกดูกลุ่มอย่างน้อย 1 กลุ่มตามรหัสที่ไม่ซ้ํากันก็ได้
insert POST /groups สร้างกลุ่ม YouTube Analytics หลังจากสร้างกลุ่มแล้ว ให้ใช้เมธอด groupItems.insert เพื่อเพิ่มรายการลงในกลุ่ม
update PUT /groups แก้ไขข้อมูลเมตาสําหรับกลุ่ม ปัจจุบันอัปเดตพร็อพเพอร์ตี้ได้เพียงรายการเดียวคือชื่อกลุ่ม (ใช้ groupItems.insert และ groupItems.delete เพื่อเพิ่มและนํารายการกลุ่มออก)
delete DELETE /groups ลบกลุ่ม

ไอเทมกลุ่ม

ทรัพยากร groupItem แสดงถึงรายการในกลุ่ม YouTube Analytics

สําหรับข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ โปรดดูการแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่สัมพันธ์กับ https://youtubeanalytics.googleapis.com/v2
list GET /groupItems แสดงคอลเล็กชันรายการกลุ่มที่ตรงกับพารามิเตอร์คําขอ API
insert POST /groupItems สร้างรายการกลุ่ม
delete DELETE /groupItems นํารูปภาพหรือวิดีโอออกจากกลุ่ม