Introduction

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

มิติข้อมูล

ชื่อ API ของ YouTube Analytics ชื่อ API การรายงานของ YouTube
adType ad_type
ageGroup กลุ่มอายุ [age_group]
เนื้อหา asset_id
ประเภทกลุ่มเป้าหมาย ประเภทการรักษาผู้ชม [audience_retention_type]
ช่อง รหัสช่อง [channel_id]
ClaimStatus claim_status
เจ้าของเนื้อหา รหัสเจ้าของเนื้อหา [content_owner_id]
country รหัสประเทศ [country_code]
วัน วันที่
ประเภทอุปกรณ์ ประเภทอุปกรณ์
อัตราส่วนวิดีโอเวลาที่ผ่านไป เปอร์เซ็นต์วิดีโอเวลาที่ผ่านไป
เพศ เพศ
อินไซท์การเล่นตำแหน่งรายละเอียด รายละเอียดตำแหน่งการเล่น
InsightPlayLocationType ประเภทตำแหน่งการเล่น
InsightTrafficSourceDetail รายละเอียดแหล่งที่มาของการเข้าชม [traffic_source_detail]
insightTrafficSourceType ประเภทแหล่งที่มาของการเข้าชม [traffic_source_type]
LiveOrOnDemand สดหรือออนดีมานด์
ระบบปฏิบัติการ ระบบปฏิบัติการ
เพลย์ลิสต์ รหัสเพลย์ลิสต์
province รหัสจังหวัด
บริการการแชร์ บริการการแชร์
subscribedStatus สถานะติดตามแล้ว
subtitleLanguage ภาษาคำบรรยาย
ประเภทผู้อัปโหลด ประเภทผู้อัปโหลด
วิดีโอ รหัสวิดีโอ [video_id]

เมตริก

ชื่อ API ของ YouTube Analytics ชื่อ API การรายงานของ YouTube
รายได้จากโฆษณา estimated_partner_ad_revenue
การแสดงผลคำอธิบายประกอบ annotation_impressions
annotationClickableImpressions annotation_clickable_impressions
การคลิกคำอธิบายประกอบ คลิกคำอธิบายประกอบ
annotationClickThroughRate อัตราการคลิกผ่าน [annotation_click_through_rate]
annotationClosableImpressions annotation_closable_impressions
annotationCloses annotation_closes
annotationCloseRate อัตราปิดคำอธิบายประกอบ [annotation_close_rate]
AudienceRatio ของกลุ่มเป้าหมาย กลุ่มเป้าหมาย [audience_retention_percentage]
ระยะเวลาการดูเฉลี่ย เฉลี่ย_view_duration_seconds
เปอร์เซ็นต์การแสดงผลเฉลี่ย เฉลี่ย_view_duration_percentage
cardClickRate อัตราการคลิกบัตร
cardclicks card_clicks
cardImpressions card_impressions
cardTeaserClickRate card_teaser_click_rate
การ์ดTeaserClicks card_teaser_clicks
cardTeaserImpressions card_teaser_impressions
ความคิดเห็น ความคิดเห็น
ไม่ชอบ ไม่ชอบ
รายได้ รายได้โดยประมาณของพาร์ทเนอร์ [estimated_partner_revenue]
estimatedMinutesWatched เวลาในการรับชม นาที
รายได้โดยประมาณของพาร์ทเนอร์ AdSense estimated_partner_adsense_revenue
รายได้โดยประมาณของพาร์ทเนอร์ DoubleClick estimated_partner_doubleclick_revenue
รายได้รวม estimated_youtube_ad_revenue
impressionBasedCpm CPM โดยประมาณ
ครั้ง ad_impressions
การกดชอบ การกดชอบ
Monetizeedplays estimated_monetizationed_playbacks
Cpm ตามการเล่น estimated_playback_based_cpm
playlistStarts เริ่มเพลย์ลิสต์
เพิ่มแล้ว บันทึกเพลย์ลิสต์แล้ว
นำการบันทึกออกแล้ว นำเพลย์ลิสต์_บันทึกออก
การแชร์ การแชร์
จำนวนผู้ติดตามที่ได้รับ Subscriber_gained
สมาชิกที่เสียข้อมูล สมาชิกที่สูญหาย
วิดีโอที่เพิ่มในเพลย์ลิสต์ วิดีโอที่เพิ่มไว้ใน_playlists
วิดีโอที่นำออกจากเพลย์ลิสต์ วิดีโอที่ถูกนําออกจากเพลย์ลิสต์
เปอร์เซ็นต์ของผู้ชม เปอร์เซ็นต์การดู
ครั้ง ครั้ง