Introduction

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

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

  • รายงานช่องประกอบด้วยเมตริกกิจกรรมของผู้ใช้สำหรับช่องที่ระบุ

  • รายงานของเจ้าของเนื้อหาจะรวบรวมเมตริกสำหรับช่องทั้งหมดที่ลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ เช่น ค่ายเพลงอาจเรียกดูรายงานที่มีสถิติรวมเกี่ยวกับช่อง YouTube ทั้งหมดของศิลปินในค่าย รายงานเจ้าของเนื้อหาบางรายการมีเมตริกกิจกรรมของผู้ใช้ ในขณะที่รายงานอื่นๆ มีเมตริกที่เกี่ยวข้องกับรายได้และประสิทธิภาพของโฆษณา

นอกจากนี้ Reporting API ยังช่วยให้เจ้าของเนื้อหาบางรายเข้าถึงรายงานรายได้จากโฆษณาที่ระบบจัดการได้ด้วย คุณจะดึงข้อมูลในรายงานที่ระบบจัดการได้ด้วย Reporting API เท่านั้น

คำขอ API ของข้อมูลวิเคราะห์ YouTube และ Reporting API ของ YouTube ทั้งหมดต้องได้รับอนุญาตจากช่องหรือเจ้าของเนื้อหาที่เป็นเจ้าของข้อมูลที่ขอ

รายงานเนื้อหา

รายงานที่ API ดึงมาจะมีข้อมูล 2 ประเภท ได้แก่

  • มิติข้อมูลคือเกณฑ์ทั่วไปที่ใช้ในการรวบรวมข้อมูล เช่น วันที่เกิดกิจกรรมของผู้ใช้หรือประเทศที่ผู้ใช้อยู่

    ในรายงาน ข้อมูลแต่ละแถวจะมีชุดค่าผสมของค่ามิติข้อมูลที่ไม่ซ้ำกัน ดังนั้น ชุดค่าผสมของค่ามิติข้อมูลของแต่ละแถวจึงทําหน้าที่เป็นคีย์หลักสําหรับแถวนั้น

  • เมตริกคือการวัดกิจกรรมของผู้ใช้ ประสิทธิภาพของโฆษณา หรือรายได้โดยประมาณแต่ละรายการ เมตริกกิจกรรมของผู้ใช้รวมถึงสิ่งต่างๆ เช่น ยอดดูวิดีโอและคะแนน (การกดชอบและไม่ชอบ)

เลือก API ที่เหมาะกับแอปพลิเคชันของคุณ

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

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

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

นอกจากนี้ YouTube ยังสร้างชุดรายงานที่ระบบจัดการโดยอัตโนมัติสำหรับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องใน YouTube Creator Studio รายงานเหล่านี้ให้การเข้าถึงข้อมูลรายได้จากโฆษณาแบบเป็นโปรแกรม

รายงานที่รองรับ

ตารางต่อไปนี้ระบุรายงานประเภทต่างๆ ที่คุณเรียกข้อมูลได้โดยใช้ API คุณใช้การค้นหาที่กำหนดเป้าหมายได้โดยใช้ API ของข้อมูลวิเคราะห์ YouTube และใช้รายงานจำนวนมากได้โดยใช้ Reporting API ของ YouTube

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

ประเภทรายงาน
รายงานวิดีโอ รองรับสำหรับช่อง (query หรือ bulk) และเจ้าของเนื้อหา (query หรือ bulk)

รายงานวิดีโอจะแสดงสถิติสำหรับกิจกรรมทั้งหมดของผู้ใช้ที่เกี่ยวข้องกับวิดีโอของช่องหรือวิดีโอของเจ้าของเนื้อหา ตัวอย่างเช่น รายงานเหล่านี้จะมียอดดูที่วิดีโอได้รับ ใน YouTube Analytics API รายงานวิดีโอบางรายการของเจ้าของเนื้อหายังมีเมตริกรายได้โดยประมาณและประสิทธิภาพของโฆษณาด้วย
รายงานเพลย์ลิสต์ รองรับสำหรับช่อง (query หรือ bulk) และเจ้าของเนื้อหา (query หรือ bulk)

