YouTube Analytics API - Data Model

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

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

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

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

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

การเลือกพารามิเตอร์รายงาน

เมื่อคุณขอรายงานโดยใช้เมธอด reports.query ของ API คำขอ API จะมีพารามิเตอร์ 5 รายการที่กำหนดวิธีคำนวณค่ารายงาน

  • พารามิเตอร์ startDate และ endDate จะระบุระยะเวลาที่รายงานจะมีข้อมูล การตอบกลับของ API มีข้อมูลจนถึงวันสุดท้ายที่ระบุ ซึ่งเมตริกทั้งหมดในการค้นหาจะพร้อมใช้งาน ณ เวลาที่ทำการค้นหา

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

  • dimensions พารามิเตอร์จะอธิบายวิธีจัดกลุ่มเมตริก

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

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

ตัวเลือกการรายงานตัวอย่าง

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

  • เจ้าของช่องตั้งค่าพารามิเตอร์ startDate เป็น 2015-06-01 และพารามิเตอร์ endDate เป็น 2015-07-31 รายงานจะมีข้อมูลเป็นระยะเวลา 2 เดือนโดยอิงตามค่าเหล่านี้

  • รายงานประเภทอุปกรณ์รองรับเมตริกยอดดูและestimatedMinutesWatched ดังนั้นเจ้าของช่องจึงตั้งค่าพารามิเตอร์ metrics เป็น views,estimatedMinutesWatched

  • สำหรับพารามิเตอร์ dimensions เจ้าของช่องมีตัวเลือกหลายอย่าง โดย 2 รายการจะแสดงในรายการต่อไปนี้ และอีก 1 รายการจะอธิบายในคำอธิบายค่าพารามิเตอร์ filters ในส่วนนี้

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

      • วิดีโอของช่องได้รับการดูบนอุปกรณ์เคลื่อนที่กี่ครั้งระหว่างวันที่ 1 มิถุนายน 2015 ถึง 31 กรกฎาคม 2015
      • วิดีโอของช่องได้รับการดูบนเครื่องเล่นเกมกี่ครั้งระหว่างวันที่ 1 มิถุนายน 2015 ถึง 31 กรกฎาคม 2015

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

    • การตั้งค่าพารามิเตอร์เป็น day,deviceType หมายความว่าระบบจะคำนวณยอดดูและเวลาในการดูตามประเภทอุปกรณ์ในแต่ละวันระหว่างระยะเวลาการรายงาน ดังนั้น ค่านี้จะช่วยให้ข้อมูลรายงานตอบคำถามต่างๆ เช่น

      • วิดีโอของช่องได้รับการดูบนอุปกรณ์เคลื่อนที่กี่ครั้งในวันที่ 1 มิถุนายน 2015
      • มีการดูวิดีโอของช่องบนทีวีกี่ครั้งในวันที่ 14 กรกฎาคม 2015

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

    • เจ้าของช่องสามารถกรองคำขอเพื่อแสดงค่าสำหรับระบบปฏิบัติการ Android เท่านั้น (มีการดูบนอุปกรณ์เคลื่อนที่ Android กี่ครั้งในระยะเวลาการรายงาน)

    • เจ้าของช่องสามารถกรองคำขอเพื่อแสดงค่าสำหรับประเทศใดประเทศหนึ่งเท่านั้น (มีการดูวิดีโอในแคนาดากี่ครั้งในแต่ละวันของระยะเวลารายงาน)

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

      นอกจากนี้ หากตัวกรองวิดีโอระบุค่าหลายค่า ก็สามารถระบุวิดีโอเป็นมิติข้อมูลได้เช่นกัน ซึ่งหมายความว่าพารามิเตอร์ dimensions รองรับค่า deviceType,video และ day,deviceType,video ด้วย

      • หากเจ้าของช่องใส่วิดีโอในรายการมิติข้อมูล เมตริกจะระบุค่าแต่ละค่าของวิดีโอแต่ละรายการ (มีการดูวิดีโอ XYZ บนคอนโซลเกมกี่ครั้งในวันที่ 1 มิถุนายน 2015)
      • หากเจ้าของช่องไม่รวมวิดีโอไว้ในรายการมิติข้อมูล เมตริกจะระบุค่าทั้งหมดที่ครอบคลุมวิดีโอที่ระบุทั้งหมด (มีการดูวิดีโอ ABC, DEF และ XYZ บนคอนโซลเกมกี่ครั้งในวันที่ 1 มิถุนายน 2015)

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

หากต้องการดึงข้อมูลรายงาน ให้ส่งคำขอ GET ที่ได้รับอนุญาตไปยังเมธอด reports.query ของ API โดยระบุพารามิเตอร์ที่กำหนดรายงานที่คุณต้องการดึงข้อมูล

ดูรายการรายงานที่ API รองรับได้ในเอกสารประกอบรายงานช่องและรายงานเจ้าของเนื้อหา คําจํากัดความของรายงานแต่ละรายการจะระบุค่าที่รายงานอนุญาตสําหรับพารามิเตอร์ metrics, dimensions และ filters

แนวทางปฏิบัติแนะนำ

