เอกสารนี้อธิบายความคล้ายคลึงและความแตกต่างของวิธีที่ YouTube Analytics API และ YouTube Reporting API ให้สิทธิ์เข้าถึงข้อมูล YouTube Analytics จุดประสงค์ของเอกสารคือเพื่อช่วยคุณเลือก API ที่เหมาะสมสําหรับแอปพลิเคชันของคุณ
ทั้งสอง API ช่วยให้นักพัฒนาซอฟต์แวร์เรียกข้อมูล YouTube Analytics ได้ นอกจากนี้ API ทั้ง 2 รายการยังรองรับเจ้าของช่อง YouTube และเจ้าของเนื้อหา YouTube ซึ่งแต่ละกลุ่มจะเข้าถึงชุดรายงานที่เฉพาะเจาะจงได้ด้วย
-
รายงานช่องมีเมตริกกิจกรรมของผู้ใช้สําหรับช่องที่ระบุ
-
รายงานเจ้าของเนื้อหาจะรวมเมตริกทั้งหมดสําหรับทุกช่องที่ลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุไว้ เช่น ค่ายเพลงอาจดึงข้อมูลรายงานที่มีสถิติแบบรวมสําหรับช่อง YouTube ของศิลปินทั้งหมดในค่าย รายงานของเจ้าของเนื้อหาบางรายมีเมตริกกิจกรรมของผู้ใช้ ส่วนบางรายการจะมีเมตริกที่เกี่ยวข้องกับรายได้และประสิทธิภาพของโฆษณา
นอกจากนี้ API การรายงานยังอนุญาตให้เจ้าของเนื้อหาบางรายเข้าถึงรายงานรายได้จากโฆษณาที่จัดการโดยระบบได้ด้วย ระบบจะดึงข้อมูลในรายงานที่จัดการโดยระบบได้โดยใช้ API การรายงานเท่านั้น
คําขอ YouTube Analytics และ YouTube Reporting API ทั้งหมดต้องได้รับอนุญาตจากช่องหรือเจ้าของเนื้อหาที่เป็นเจ้าของข้อมูลที่ขอ
รายงานเนื้อหา
รายงานที่ API เรียกข้อมูลประกอบด้วยข้อมูล 2 ประเภท ได้แก่
-
มิติข้อมูลเป็นเกณฑ์ทั่วไปที่ใช้รวบรวมข้อมูล เช่น วันที่ของกิจกรรมของผู้ใช้ หรือประเทศของผู้ใช้
ในรายงาน ข้อมูลแต่ละแถวจะมีชุดค่าผสมของค่ามิติข้อมูลที่ไม่ซ้ํากัน ดังนั้น การรวมกันของค่ามิติข้อมูลในแต่ละแถวจะทํางานเป็นคีย์หลักของแถวนั้น
-
เมตริก คือการวัดผลกิจกรรมของผู้ใช้ ประสิทธิภาพโฆษณา หรือรายได้โดยประมาณ เมตริกกิจกรรมของผู้ใช้ ได้แก่ จํานวนการดูและการให้คะแนนวิดีโอ (การกดชอบและไม่ชอบ)
เลือก API ที่เหมาะสมสําหรับแอปพลิเคชัน
- API ของ YouTube Analytics
- YouTube Analytics API รองรับคําค้นหาที่ตรงเป้าหมายแบบเรียลไทม์เพื่อสร้างรายงาน YouTube Analytics ที่กําหนดเอง API มีพารามิเตอร์การกรองและการจัดเรียง ดังนั้นแอปพลิเคชันการโทรจึงไม่จําเป็นต้องรองรับฟังก์ชันเหล่านี้
คําขอ API แต่ละรายการจะระบุช่วงวันที่ที่จะแสดงข้อมูล API ยังช่วยให้คุณเรียกข้อมูลชุดข้อมูลรายสัปดาห์และรายเดือนได้ ดังนั้น แอปพลิเคชันการโทรจึงไม่ต้องจัดเก็บชุดข้อมูลที่ดึงมาหรือรวบรวมสถิติในช่วงวันที่ต่างๆ - API การรายงานของ YouTube
- YouTube Reporting API จะเรียกข้อมูลรายงานจํานวนมากที่มีข้อมูล YouTube Analytics สําหรับช่องหรือเจ้าของเนื้อหา โดยออกแบบมาสําหรับแอปพลิเคชันที่สามารถนําเข้าชุดข้อมูลขนาดใหญ่และมีเครื่องมือสําหรับกรอง จัดเรียง และขุดข้อมูลดังกล่าว
แต่ละรายงานมีชุดช่องที่กําหนดไว้ล่วงหน้า นักพัฒนาซอฟต์แวร์ใช้ API เพื่อกําหนดเวลาการรายงานงาน ซึ่งแต่ละรายงานจะระบุรายงานที่ YouTube ควรสร้าง จากนั้น YouTube จะสร้างรายงานประจําวันที่ดาวน์โหลดได้แบบไม่พร้อมกัน แต่ละรายงานจะมีข้อมูลสําหรับ 24 ชั่วโมงที่ไม่ซ้ํากัน
นอกจากนี้ YouTube ยังสร้างชุดรายงานที่จัดการโดยระบบสําหรับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องใน YouTube Creator Studio โดยอัตโนมัติอีกด้วย รายงานเหล่านี้ให้สิทธิ์เข้าถึงข้อมูลรายได้จากโฆษณาแบบเป็นโปรแกรม - กิจกรรมของผู้ใช้ที่เกี่ยวข้องกับคําบรรยาย
- ข้อมูลการคงผู้ชมไว้สําหรับเพลย์ลิสต์
- รายงานรายได้โดยประมาณสําหรับเจ้าของเนื้อหา (มีรายงานที่ใช้ได้ 2 ฉบับ)
- รายงานสําหรับเจ้าของเนื้อหา (มีรายงานที่ใช้ได้ 11 รายการ)
รายงานที่รองรับ
ตารางต่อไปนี้ระบุรายงานประเภทต่างๆ ที่เรียกดูได้โดยใช้ API คําค้นหาที่กําหนดเป้าหมายพร้อมให้ใช้งานผ่าน YouTube Analytics API ขณะที่รายงานจํานวนมากจะดูผ่าน YouTube Reporting API ได้
ข้อมูลที่มีให้ใช้งานใน API หนึ่งอาจไม่พร้อมใช้งานในอีก API หนึ่ง เช่น YouTube Analytics API จะให้คุณเรียกดูเมตริกกิจกรรมของผู้ใช้ทุกสัปดาห์หรือทุกเดือน แต่ API การรายงานของ YouTube กําหนดให้คุณต้องรวบรวมข้อมูลดังกล่าวด้วยตนเอง ในทางกลับกัน YouTube Reporting API รองรับรายงานเนื้อหาสําหรับเจ้าของเนื้อหา แต่ข้อมูลนั้นไม่พร้อมใช้งานจาก YouTube Analytics API
| ประเภทรายงาน | |
|---|---|
| รายงานวิดีโอ | รองรับสําหรับช่อง (คําค้นหาหรือแบบกลุ่ม) และเจ้าของเนื้อหา (คําค้นหาหรือแบบกลุ่ม) รายงานวิดีโอจะแสดงสถิติเกี่ยวกับกิจกรรมของผู้ใช้ทั้งหมดที่เกี่ยวข้องกับวิดีโอของช่องหรือเจ้าของเนื้อหา เช่น รายงานเหล่านี้จะมียอดดูที่วิดีโอได้รับ ใน YouTube Analytics API รายงานวิดีโอบางส่วนสําหรับเจ้าของเนื้อหาจะมีเมตริกรายได้โดยประมาณและประสิทธิภาพของโฆษณาด้วย |
| รายงานเพลย์ลิสต์ | รองรับสําหรับช่อง (คําค้นหาหรือแบบกลุ่ม) และเจ้าของเนื้อหา (คําค้นหาหรือแบบกลุ่ม) รายงานเพลย์ลิสต์จะแสดงสถิติที่เกี่ยวข้องกับยอดดูวิดีโอที่เกิดขึ้นในบริบทของเพลย์ลิสต์โดยเฉพาะ ส่วน Reporting API ของ YouTube จะรองรับรายงานการคงผู้ชมไว้สําหรับเพลย์ลิสต์ แต่ YouTube Analytics API ไม่รองรับรายงานที่คล้ายกัน |
| รายงานประสิทธิภาพของโฆษณา | รองรับเจ้าของเนื้อหา (คําค้นหาหรือแบบกลุ่ม) รายงานประสิทธิภาพของโฆษณามีเมตริกตามการแสดงผลสําหรับโฆษณาที่แสดงระหว่างการเล่นวิดีโอ เมตริกเหล่านี้จะพิจารณาการแสดงโฆษณาแต่ละครั้ง และการเล่นวิดีโอแต่ละครั้งอาจทําให้เกิดการแสดงผลหลายครั้งได้ |
| รายงานรายได้โดยประมาณ | รองรับเจ้าของเนื้อหา (แบบกลุ่ม) รายได้โดยประมาณจะแสดงรายได้รวมโดยประมาณจากแหล่งที่มาของโฆษณาที่ Google เป็นผู้ขายและจากแหล่งที่มาที่ไม่ใช่โฆษณา รายงานเหล่านี้ยังมีเมตริกประสิทธิภาพของโฆษณาบางรายการด้วย โปรดทราบว่ารายงานที่จัดการโดยระบบมีข้อมูลรายได้จริง |
| รายงานชิ้นงาน | รองรับเจ้าของเนื้อหา (แบบกลุ่ม) รายงานเนื้อหาแสดงเมตริกกิจกรรมของผู้ใช้ที่เกี่ยวข้องกับวิดีโอที่ลิงก์กับเนื้อหาของเจ้าของเนื้อหา วิดีโอจะรวมอยู่ในรายงานของเจ้าของเนื้อหาหากเจ้าของเนื้อหาได้อ้างสิทธิ์วิดีโอนั้นว่าเป็นเนื้อหาที่ตรงกับเนื้อหาของเจ้าของเนื้อหา เจ้าของเนื้อหาหรือผู้ใช้ YouTube รายอื่นอาจอัปโหลดวิดีโอได้ |
| รายงานที่จัดการโดยระบบ | รองรับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องในส่วนรายงานของ Creator Studio ของ YouTube รายงานที่จัดการโดยระบบจะให้ข้อมูลรายได้จริงที่ได้รับจากเนื้อหาและวิดีโอ รายงานเพิ่มเติมจะแสดงวิดีโอที่อ้างสิทธิ์และชิ้นงานที่วิดีโอเหล่านั้นตรงกัน โปรดทราบว่าขณะนี้รายงาน Creator Studio บางรายการไม่พร้อมใช้งานใน API หมายเหตุ: YouTube จะสร้างรายงานที่จัดการโดยระบบจัดการเนื้อหาสําหรับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องใน Creator Studio โดยอัตโนมัติ ด้วยเหตุนี้ กระบวนการในการดึงข้อมูลรายงานเหล่านี้จึงแตกต่างจากรายงานประเภทอื่นๆ ในรายการนี้ โปรดดูข้อมูลเพิ่มเติมในเอกสารประกอบรายงานที่จัดการโดยระบบ |
ความแตกต่างที่สําคัญ
ตารางต่อไปนี้จะไฮไลต์ความแตกต่างที่สําคัญระหว่าง YouTube Analytics กับ Reporting API
| ฟีเจอร์ | API ของ YouTube Analytics | API การรายงานของ YouTube |
|---|---|---|
| กระบวนการเรียกข้อมูล | คําขอ API แต่ละรายการระบุมิติข้อมูลและเมตริกที่จะแสดง รวมถึงระยะเวลาที่จะแสดงข้อมูล | แอปพลิเคชันตั้งเวลาการรายงานงาน ในแต่ละงาน YouTube จะสร้างรายงานประจําวันที่ดาวน์โหลดได้แบบไม่พร้อมกัน |
| ช่วงวันที่ | รายงาน API บางรายการระบุวันที่ที่เกิดกิจกรรมของผู้ใช้ รายงานบางส่วนรองรับมิติข้อมูลเพื่อรวบรวมเมตริกกิจกรรมของผู้ใช้ตามเดือน | รายงาน API ทั้งหมดจะระบุวันที่กิจกรรมของผู้ใช้เกิดขึ้น แอปพลิเคชันที่ใช้ API สามารถใช้ฟีเจอร์ต่างๆ ในการรวบรวมข้อมูลเป็นระยะ |
| การกรองข้อมูล | คุณสามารถกรองรายงานให้รวมเฉพาะแถวที่มิติข้อมูลมีค่าที่เจาะจงได้ API นี้ยังรองรับมิติข้อมูลบางรายการ เช่น ยุโรปและทวีปย่อย ที่ใช้เป็นตัวกรองเท่านั้น | API รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม โดยจะไม่รองรับการกรองหรือแสดงข้อมูลมิติข้อมูลมิติข้อมูลตัวกรองเท่านั้น แอปพลิเคชันไคลเอ็นต์จัดเก็บข้อมูลที่ดาวน์โหลดและใช้ฟีเจอร์ของตนเองเพื่อกรองข้อมูล |
| การจัดเรียง | จัดเรียงรายงานตามค่าเมตริกที่แสดงผลได้ รายงานบางรายการรองรับผลการค้นหาในจํานวนจํากัดเท่านั้น เช่น รายงานที่แสดงวิดีโอที่มียอดดูสูงสุดของช่องจะมีแถวได้สูงสุด 200 แถว | API นี้รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม แอปพลิเคชันไคลเอ็นต์ใช้ฟีเจอร์ของตนเองเพื่อจัดเรียงข้อมูลที่ดาวน์โหลดได้ |
| การแจกแจง | รายงาน API มีค่าข้อความ เช่น "ANDROID" หรือ "CHANNEL" เพื่อระบุค่าของมิติข้อมูลที่แจกแจง | รายงาน API เป็นจํานวนเต็มที่แมปกับค่าข้อความได้ |
| โควต้า | ซึ่งเซิร์ฟเวอร์ API จะประเมินคําค้นหาแต่ละคําเพื่อระบุต้นทุนตามโควต้า เอกสารการใช้งานโควต้าจะอธิบายวิธีการอย่างละเอียด | การใช้โควต้าไม่ใช่ปัญหาเนื่องจากระบบจะดึงข้อมูลเพียงครั้งเดียว แล้วกรอง จัดเรียง และค้นหาภายในแอปพลิเคชัน |
| รายงานที่ไม่ซ้ํา |
|
|
| มิติข้อมูลที่ไม่ซ้ํา | มิติข้อมูลกลุ่ม (ตัวกรองเท่านั้น) ต่อเนื่อง (มิติข้อมูลตัวกรองเท่านั้น) มิติข้อมูลย่อยเท่านั้น (มิติข้อมูลตัวกรองเท่านั้น) |
annotation_id annotation_type asset_id card_id card_type live_or_on_Demand subscribed_status subtitle_language |
| เมตริกที่ไม่ซ้ํากัน | รายการที่ไม่ซ้ํา relativekeepPerformance viewsPerPlaylistStart AverageTimeInPlaylist |
card_click_rate card_clicks_click card_impressions_impressions_1 card_tทีเซอร์_clicks card_tทีเซอร์_impressions estimated_partner_adsense_revenue estimated_partner_doubleclick_rereminder1 |
ความแตกต่างของการตั้งชื่อระหว่าง API
ปัจจุบัน API 2 รายการใช้รูปแบบการตั้งชื่อที่แตกต่างกันเพื่อระบุมิติข้อมูลและเมตริก ในขณะนี้ ชื่อ YouTube Analytics API จะใช้ ComelCase ในขณะที่ชื่อ YouTube Reporting API จะใช้ชื่อที่คั่นด้วยขีดล่าง
ตารางต่อไปนี้ระบุชื่อที่ต่างกันซึ่ง API ทั้ง 2 รายการใช้เพื่อระบุเมตริกและมิติข้อมูลเดียวกัน ในบางกรณี ความแตกต่างระหว่างทั้ง 2 ชื่อนี้จะมากกว่าที่คุณจะได้รับหลังจากแปลงชื่อจาก ComelCase เป็นขีดล่าง เช่น มิติข้อมูล video ใน YouTube Analytics API มีชื่อว่า video_id ใน YouTube Reporting API