รายงานเพลย์ลิสต์จะแสดงสถิติที่เกี่ยวข้องกับยอดดูวิดีโอที่เกิดขึ้นในบริบทของเพลย์ลิสต์โดยเฉพาะ Reporting API ของ YouTube รองรับรายงานการคงผู้ชมไว้สำหรับเพลย์ลิสต์ แต่ YouTube Analytics API ไม่รองรับรายงานที่คล้ายกัน
รายงานประสิทธิภาพของโฆษณา รองรับสำหรับเจ้าของเนื้อหา (query หรือ bulk)

รายงานประสิทธิภาพของโฆษณาจะแสดงเมตริกตามการแสดงผลสำหรับโฆษณาที่แสดงในระหว่างการเล่นวิดีโอ เมตริกเหล่านี้จะพิจารณาการแสดงโฆษณาแต่ละครั้ง และการเล่นวิดีโอแต่ละครั้งอาจทำให้เกิดการแสดงผลหลายครั้ง
รายงานรายได้โดยประมาณ รองรับสำหรับเจ้าของเนื้อหา (จำนวนมาก)

รายงานรายได้โดยประมาณจะแสดงรายได้โดยประมาณทั้งหมดของวิดีโอจากแหล่งที่มาของการโฆษณาที่ Google เป็นผู้ขายและจากแหล่งที่มาที่ไม่ใช่การโฆษณา รายงานเหล่านี้ยังมีเมตริกประสิทธิภาพโฆษณาบางรายการด้วย โปรดทราบว่ารายงานที่จัดการโดยระบบมีรายได้จริง
รายงานชิ้นงาน รองรับสำหรับเจ้าของเนื้อหา (จำนวนมาก)

รายงานเนื้อหาจะแสดงเมตริกกิจกรรมของผู้ใช้ที่เกี่ยวข้องกับวิดีโอที่ลิงก์กับเนื้อหาของเจ้าของเนื้อหา วิดีโอจะรวมอยู่ในรายงานของเจ้าของเนื้อหาหากเจ้าของเนื้อหาได้อ้างสิทธิ์วิดีโอนั้นว่าตรงกับเนื้อหาใดเนื้อหาหนึ่งของตน วิดีโอดังกล่าวอาจได้รับการอัปโหลดโดยเจ้าของเนื้อหาหรือผู้ใช้ YouTube รายอื่น
รายงานที่จัดการโดยระบบ ใช้ได้กับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องในเมนูรายงานของ Creator Studio ของ YouTube

รายงานที่จัดการโดยระบบจะให้ข้อมูลรายได้ตามจริงที่ได้รับผ่านเนื้อหาและวิดีโอ รายงานเพิ่มเติมจะแสดงรายการวิดีโอที่มีการอ้างสิทธิ์และเนื้อหาที่วิดีโอเหล่านั้นตรงกัน รายงานบางอย่างของ Creator Studio อาจไม่พร้อมใช้งานใน API

หมายเหตุ: YouTube จะสร้างรายงานที่ระบบจัดการโดยอัตโนมัติสำหรับเจ้าของเนื้อหาที่มีสิทธิ์เข้าถึงรายงานที่เกี่ยวข้องใน Creator Studio ด้วยเหตุนี้ กระบวนการดึงข้อมูลรายงานเหล่านี้จึงแตกต่างจากรายงานประเภทอื่นๆ ในรายการนี้ ดูข้อมูลเพิ่มเติมได้ในเอกสารประกอบสำหรับรายงานที่ระบบจัดการ

ความแตกต่างที่สำคัญ

ตารางต่อไปนี้จะไฮไลต์ความแตกต่างที่สำคัญระหว่าง API ของข้อมูลวิเคราะห์ YouTube กับ API การรายงาน