แอปพลิเคชันที่ใช้ YouTube Analytics API ควรปฏิบัติตามแนวทางต่อไปนี้เสมอ

  • ใช้แถวส่วนหัวของคำตอบเพื่อกำหนดลำดับของคอลัมน์ในรายงาน เช่น อย่าคิดว่ายอดดูจะเป็นเมตริกแรกที่แสดงในคำตอบเพียงเพราะเป็นเมตริกแรกที่แสดงในคำอธิบายรายงาน แต่ให้ใช้แถวส่วนหัวของคำตอบเพื่อระบุว่าคอลัมน์ใดมีข้อมูลนั้น
  • ใช้ Data API ของ YouTube เพื่อเรียกข้อมูลเมตาเพิ่มเติมสำหรับทรัพยากรที่ระบุในการตอบกลับของ API ของข้อมูลวิเคราะห์ YouTube ดังที่ระบุไว้ในนโยบายสำหรับนักพัฒนาซอฟต์แวร์ของบริการ YouTube API (ส่วนที่ III.E.4.b ถึง III.E.4.d) ไคลเอ็นต์ API ต้องลบหรือรีเฟรชข้อมูลเมตาของทรัพยากรที่จัดเก็บจาก API นั้นหลังจากผ่านไป 30 วัน

เมตริกแบบรวมและรายการที่ถูกลบ

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

ตัวอย่างเช่น สมมติว่าเจ้าของช่องดึงข้อมูลรายงาน 2 ฉบับ รายงานแรกจะแสดงยอดดูรายวันทั้งหมดของวิดีโอทั้งหมดในช่องในช่วงระยะเวลาหนึ่งๆ รายงานที่ 2 แสดงยอดดูรายวันทั้งหมดของวิดีโอแต่ละรายการในช่วงเวลาเดียวกัน

ในกรณีนี้ ตัวเลขในรายงานแรกจะรวมยอดดูของวิดีโอที่ถูกลบในภายหลัง เนื่องจากรายงานแรกมีข้อมูลรวมรายวัน อย่างไรก็ตาม รายงานที่ 2 จะไม่รวมยอดดูที่เชื่อมโยงกับรายการที่ถูกลบเนื่องจากรายงานที่ 2 แสดงยอดดูแบบวิดีโอต่อวิดีโอ ด้วยเหตุนี้ หากช่องลบวิดีโอในช่วงระยะเวลาที่รายงานครอบคลุม ยอดดูรายวันทั้งหมดที่รายงานในรายงานแรกอาจสูงกว่าผลรวมของยอดดูรายวันเฉพาะวิดีโอในรายงานที่ 2

การลบข้อมูลระบุตัวบุคคล

ข้อมูลวิเคราะห์ YouTube บางอย่างจะถูกจำกัดเมื่อเมตริกไม่ถึงเกณฑ์ที่กำหนด ซึ่งอาจเกิดขึ้นได้ในรายงานต่างๆ ในทางปฏิบัติ หมายความว่ารายงานอาจไม่มีข้อมูลทั้งหมด (หรือไม่มีข้อมูลเลย) ในกรณีต่อไปนี้

  1. วิดีโอหรือช่องมีปริมาณการเข้าชมจำกัดในระยะเวลาที่กำหนด

    หรือ

  2. คุณเลือกตัวกรองหรือมิติข้อมูล เช่น แหล่งที่มาของการเข้าชมหรือประเทศ ซึ่งมีค่าไม่ถึงเกณฑ์ที่กำหนด

ในกรณีที่มีข้อมูลจำกัด ยอดรวมที่แสดงในรายงานต่างๆ อาจแตกต่างกัน โดยขึ้นอยู่กับวิธีที่รายงานเหล่านั้นรวบรวมข้อมูล

ตัวอย่างเช่น สมมติว่าเจ้าของช่องดึงข้อมูลรายงาน 2 ฉบับ รายงานแรกแสดงยอดดูทั้งหมดของวิดีโอหนึ่งๆ ส่วนรายงานที่ 2 แสดงยอดดูทั้งหมดของวิดีโอนั้นๆ โดยแยกตามประเทศ และสมมติว่าในระยะเวลาที่กำหนด มีการดูวิดีโอ 1,000 ครั้ง โดยมียอดดู 500 ครั้งในสหรัฐอเมริกา 498 ครั้งในแคนาดา และ 2 ครั้งในฝรั่งเศส

ในตัวอย่างนี้ รายงานแรกจะระบุว่าวิดีโอมียอดดู 1, 000 ครั้ง ส่วนรายงานที่ 2 จะระบุว่ามียอดดูวิดีโอในสหรัฐอเมริกาเพียง 500 ครั้งและมียอดดูในแคนาดา 498 ครั้ง ดังนั้น ยอดดูรวมในรายงานทั้ง 2 ฉบับจึงแตกต่างกัน โปรดทราบว่ารายงานที่ 2 จะไม่มีข้อบ่งชี้ว่ามียอดดูอื่นๆ อีก 2 ครั้ง (หรือมียอดดูในฝรั่งเศส)

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

ประเภทข้อมูลที่จำกัด

ข้อมูลต่อไปนี้อาจถูกจำกัดในรายงานข้อมูลวิเคราะห์ YouTube

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

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

การใช้โควต้า

คำขอ API แต่ละรายการที่คุณส่งจะนับเป็นโควต้าการใช้งาน API 1 หน่วย ขีดจำกัดโควต้าจะแสดงในแผงโควต้าในคอนโซล Google API