Introduction

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

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

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

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

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

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

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

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

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

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

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

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

API ของ YouTube Analytics

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

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

API การรายงานของ YouTube

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

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

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

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

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

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

ประเภทรายงาน
รายงานวิดีโอ	รองรับช่อง (การค้นหาหรือจํานวนมาก) และเจ้าของเนื้อหา (การค้นหาหรือจํานวนมาก) รายงานวิดีโอจะแสดงสถิติสำหรับกิจกรรมของผู้ใช้ทั้งหมดที่เกี่ยวข้องกับวิดีโอของช่องหรือวิดีโอของเจ้าของเนื้อหา ตัวอย่างเช่น รายงานเหล่านี้ประกอบด้วยจำนวนการดูที่วิดีโอของคุณได้รับ ใน API ของ YouTube Analytics รายงานวิดีโอสำหรับเจ้าของเนื้อหาบางรายการจะรวมเมตริกรายได้โดยประมาณและประสิทธิภาพโฆษณาไว้ด้วย
รายงานเพลย์ลิสต์	รองรับช่อง (การค้นหาหรือจํานวนมาก) และเจ้าของเนื้อหา (การค้นหาหรือจํานวนมาก) รายงานเพลย์ลิสต์จะแสดงสถิติที่เกี่ยวข้องกับยอดดูวิดีโอที่เกิดขึ้นในบริบทของเพลย์ลิสต์โดยเฉพาะ API การรายงานของ YouTube รองรับรายงานการรักษาผู้ชมสำหรับเพลย์ลิสต์ แต่ API ของ YouTube Analytics ไม่รองรับรายงานที่คล้ายกัน
รายงานประสิทธิภาพของโฆษณา	รองรับสำหรับเจ้าของเนื้อหา (คำค้นหาหรือแบบกลุ่ม) รายงานประสิทธิภาพของโฆษณาจะระบุเมตริกตามการแสดงผลสำหรับโฆษณาที่แสดงระหว่างการเล่นวิดีโอ เมตริกเหล่านี้พิจารณาการแสดงโฆษณาแต่ละครั้ง และการเล่นวิดีโอแต่ละครั้งสามารถทำให้เกิดการแสดงผลหลายครั้ง
รายงานรายได้โดยประมาณ	รองรับสำหรับเจ้าของเนื้อหา (จำนวนมาก) รายงานรายได้โดยประมาณจะระบุรายได้ทั้งหมดโดยประมาณสำหรับวิดีโอจากแหล่งที่มาของโฆษณาที่ 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 ยังรองรับมิติข้อมูลบางอย่าง เช่น ทวีป และ subContinent ซึ่งใช้เป็นตัวกรองเท่านั้น	API รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม ไม่รองรับการกรองหรือแสดงผลข้อมูลสำหรับมิติข้อมูลตัวกรองเท่านั้น แอปพลิเคชันไคลเอ็นต์จะเก็บข้อมูลที่ดาวน์โหลด และใช้ฟีเจอร์ของตัวเองเพื่อกรองข้อมูล
การจัดเรียง	คุณสามารถจัดเรียงรายงานตามค่าเมตริกที่แสดงผลได้ บางรายงานรองรับผลลัพธ์จำนวนจำกัด ตัวอย่างเช่น รายงานที่แสดงวิดีโอที่มีคนดูมากที่สุดของช่องจะแสดงแถวข้อมูลสูงสุด 200 แถว	API นี้รองรับการดาวน์โหลดชุดข้อมูลที่สมบูรณ์แบบเป็นกลุ่ม แอปพลิเคชันไคลเอ็นต์สามารถใช้ฟีเจอร์ของตนเองเพื่อจัดเรียงข้อมูลที่ดาวน์โหลด
การแจกแจง	รายงาน API มีค่าข้อความ เช่น "ANDROID" หรือ "CHANNEL" เพื่อระบุค่ามิติข้อมูลที่ระบุ	รายงาน API มีจํานวนเต็มที่แมปกับค่าข้อความได้
โควต้า	เซิร์ฟเวอร์ API จะประเมินการค้นหาแต่ละรายการเพื่อระบุต้นทุนของโควต้า ส่วนการใช้โควต้าจะอธิบายวิธีการโดยละเอียด	การใช้โควต้าไม่ใช่ปัญหาเนื่องจากมีการดึงข้อมูลเพียงครั้งเดียว จากนั้นจะมีการกรอง จัดเรียง และค้นหาภายในแอปพลิเคชัน
รายงานที่ไม่ซ้ำกัน		กิจกรรมของผู้ใช้ที่เกี่ยวข้องกับคำบรรยาย ข้อมูลการคงผู้ชมไว้ของเพลย์ลิสต์ รายงานรายได้โดยประมาณสำหรับเจ้าของเนื้อหา (มีรายงานที่แตกต่างกัน 2 แบบ) รายงานเนื้อหาสำหรับเจ้าของเนื้อหา (มีรายงานที่แตกต่างกัน 11 แบบ)
มิติข้อมูลที่ไม่ซ้ำ	กลุ่ม (มิติข้อมูลตัวกรองเท่านั้น) ทวีป (มิติข้อมูลตัวกรองเท่านั้น) subContinent (มิติข้อมูลตัวกรองเท่านั้น) เดือน isCurated==1 (มิติข้อมูลตัวกรองเท่านั้น) viewsPerPlaylistStart averageTimeInPlaylist	annotation_id annotation_type asset_id card_id card_type live_or_on_demand subscribed_status subtitle_language
เมตริกที่ไม่ซ้ำกัน	uniques 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_revenueplaylist_saves_addedplaylist_saves_removed

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

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

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

ขนาด

ชื่อ API ของ YouTube Analytics	ชื่อ API การรายงานของ YouTube
adType	ad_type
ageGroup	age_group
เนื้อหา	asset_id
audienceType	audience_retention_type
ช่อง	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

เมตริก

ชื่อ API ของ YouTube Analytics	ชื่อ API การรายงานของ YouTube
adEarnings	estimated_partner_ad_revenue
annotationImpressions	annotation_impressions
annotationClickableImpressions	annotation_clickable_impressions
annotationClicks	annotation_clicks
annotationClickThroughRate	annotation_click_through_rate
annotationClosableImpressions	annotation_closable_impressions
annotationCloses	annotation_closes
annotationCloseRate	annotation_close_rate
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
ความคิดเห็น	ความคิดเห็น
ไม่ชอบ	ไม่ชอบ
รายได้	estimated_partner_revenue
estimatedMinutesWatched	watch_time_minutes
estimatedPartnerAdSenseRevenue	estimated_partner_adsense_revenue
estimatedPartnerDoubleClickRevenue	estimated_partner_doubleclick_revenue
grossRevenue	estimated_youtube_ad_revenue
impressionBasedCpm	estimated_cpm
ครั้ง	ad_impressions
สิ่งที่ชอบ	สิ่งที่ชอบ
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
ครั้ง	ครั้ง