ฟีเจอร์ API ของ YouTube Analytics API การรายงานของ YouTube
กระบวนการดึงข้อมูล คำขอ API แต่ละรายการจะระบุมิติข้อมูลและเมตริกที่จะแสดง รวมถึงระยะเวลาที่จะแสดงข้อมูล แอปพลิเคชันจะกำหนดเวลางานการรายงาน สำหรับแต่ละงาน YouTube จะสร้างรายงานรายวันซึ่งดาวน์โหลดแบบไม่พร้อมกันได้
ช่วงวันที่ รายงาน API บางรายการจะระบุวันที่เกิดกิจกรรมของผู้ใช้ รายงานบางรายการรองรับมิติข้อมูลเพื่อรวบรวมเมตริกกิจกรรมของผู้ใช้ตามเดือน รายงาน API ทั้งหมดจะระบุวันที่เกิดกิจกรรมของผู้ใช้ แอปพลิเคชันที่ใช้ API สามารถใช้ฟีเจอร์เพื่อรวบรวมข้อมูลในช่วงเวลาเป็นระยะๆ ได้
การกรองข้อมูล คุณสามารถกรองรายงานให้มีเฉพาะแถวที่มิติข้อมูลมีค่าที่เฉพาะเจาะจงได้ นอกจากนี้ API ยังรองรับมิติข้อมูลบางอย่าง เช่น ทวีปและsubContinent ซึ่งใช้เป็นตัวกรองเท่านั้น API รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม โดยไม่รองรับการกรองหรือการแสดงข้อมูลสำหรับมิติข้อมูลที่ใช้กรองเท่านั้น แอปพลิเคชันไคลเอ็นต์จะจัดเก็บข้อมูลที่ดาวน์โหลดและใช้ฟีเจอร์ของตัวเองเพื่อกรองข้อมูล
การจัดเรียง จัดเรียงรายงานตามค่าเมตริกที่แสดงได้ รายงานบางรายการรองรับผลลัพธ์จำนวนจำกัดเท่านั้น เช่น รายงานที่แสดงวิดีโอที่มีการดูมากที่สุดของช่องจะแสดงแถวได้สูงสุด 200 แถว API นี้รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม แอปพลิเคชันไคลเอ็นต์สามารถใช้ฟีเจอร์ของตัวเองเพื่อจัดเรียงข้อมูลที่ดาวน์โหลดได้
การแจงนับ รายงาน API มีค่าข้อความ เช่น "ANDROID" หรือ "CHANNEL" เพื่อระบุค่ามิติข้อมูลที่แจงนับ รายงาน API มีจำนวนเต็มที่สามารถจับคู่กับค่าข้อความได้
โควต้า เซิร์ฟเวอร์ API จะประเมินการค้นหาแต่ละครั้งเพื่อกำหนดต้นทุนโควต้า ส่วนการใช้โควต้าจะอธิบายระเบียบวิธีโดยละเอียด การใช้โควต้าไม่ใช่ปัญหาเนื่องจากระบบจะดึงข้อมูลเพียงครั้งเดียว จากนั้นจะกรอง จัดเรียง และค้นหาภายในแอปพลิเคชัน
รายงานที่ไม่ซ้ำกัน
  • กิจกรรมของผู้ใช้ที่เกี่ยวข้องกับคำบรรยายแทนเสียง
  • ข้อมูลการคงผู้ชมไว้สำหรับเพลย์ลิสต์
  • รายงานรายได้โดยประมาณสำหรับเจ้าของเนื้อหา (มีรายงาน 2 ฉบับ)
  • รายงานชิ้นงานสำหรับเจ้าของเนื้อหา (มีรายงาน 11 ประเภท)
มิติข้อมูลที่ไม่ซ้ำกัน กลุ่ม (มิติข้อมูลตัวกรองเท่านั้น)
ทวีป (มิติข้อมูลตัวกรองเท่านั้น)
subContinent (มิติข้อมูลตัวกรองเท่านั้น)
เดือน
viewsPerPlaylistStart
averageTimeInPlaylist
annotation_id
annotation_type
asset_id
card_id
card_type
live_or_on_demand
subscribed_status
subtitle_language
เมตริกที่ไม่ซ้ำ ผู้ใช้ที่ไม่ซ้ำ
relativeRetentionPerformance
viewsPerPlaylistStart
averageTimeInPlaylist
card_click_rate
card_clicks
card_impressions
card_teaser_click_rate
card_teaser_clicks
card_teaser_impressions
estimated_partner_adsense_revenue
estimated_partner_doubleclick_revenue playlist_saves_added
playlist_saves_removed

ความแตกต่างในการตั้งชื่อระหว่าง API

API ทั้ง 2 รายการใช้รูปแบบการตั้งชื่อที่แตกต่างกันเพื่อระบุมิติข้อมูลและเมตริก ชื่อ API ของข้อมูลวิเคราะห์ YouTube ใช้รูปแบบ Camel Case เช่น adType ชื่อ YouTube Reporting API จะเป็นตัวพิมพ์เล็กและใช้ขีดล่าง เช่น ad_type

ตารางต่อไปนี้ระบุชื่อต่างๆ ที่ API ทั้ง 2 ใช้เพื่อระบุเมตริกและมิติข้อมูลเดียวกัน ในบางกรณี ความแตกต่างระหว่างชื่อทั้ง 2 อาจมากกว่าที่คุณจะได้รับหลังจากแปลงชื่อจากรูปแบบ CamelCase เป็นขีดล่าง เช่น มิติข้อมูล video ใน API ของข้อมูลวิเคราะห์ YouTube จะมีชื่อว่า video_id ใน API การรายงานของ YouTube

ขนาด

ชื่อ YouTube Analytics API ชื่อ API การรายงานของ YouTube
adType ad_type
ageGroup age_group
ชิ้นงาน asset_id
audienceType audience_retention_type
channel channel_id
claimedStatus claimed_status
contentOwner content_owner_id
country country_code
วัน วันที่
deviceType device_type
elapsedVideoTimeRatio elapsed_video_time_percentage
เพศ เพศ
insightPlaybackLocationDetail playback_location_detail
insightPlaybackLocationType playback_location_type
insightTrafficSourceDetail traffic_source_detail
insightTrafficSourceType traffic_source_type
liveOrOnDemand live_or_on_demand
operatingSystem operating_system
เพลย์ลิสต์ playlist_id
province province_code
sharingService sharing_service
subscribedStatus subscribed_status
subtitleLanguage subtitle_language
uploaderType uploader_type
วิดีโอ video_id

เมตริก

ชื่อ YouTube Analytics API ชื่อ API การรายงานของ YouTube
adImpressions ad_impressions
annotationClickableImpressions annotation_clickable_impressions
annotationClicks annotation_clicks
annotationClickThroughRate annotation_click_through_rate
annotationClosableImpressions annotation_closable_impressions
annotationCloses annotation_closes
annotationCloseRate annotation_close_rate
annotationImpressions annotation_impressions
audienceWatchRatio audience_retention_percentage
averageViewDuration average_view_duration_seconds
averageViewPercentage average_view_duration_percentage
cardClickRate card_click_rate
cardClicks card_clicks
cardImpressions card_impressions
cardTeaserClickRate card_teaser_click_rate
cardTeaserClicks card_teaser_clicks
cardTeaserImpressions card_teaser_impressions
ความคิดเห็น ความคิดเห็น
cpm estimated_cpm
ไม่ชอบ ไม่ชอบ
estimatedAdRevenue estimated_partner_ad_revenue
estimatedMinutesWatched watch_time_minutes
estimatedRevenue estimated_partner_revenue
grossRevenue estimated_youtube_ad_revenue
ชอบ ชอบ
monetizedPlaybacks estimated_monetized_playbacks
playbackBasedCpm estimated_playback_based_cpm
playlistStarts playlist_starts
savesAdded playlist_saves_added
savesRemoved playlist_saves_removed
หุ้น หุ้น
subscribersGained subscribers_gained
subscribersLost subscribers_lost
videosAddedToPlaylists videos_added_to_playlists
videosRemovedFromPlaylists videos_removed_from_playlist
viewerPercentage views_percentage
ยอดดู ยอดดู