YouTube Reporting API - Get Bulk Data Reports

สำคัญ: รายงาน API รายวันและรายงานการทดแทนข้อมูลจะใช้งานได้เป็นเวลา 60 วันนับจากวันที่สร้าง รายงานข้อมูลย้อนหลังจะใช้งานได้เป็นเวลา 30 วันนับจากวันที่สร้าง

นโยบายนี้มีผลบังคับใช้ทั่วโลกกับรายงานและงานการรายงานทั้งหมด ดูรายละเอียดทั้งหมดได้ที่ประวัติการแก้ไขของ YouTube Reporting API

Reporting API ของ YouTube รองรับรายงานที่กําหนดไว้ล่วงหน้าซึ่งมีชุดข้อมูล YouTube Analytics ที่ครอบคลุมสําหรับช่องหรือเจ้าของเนื้อหา รายงานเหล่านี้ช่วยให้คุณดาวน์โหลดชุดข้อมูลจำนวนมากซึ่งสามารถค้นหาได้ด้วย YouTube Analytics API หรือในส่วน Analytics ของ Creator Studio

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

ภาพรวม

ช่องรายงานในรายงานเหล่านี้มีลักษณะเป็นมิติข้อมูลหรือเมตริก

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

ตัวอย่างเช่น รายงานกิจกรรมของผู้ใช้พื้นฐานสําหรับแชแนลจะมีมิติข้อมูลต่อไปนี้

• day: วันที่เกิดกิจกรรม
• channel: ช่อง YouTube ที่เชื่อมโยงกับกิจกรรม
• video: วิดีโอ YouTube ที่เชื่อมโยงกับกิจกรรม
• liveOrOnDemand: ค่าที่ระบุว่าผู้ชมกำลังดูสตรีมวิดีโอสดอยู่หรือไม่
• subscribedStatus: ค่าที่ระบุว่าผู้ชมติดตามช่องหรือไม่
• country: ประเทศที่ผู้ชมอาศัยอยู่

รายงานยังมีเมตริกจํานวนมาก เช่น ยอดดู การกดชอบ และ averageViewDuration หลังจากดึงข้อมูลและนําเข้ารายงานแล้ว แอปพลิเคชันอาจทําการคํานวณหลายแบบโดยอิงตามค่ามิติข้อมูลทั่วไป

เช่น หากต้องการคํานวณจํานวนยอดดูทั้งหมดในเยอรมนีในวันที่ที่เจาะจง ให้รวมค่าเมตริกยอดดูของทุกแถวที่มีค่าคอลัมน์ประเทศเป็น DE และค่าคอลัมน์วันเป็นวันที่ในรูปแบบ YYYY-MM-DD

การเรียกข้อมูลรายงาน YouTube Analytics

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

ขั้นตอนที่ 1: เรียกข้อมูลเข้าสู่ระบบการให้สิทธิ์

คำขอ YouTube Reporting API ทั้งหมดต้องได้รับอนุญาต หากต้องการเรียกข้อมูลโทเค็นการให้สิทธิ์ผ่านโปรโตคอล OAuth 2.0 โปรดดูคำแนะนำการให้สิทธิ์

คำขอ YouTube Reporting API ใช้ขอบเขตการให้สิทธิ์ต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/yt-analytics.readonly	ดูรายงาน YouTube Analytics สำหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้ให้สิทธิ์เข้าถึงเมตริกกิจกรรมของผู้ใช้ เช่น จํานวนยอดดูและจํานวนการให้คะแนน
https://www.googleapis.com/auth/yt-analytics-monetary.readonly	ดูรายงานด้านการเงินของ YouTube Analytics สำหรับเนื้อหา YouTube ของคุณ ขอบเขตนี้ให้สิทธิ์เข้าถึงเมตริกกิจกรรมของผู้ใช้ รวมถึงเมตริกรายได้และประสิทธิภาพโฆษณาโดยประมาณ

ขั้นตอนที่ 2: ระบุรายงานที่จะดึงข้อมูล

เรียกใช้เมธอด reportTypes.list ของ API เพื่อดึงรายการรายงานที่สามารถสร้างสําหรับช่องหรือเจ้าของเนื้อหา วิธีการนี้จะแสดงรายการรหัสและชื่อรายงาน บันทึกค่าพร็อพเพอร์ตี้ id สำหรับรายงานที่ต้องการสร้าง ตัวอย่างเช่น รหัสของรายงานกิจกรรมของผู้ใช้พื้นฐานสำหรับแชแนลคือ channel_basic_a1

นอกจากนี้ คุณยังดูชื่อรายงานในเอกสารประกอบที่ระบุรายงานช่องและรายงานเจ้าของเนื้อหาที่รองรับได้ด้วย

ขั้นตอนที่ 3: สร้างงานการรายงาน

YouTube จะไม่เริ่มสร้างรายงานจนกว่าคุณจะสร้างงานการรายงานสําหรับรายงานนั้น (ระบบจึงจะสร้างรายงานให้เฉพาะช่องและเจ้าของเนื้อหาที่ต้องการเรียกข้อมูลดังกล่าวจริงๆ เท่านั้น)

หากต้องการสร้างงานการรายงาน ให้เรียกใช้เมธอด jobs.create ของ API ตั้งค่าต่อไปนี้ในเนื้อหาคำขอ

• ตั้งค่าพร็อพเพอร์ตี้ reportTypeId เป็นรหัสรายงานที่คุณดึงข้อมูลไว้ในขั้นตอนที่ 2
• กําหนดค่าของพร็อพเพอร์ตี้ name เป็นชื่อที่ต้องการเชื่อมโยงกับรายงาน

การตอบกลับของ API กับเมธอด jobs.create มีทรัพยากร Job ซึ่งระบุ ID ที่ระบุงานนั้นๆ ได้อย่างไม่ซ้ำกัน คุณจะเริ่มเรียกข้อมูลรายงานได้ภายใน 48 ชั่วโมงนับจากเวลาที่สร้างงาน และรายงานแรกที่พร้อมใช้งานจะเป็นรายงานของวันที่ที่คุณตั้งเวลางานไว้

เช่น หากคุณตั้งเวลางานไว้ในวันที่ 1 กันยายน รายงานสำหรับวันที่ 1 กันยายนจะพร้อมใช้งานในวันที่ 3 กันยายน รายงานสำหรับวันที่ 2 กันยายนจะโพสต์ในวันที่ 4 กันยายน

ขั้นตอนที่ 4: เรียกข้อมูลรหัสงาน

หมายเหตุ: หากแอปพลิเคชันของคุณจัดเก็บรหัสงานที่แสดงผลในขั้นตอนที่ 3 ไว้ คุณจะข้ามขั้นตอนนี้ได้

เรียกใช้เมธอด jobs.list เพื่อเรียกข้อมูลรายการงานที่กําหนดเวลาไว้ พร็อพเพอร์ตี้ reportTypeId ในแหล่งข้อมูล Job แต่ละรายการที่แสดงจะระบุประเภทรายงานที่งานนั้นสร้าง แอปพลิเคชันของคุณต้องใช้ค่าพร็อพเพอร์ตี้ id จากแหล่งข้อมูลเดียวกันในขั้นตอนถัดไป

ขั้นตอนที่ 5: เรียกข้อมูล URL การดาวน์โหลดของรายงาน

เรียกใช้เมธอด jobs.reports.list เพื่อเรียกข้อมูลรายการรายงานที่สร้างสำหรับงาน ในคําขอ ให้ตั้งค่าพารามิเตอร์ jobId เป็นรหัสงานของรายงานที่ต้องการเรียกข้อมูล

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

การตอบกลับของ API จะมีรายการทรัพยากร Report สําหรับงานนั้น ทรัพยากรแต่ละรายการหมายถึงรายงานที่มีข้อมูลของระยะเวลา 24 ชั่วโมงที่ไม่ซ้ำกัน โปรดทราบว่า YouTube จะสร้างรายงานที่ดาวน์โหลดได้สำหรับวันที่ที่ไม่มีข้อมูล รายงานเหล่านั้นมีแถวส่วนหัวแต่ไม่มีข้อมูลเพิ่มเติม

• พร็อพเพอร์ตี้ startTime และ endTime ของทรัพยากรจะระบุระยะเวลาที่ข้อมูลของรายงานครอบคลุม
• พร็อพเพอร์ตี้ downloadUrl ของทรัพยากรจะระบุ URL ที่ดึงข้อมูลรายงานได้
• พร็อพเพอร์ตี้ createTime ของทรัพยากรจะระบุวันที่และเวลาที่สร้างรายงาน แอปพลิเคชันควรจัดเก็บค่านี้และใช้เพื่อระบุว่ารายงานที่ดาวน์โหลดไว้ก่อนหน้านี้มีการเปลี่ยนแปลงหรือไม่

ขั้นตอนที่ 6: ดาวน์โหลดรายงาน

ส่งคำขอ HTTP GET ไปยัง downloadUrl ที่ได้ในขั้นตอนที่ 5 เพื่อเรียกข้อมูลรายงาน

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

หากต้องการรับการตอบกลับที่เข้ารหัส gzip ให้ตั้งค่าส่วนหัวคำขอ HTTP Accept-Encoding เป็น gzip ดังที่แสดงในตัวอย่างต่อไปนี้

Accept-Encoding: gzip

รายงานการประมวลผล

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

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

• หากต้องการกําหนดลําดับของคอลัมน์ในรายงาน ให้ใช้แถวส่วนหัวของรายงาน ตัวอย่างเช่น อย่าคิดว่ายอดดูจะเป็นเมตริกแรกที่แสดงในรายงานเพียงเพราะเมตริกนี้เป็นเมตริกแรกที่แสดงในคําอธิบายรายงาน แต่ให้ใช้แถวส่วนหัวของรายงานเพื่อดูว่าคอลัมน์ใดมีข้อมูลนั้น

• โปรดบันทึกรายงานที่ดาวน์โหลดไว้เพื่อหลีกเลี่ยงการประมวลผลรายงานเดิมซ้ำๆ รายการต่อไปนี้แสดงวิธีดำเนินการ 2 วิธี

  • เมื่อเรียกใช้เมธอด reports.list ให้ใช้พารามิเตอร์ createdAfter เพื่อดึงเฉพาะรายงานที่สร้างหลังจากวันที่ที่ระบุ (ละเว้นพารามิเตอร์ createdAfter เมื่อเรียกข้อมูลรายงานเป็นครั้งแรก)

    ทุกครั้งที่คุณดึงข้อมูลและประมวลผลรายงานสําเร็จ ให้จัดเก็บการประทับเวลาที่สอดคล้องกับวันที่และเวลาที่สร้างรายงานล่าสุด จากนั้นอัปเดตค่าพารามิเตอร์ createdAfter ในการเรียกใช้เมธอด reports.list แต่ละครั้งเพื่อให้แน่ใจว่าคุณดึงข้อมูลเฉพาะรายงานใหม่เท่านั้น ซึ่งรวมถึงรายงานใหม่ที่ทดแทนข้อมูลทุกครั้งที่คุณเรียกใช้ API

    เพื่อเป็นการป้องกัน โปรดตรวจสอบก่อนเรียกข้อมูลรายงานว่ารหัสของรายงานนั้นไม่ได้แสดงอยู่ในฐานข้อมูลแล้ว

  • จัดเก็บรหัสของรายงานแต่ละรายการที่คุณดาวน์โหลดและประมวลผลแล้ว นอกจากนี้ คุณยังจัดเก็บข้อมูลเพิ่มเติม เช่น วันที่และเวลาที่สร้างรายงานแต่ละฉบับ หรือ startTime และ endTime ของรายงาน ซึ่งจะระบุระยะเวลาที่รายงานมีข้อมูล โปรดทราบว่างานแต่ละรายการมีแนวโน้มที่จะมีรายงานหลายฉบับ เนื่องจากแต่ละรายงานมีข้อมูลของระยะเวลา 24 ชั่วโมง

    ใช้รหัสรายงานเพื่อระบุรายงานที่ยังคงต้องดาวน์โหลดและนําเข้า อย่างไรก็ตาม หากรายงานใหม่ 2 ฉบับมีค่าพร็อพเพอร์ตี้ startTime และ endTime เหมือนกัน ให้นำเข้าเฉพาะรายงานที่มีค่า createTime ใหม่กว่า

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

ลักษณะของรายงาน

รายงาน API เป็นไฟล์ .csv (ค่าที่คั่นด้วยคอมมา) ที่มีเวอร์ชัน ซึ่งมีคุณลักษณะต่อไปนี้

• รายงานแต่ละฉบับมีข้อมูลของระยะเวลา 24 ชั่วโมงที่ไม่ซ้ำกัน ซึ่งเริ่มตั้งแต่เวลา 00:00 น. ถึง 23:59 น. ตามเวลามาตรฐานแปซิฟิก (UTC-8) ดังนั้น ค่ามิติข้อมูลวันในรายงานหนึ่งๆ จึงเหมือนกันเสมอ

• รายงานจะอัปเดตทุกวัน

• YouTube จะสร้างรายงานที่ดาวน์โหลดได้สำหรับวันที่ที่ไม่มีข้อมูล รายงานเหล่านั้นจะมีแถวส่วนหัว แต่จะไม่มีข้อมูลเพิ่มเติม

• รายงาน API จะใช้งานได้เป็นเวลา 60 วันนับจากวันที่สร้าง ยกเว้นข้อมูลย้อนหลังที่สร้างขึ้นสําหรับงานการรายงานใหม่ คุณจะเข้าถึงรายงานไม่ได้เมื่อรายงานมีอายุมากกว่า 60 วัน
• รายงานที่มีข้อมูลย้อนหลังจะใช้งานได้เป็นเวลา 30 วันนับจากวันที่สร้าง รายงานที่มีข้อมูลย้อนหลังจะเข้าถึงไม่ได้เมื่อมีอายุมากกว่า 30 วัน

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

  แม้ว่าระบบจะไม่กรองข้อมูลรายงาน แต่รายงานจะไม่อ้างอิงถึงทรัพยากร YouTube ที่ถูกลบอย่างน้อย 30 วันก่อนวันที่สร้างรายงาน

• ระบบไม่ได้จัดเรียงข้อมูลรายงาน

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

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

ทดแทนข้อมูล

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

หาก YouTube มีข้อมูลทดแทน ระบบจะสร้างรายงานใหม่ที่มีรหัสรายงานใหม่ ในกรณีนี้ ค่าพร็อพเพอร์ตี้ startTime และ endTime ของรายงานจะตรงกับเวลาเริ่มต้นและเวลาสิ้นสุดของรายงานที่มีก่อนหน้านี้และคุณอาจดาวน์โหลดไว้ก่อนหน้านี้

รายงานการทดแทนข้อมูลจะไม่อ้างอิงถึงทรัพยากร YouTube ที่ถูกลบอย่างน้อย 30 วันก่อนวันที่สร้างรายงาน

ข้อมูลย้อนหลัง

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

ระบบจะโพสต์รายงานย้อนหลังทันทีที่พร้อมใช้งาน โดยทั่วไปแล้ว ระบบจะโพสต์ข้อมูลย้อนหลังทั้งหมดของงานภายใน 2-3 วัน ตามที่อธิบายไว้ในส่วนลักษณะของรายงาน รายงานที่มีข้อมูลย้อนหลังจะใช้งานได้เป็นเวลา 30 วันนับจากวันที่สร้าง รายงานที่ไม่มีข้อมูลย้อนหลังจะใช้งานได้เป็นเวลา 60 วัน

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

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

เช่น ในรายงานแหล่งที่มาของการเข้าชมวิดีโอสำหรับแชแนล แต่ละแถวจะมีมิติข้อมูลหลายรายการ ซึ่งรวมถึง trafficSourceType และ trafficSourceDetail แต่ละแถวยังมีเมตริกต่างๆ ด้วย รวมถึงยอดดู ในแถวที่อธิบายการเข้าชมที่มาจาก YouTube Search มิติข้อมูล trafficSourceDetail จะระบุข้อความค้นหาที่ทําให้เกิดการเข้าชม

ในตัวอย่างนี้ กฎต่อไปนี้จะมีผล

• รายงานแหล่งที่มาของการเข้าชมจะระบุข้อความค้นหา (trafficSourceDetail) เฉพาะในกรณีที่ข้อความค้นหาดังกล่าวทําให้วิดีโอหนึ่งๆ มียอดดูถึงจำนวนหนึ่งเป็นอย่างน้อยในวันหนึ่งๆ ในกรณีนี้ views คือเมตริก video คือมิติข้อมูลการรวม และ trafficSourceDetail คือมิติข้อมูลที่ลบการระบุตัวบุคคล

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

ตารางต่อไปนี้แสดงกฎเหล่านี้ ตารางแรกประกอบด้วยชุดข้อมูลดิบสมมติที่ YouTube จะใช้ในการสร้างรายงานแหล่งที่มาของการเข้าชม และตารางที่ 2 มีรายงานดังกล่าว ในตัวอย่างนี้ เกณฑ์จำนวนยอดดูคือ 10 ซึ่งหมายความว่ารายงานจะระบุคำค้นหาเฉพาะในกรณีที่คำค้นหานั้นทําให้วิดีโอหนึ่งๆ มียอดดูอย่างน้อย 10 ครั้งในวันหนึ่งๆ (เกณฑ์จริงอาจมีการเปลี่ยนแปลง)

ข้อมูลการเข้าชมจากการค้นหาบน YouTube ของวิดีโอแบบดิบ

สมมติว่าข้อมูลด้านล่างอธิบายการเข้าชมจากการค้นหาของ YouTube ไปยังวิดีโอหนึ่งๆ ในวันหนึ่งๆ

ข้อความค้นหา	การดู	จำนวนนาทีที่ดูโดยประมาณ
Gangnam Style	100	200
psy	15	25
psy gangnam	9	15
oppa gangnam	5	8
ท่าเต้นการขี่ม้า	2	5

ตัวอย่างรายงานแหล่งที่มาของการเข้าชม

ตารางต่อไปนี้แสดงข้อความที่ตัดตอนมาจากรายงานแหล่งที่มาของการเข้าชมที่ YouTube จะสร้างสําหรับข้อมูลดิบในส่วนก่อนหน้า (รายงานจริงจะมีมิติข้อมูลและเมตริกมากกว่านี้) ในตัวอย่างนี้ รายงานจะระบุข้อความค้นหาเฉพาะในกรณีที่ข้อความค้นหาดังกล่าวทําให้เกิดยอดดูอย่างน้อย 10 ครั้ง เกณฑ์จริงอาจมีการเปลี่ยนแปลง

ในแถวที่ 3 ของรายงาน ค่ามิติข้อมูล trafficSourceDetail คือ NULL เมตริก views และ estimatedMinutesWatched มียอดดูและนาทีที่ดูรวมกันสำหรับข้อความค้นหา 3 รายการที่สร้างยอดดูไม่ถึง 10 ครั้ง

trafficSourceDetail	การดู	estimatedMinutesWatched
Gangnam Style	100	200
psy	15	25
NULL	16	28

มิติข้อมูลที่ต้องมีการลบข้อมูลระบุตัวบุคคล

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

เมตริก	การรวมมิติข้อมูล	มิติข้อมูลที่ลบข้อมูลระบุตัวบุคคลออก	ค่าที่ลบข้อมูลระบุตัวบุคคลออกแล้ว
subscribersGained	channel	country	ZZ
subscribersGained	channel	province	US-ZZ
subscribersLost	channel	country	ZZ
subscribersLost	channel	province	US-ZZ
comments	video	country	ZZ
comments	video	province	US-ZZ
likes	video	country	ZZ
likes	video	province	US-ZZ
ไม่ชอบ	video	country	ZZ
ไม่ชอบ	video	province	US-ZZ
ยอดดู	video	ageGroup	NULL
ยอดดู	video	gender	NULL
ยอดดู	video และ trafficSourceDetail	trafficSourceDetail	NULL
จำนวนผู้ติดตามช่อง	channel	subscribedStatus	NULL

ตัวอย่างโค้ด

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ API เพื่อสร้างงานการรายงาน จากนั้นดึงรายงานสําหรับงานนั้น เรามีโค้ดตัวอย่าง 2 รายการสำหรับแต่ละภาษา ดังนี้

1. ตัวอย่างโค้ดแรกแสดงวิธีเรียกข้อมูลรายการประเภทรายงานที่ใช้ได้ แล้วสร้างงานการรายงานใหม่

2. ตัวอย่างโค้ดที่ 2 แสดงวิธีเรียกข้อมูลรายงานสำหรับงานหนึ่งๆ คุณจะเริ่มเรียกข้อมูลรายงานได้ภายใน 48 ชั่วโมงนับจากเวลาที่สร้างงาน

หมายเหตุ: ตัวอย่างโค้ดต่อไปนี้อาจไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด ดูรายการภาษาที่รองรับได้ที่ไลบรารีของไคลเอ็นต์

Java

ตัวอย่างต่อไปนี้ใช้ไลบรารีของไคลเอ็นต์ Java

• ตัวอย่างที่ 1: สร้างงานการรายงาน
• ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างที่ 1: สร้างงานการรายงาน

ตัวอย่างโค้ดต่อไปนี้เรียกใช้เมธอด reportTypes.list เพื่อดึงข้อมูลรายการประเภทรายงานที่ใช้ได้ จากนั้นจะเรียกใช้เมธอด jobs.create เพื่อสร้างงานการรายงานใหม่

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListReportTypesResponse;
import com.google.api.services.youtubereporting.model.ReportType;
import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */
public class CreateReportingJob {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Create a reporting job.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "createreportingjob");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-createreportingjob-sample").build();

            // Prompt the user to specify the name of the job to be created.
            String name = getNameFromUser();

            if (listReportTypes()) {
              createReportingJob(getReportTypeIdFromUser(), name);
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists report types. (reportTypes.listReportTypes)
     * @return true if at least one report type exists
     * @throws IOException
     */
    private static boolean listReportTypes() throws IOException {
        // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
        ListReportTypesResponse reportTypesListResponse = youtubeReporting.reportTypes().list()
            .execute();
        List<ReportType> reportTypeList = reportTypesListResponse.getReportTypes();

        if (reportTypeList == null || reportTypeList.isEmpty()) {
          System.out.println("No report types found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Report Types ==================\n");
            for (ReportType reportType : reportTypeList) {
                System.out.println("  - Id: " + reportType.getId());
                System.out.println("  - Name: " + reportType.getName());
                System.out.println("\n-------------------------------------------------------------\n");
           }
        }
        return true;
    }

    /**
     * Creates a reporting job. (jobs.create)
     *
     * @param reportTypeId Id of the job's report type.
     * @param name name of the job.
     * @throws IOException
     */
    private static void createReportingJob(String reportTypeId, String name)
        throws IOException {
        // Create a reporting job with a name and a report type id.
        Job job = new Job();
        job.setReportTypeId(reportTypeId);
        job.setName(name);

        // Call the YouTube Reporting API's jobs.create method to create a job.
        Job createdJob = youtubeReporting.jobs().create(job).execute();

        // Print information from the API response.
        System.out.println("\n================== Created reporting job ==================\n");
        System.out.println("  - ID: " + createdJob.getId());
        System.out.println("  - Name: " + createdJob.getName());
        System.out.println("  - Report Type Id: " + createdJob.getReportTypeId());
        System.out.println("  - Create Time: " + createdJob.getCreateTime());
        System.out.println("\n-------------------------------------------------------------\n");
    }

    /*
     * Prompt the user to enter a name for the job. Then return the name.
     */
    private static String getNameFromUser() throws IOException {

        String name = "";

        System.out.print("Please enter the name for the job [javaTestJob]: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        name = bReader.readLine();

        if (name.length() < 1) {
            // If nothing is entered, defaults to "javaTestJob".
          name = "javaTestJob";
        }

        System.out.println("You chose " + name + " as the name for the job.");
        return name;
    }

    /*
     * Prompt the user to enter a report type id for the job. Then return the id.
     */
    private static String getReportTypeIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the reportTypeId for the job: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the report type Id for the job.");
        return id;
    }
}
CreateReportingJob.java

ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างโค้ดเรียกใช้เมธอด jobs.list เพื่อดึงข้อมูลรายการงานการรายงาน จากนั้นจะเรียกใช้เมธอด reports.list โดยตั้งค่าพารามิเตอร์ jobId เป็นรหัสงานที่เจาะจงเพื่อดึงรายงานที่สร้างโดยงานนั้น สุดท้าย ตัวอย่างจะพิมพ์ URL การดาวน์โหลดของรายงานแต่ละฉบับ

/*
 * Copyright (c) 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.services.samples.youtube.cmdline.reporting;

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.GenericUrl;
import com.google.api.services.samples.youtube.cmdline.Auth;
import com.google.api.services.youtubereporting.YouTubeReporting;
import com.google.api.services.youtubereporting.YouTubeReporting.Media.Download;
import com.google.api.services.youtubereporting.model.Job;
import com.google.api.services.youtubereporting.model.ListJobsResponse;
import com.google.api.services.youtubereporting.model.ListReportsResponse;
import com.google.api.services.youtubereporting.model.Report;

import com.google.common.collect.Lists;

import java.io.BufferedReader;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

import javax.print.attribute.standard.Media;

/**
 * This sample retrieves reports created by a specific job by:
 *
 * 1. Listing the jobs using the "jobs.list" method.
 * 2. Retrieving reports using the "reports.list" method.
 *
 * @author Ibrahim Ulukaya
 */
public class RetrieveReports {

    /**
     * Define a global instance of a YouTube Reporting object, which will be used to make
     * YouTube Reporting API requests.
     */
    private static YouTubeReporting youtubeReporting;


    /**
     * Retrieve reports.
     *
     * @param args command line args (not used).
     */
    public static void main(String[] args) {

        /*
         * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
         * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
         * use this scope.
         */
        List<String> scopes = Lists.newArrayList("https://www.googleapis.com/auth/yt-analytics-monetary.readonly");

        try {
            // Authorize the request.
            Credential credential = Auth.authorize(scopes, "retrievereports");

            // This object is used to make YouTube Reporting API requests.
            youtubeReporting = new YouTubeReporting.Builder(Auth.HTTP_TRANSPORT, Auth.JSON_FACTORY, credential)
                    .setApplicationName("youtube-cmdline-retrievereports-sample").build();

            if (listReportingJobs()) {
              if(retrieveReports(getJobIdFromUser())) {
                downloadReport(getReportUrlFromUser());
              }
            }
        } catch (GoogleJsonResponseException e) {
            System.err.println("GoogleJsonResponseException code: " + e.getDetails().getCode()
                    + " : " + e.getDetails().getMessage());
            e.printStackTrace();

        } catch (IOException e) {
            System.err.println("IOException: " + e.getMessage());
            e.printStackTrace();
        } catch (Throwable t) {
            System.err.println("Throwable: " + t.getMessage());
            t.printStackTrace();
        }
    }

    /**
     * Lists reporting jobs. (jobs.listJobs)
     * @return true if at least one reporting job exists
     * @throws IOException
     */
    private static boolean listReportingJobs() throws IOException {
        // Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
        ListJobsResponse jobsListResponse = youtubeReporting.jobs().list().execute();
        List<Job> jobsList = jobsListResponse.getJobs();

        if (jobsList == null || jobsList.isEmpty()) {
          System.out.println("No jobs found.");
          return false;
        } else {
            // Print information from the API response.
            System.out.println("\n================== Reporting Jobs ==================\n");
            for (Job job : jobsList) {
                System.out.println("  - Id: " + job.getId());
                System.out.println("  - Name: " + job.getName());
                System.out.println("  - Report Type Id: " + job.getReportTypeId());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Lists reports created by a specific job. (reports.listJobsReports)
     *
     * @param jobId The ID of the job.
     * @throws IOException
     */
    private static boolean retrieveReports(String jobId)
        throws IOException {
        // Call the YouTube Reporting API's reports.list method
        // to retrieve reports created by a job.
        ListReportsResponse reportsListResponse = youtubeReporting.jobs().reports().list(jobId).execute();
        List<Report> reportslist = reportsListResponse.getReports();

        if (reportslist == null || reportslist.isEmpty()) {
            System.out.println("No reports found.");
            return false;
        } else {
            // Print information from the API response.
            System.out.println("\n============= Reports for the job " + jobId + " =============\n");
            for (Report report : reportslist) {
                System.out.println("  - Id: " + report.getId());
                System.out.println("  - From: " + report.getStartTime());
                System.out.println("  - To: " + report.getEndTime());
                System.out.println("  - Download Url: " + report.getDownloadUrl());
                System.out.println("\n-------------------------------------------------------------\n");
            }
        }
        return true;
    }

    /**
     * Download the report specified by the URL. (media.download)
     *
     * @param reportUrl The URL of the report to be downloaded.
     * @throws IOException
     */
    private static boolean downloadReport(String reportUrl)
        throws IOException {
        // Call the YouTube Reporting API's media.download method to download a report.
        Download request = youtubeReporting.media().download("");
        FileOutputStream fop = new FileOutputStream(new File("report"));
        request.getMediaHttpDownloader().download(new GenericUrl(reportUrl), fop);
        return true;
    }

    /*
     * Prompt the user to enter a job id for report retrieval. Then return the id.
     */
    private static String getJobIdFromUser() throws IOException {

        String id = "";

        System.out.print("Please enter the job id for the report retrieval: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        id = bReader.readLine();

        System.out.println("You chose " + id + " as the job Id for the report retrieval.");
        return id;
    }

    /*
     * Prompt the user to enter a URL for report download. Then return the URL.
     */
    private static String getReportUrlFromUser() throws IOException {

        String url = "";

        System.out.print("Please enter the report URL to download: ");
        BufferedReader bReader = new BufferedReader(new InputStreamReader(System.in));
        url = bReader.readLine();

        System.out.println("You chose " + url + " as the URL to download.");
        return url;
    }}

RetrieveReports.java

PHP

ตัวอย่างต่อไปนี้ใช้ไลบรารีของไคลเอ็นต์ PHP

• ตัวอย่างที่ 1: สร้างงานการรายงาน
• ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างที่ 1: สร้างงานการรายงาน

ตัวอย่างโค้ดต่อไปนี้เรียกใช้เมธอด reportTypes.list เพื่อดึงข้อมูลรายการประเภทรายงานที่ใช้ได้ จากนั้นจะเรียกใช้เมธอด jobs.create เพื่อสร้างงานการรายงานใหม่

<?php

/**
 * This sample creates a reporting job by:
 *
 * 1. Listing the available report types using the "reportTypes.list" method.
 * 2. Creating a reporting job using the "jobs.create" method.
 *
 * @author Ibrahim Ulukaya
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();

/*
 * You can acquire an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
$OAUTH2_CLIENT_ID = 'REPLACE_ME';
$OAUTH2_CLIENT_SECRET = 'REPLACE_ME';

$client = new Google_Client();
$client->setClientId($OAUTH2_CLIENT_ID);
$client->setClientSecret($OAUTH2_CLIENT_SECRET);

/*
 * This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
 * authenticated user's account. Any request that retrieves earnings or ad performance metrics must
 * use this scope.
 */
$client->setScopes('https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
$redirect = filter_var('http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'],
    FILTER_SANITIZE_URL);
$client->setRedirectUri($redirect);

// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

// Check if an auth token exists for the required scopes
$tokenSessionKey = 'token-' . $client->prepareScopes();
if (isset($_GET['code'])) {
  if (strval($_SESSION['state']) !== strval($_GET['state'])) {
    die('The session state did not match.');
  }

  $client->authenticate($_GET['code']);
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
  header('Location: ' . $redirect);
}

if (isset($_SESSION[$tokenSessionKey])) {
  $client->setAccessToken($_SESSION[$tokenSessionKey]);
}

// Check to ensure that the access token was successfully acquired.
if ($client->getAccessToken()) {
  // This code executes if the user enters a name in the form
  // and submits the form. Otherwise, the page displays the form above.
  try {
    if (empty(listReportTypes($youtubeReporting, $htmlBody))) {
      $htmlBody .= sprintf('<p>No report types found.</p>');
    } else if ($_GET['reportTypeId']){
      createReportingJob($youtubeReporting, $_GET['reportTypeId'], $_GET['jobName'], $htmlBody);
    }
  } catch (Google_Service_Exception $e) {
    $htmlBody = sprintf('<p>A service error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  } catch (Google_Exception $e) {
    $htmlBody = sprintf('<p>An client error occurred: <code>%s</code></p>',
        htmlspecialchars($e->getMessage()));
  }
  $_SESSION[$tokenSessionKey] = $client->getAccessToken();
} elseif ($OAUTH2_CLIENT_ID == 'REPLACE_ME') {
  $htmlBody = <<<END
  <h3>Client Credentials Required</h3>
  <p>
    You need to set <code>\$OAUTH2_CLIENT_ID</code> and
    <code>\$OAUTH2_CLIENT_ID</code> before proceeding.
  <p>
END;
} else {
  // If the user hasn't authorized the app, initiate the OAuth flow
  $state = mt_rand();
  $client->setState($state);
  $_SESSION['state'] = $state;

  $authUrl = $client->createAuthUrl();
  $htmlBody = <<<END
  <h3>Authorization Required</h3>
  <p>You need to <a href="$authUrl">authorize access</a> before proceeding.<p>
END;
}


/**
 * Creates a reporting job. (jobs.create)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportTypeId Id of the job's report type.
 * @param string $name name of the job.
 * @param $htmlBody - html body.
 */
function createReportingJob(Google_Service_YouTubeReporting $youtubeReporting, $reportTypeId,
    $name, &$htmlBody) {
  # Create a reporting job with a name and a report type id.
  $reportingJob = new Google_Service_YouTubeReporting_Job();
  $reportingJob->setReportTypeId($reportTypeId);
  $reportingJob->setName($name);

  // Call the YouTube Reporting API's jobs.create method to create a job.
  $jobCreateResponse = $youtubeReporting->jobs->create($reportingJob);

  $htmlBody .= "<h2>Created reporting job</h2><ul>";
  $htmlBody .= sprintf('<li>"%s" for reporting type "%s" at "%s"</li>',
      $jobCreateResponse['name'], $jobCreateResponse['reportTypeId'], $jobCreateResponse['createTime']);
  $htmlBody .= '</ul>';
}


/**
 * Returns a list of report types. (reportTypes.listReportTypes)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param $htmlBody - html body.
 */
function listReportTypes(Google_Service_YouTubeReporting $youtubeReporting, &$htmlBody) {
  // Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
  $reportTypes = $youtubeReporting->reportTypes->listReportTypes();

  $htmlBody .= "<h3>Report Types</h3><ul>";
  foreach ($reportTypes as $reportType) {
    $htmlBody .= sprintf('<li>id: "%s", name: "%s"</li>', $reportType['id'], $reportType['name']);
  }
  $htmlBody .= '</ul>';

  return $reportTypes;
}
?>

<!doctype html>
<html>
<head>
<title>Create a reporting job</title>
</head>
<body>
  <form method="GET">
    <div>
      Job Name: <input type="text" id="jobName" name="jobName" placeholder="Enter Job Name">
    </div>
    <br>
    <div>
      Report Type Id: <input type="text" id="reportTypeId" name="reportTypeId" placeholder="Enter Report Type Id">
    </div>
    <br>
    <input type="submit" value="Create!">
  </form>
  <?=$htmlBody?>
</body>
</html>
create_reporting_job.php

ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างโค้ดเรียกใช้เมธอด jobs.list เพื่อดึงข้อมูลรายการงานการรายงาน จากนั้นจะเรียกใช้เมธอด reports.list โดยตั้งค่าพารามิเตอร์ jobId เป็นรหัสงานที่เจาะจงเพื่อดึงรายงานที่สร้างโดยงานนั้น สุดท้าย ตัวอย่างจะพิมพ์ URL การดาวน์โหลดของรายงานแต่ละฉบับ

<?php

/**
 * This sample supports the following use cases:
 *
 * 1. Retrieve reporting jobs by content owner:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID"
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --includeSystemManaged==True
 * 2. Retrieving list of downloadable reports for a particular job:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --jobId="JOB_ID"
 * 3. Download a report:
 *    Ex: php retrieve_reports.php  --contentOwner=="CONTENT_OWNER_ID" --downloadUrl="DOWNLOAD_URL" --outputFile="report.txt"
 */

/**
 * Library Requirements
 *
 * 1. Install composer (https://getcomposer.org)
 * 2. On the command line, change to this directory (api-samples/php)
 * 3. Require the google/apiclient library
 *    $ composer require google/apiclient:~2.0
 */
if (!file_exists(__DIR__ . '/vendor/autoload.php')) {
  throw new \Exception('please run "composer require google/apiclient:~2.2.0" in "' . __DIR__ .'"');
}

require_once __DIR__ . '/vendor/autoload.php';
session_start();


define('CREDENTIALS_PATH', '~/.credentials/youtube-php.json');

$longOptions = array(
  'contentOwner::',
  'downloadUrl::',
  'includeSystemManaged::',
  'jobId::',
  'outputFile::',
);

$options = getopt('', $longOptions);

$CONTENT_OWNER_ID = ($options['contentOwner'] ? $options['contentOwner'] : '');
$DOWNLOAD_URL = (array_key_exists('downloadUrl', $options) ?
                 $options['downloadUrl'] : '');
$INCLUDE_SYSTEM_MANAGED = (array_key_exists('includeSystemManaged', $options) ?
                           $options['includeSystemManaged'] : '');
$JOB_ID = (array_key_exists('jobId', $options) ? $options['jobId'] : '');
$OUTPUT_FILE = (array_key_exists('outputFile', $options) ?
                $options['outputFile'] : '');

/*
 * You can obtain an OAuth 2.0 client ID and client secret from the
 * {{ Google Cloud Console }} <{{ https://cloud.google.com/console }}>
 * For more information about using OAuth 2.0 to access Google APIs, please see:
 * <https://developers.google.com/youtube/v3/guides/authentication>
 * Please ensure that you have enabled the YouTube Data API for your project.
 */
function getClient() {
  $client = new Google_Client();
  $client->setAuthConfigFile('client_secrets_php.json');
  $client->addScope(
      'https://www.googleapis.com/auth/yt-analytics-monetary.readonly');
  $client->setRedirectUri('urn:ietf:wg:oauth:2.0:oob');
  $client->setAccessType('offline');

  // Load previously authorized credentials from a file.
  $credentialsPath = expandHomeDirectory(CREDENTIALS_PATH);
  if (file_exists($credentialsPath)) {
    $accessToken = json_decode(file_get_contents($credentialsPath), true);
  } else {
    // Request authorization from the user.
    $authUrl = $client->createAuthUrl();
    printf('Open the following link in your browser:\n%s\n', $authUrl);
    print 'Enter verification code: ';
    $authCode = trim(fgets(STDIN));

    // Exchange authorization code for an access token.
    $accessToken = $client->authenticate($authCode);
    $refreshToken = $client->getRefreshToken();

    // Store the credentials to disk.
    if(!file_exists(dirname($credentialsPath))) {
      mkdir(dirname($credentialsPath), 0700, true);
    }
    file_put_contents($credentialsPath, json_encode($accessToken));
    printf('Credentials saved to %s\n', $credentialsPath);

    //fclose($fp);
  }
  $client->setAccessToken($accessToken);

  // Refresh the token if it's expired.
  if ($client->isAccessTokenExpired()) {
    $client->fetchAccessTokenWithRefreshToken($client->getRefreshToken());
    file_put_contents($credentialsPath, json_encode($client->getAccessToken()));
  }

  return $client;
}

/**
 * Expands the home directory alias '~' to the full path.
 * @param string $path the path to expand.
 * @return string the expanded path.
 */
function expandHomeDirectory($path) {
  $homeDirectory = getenv('HOME');
  if (empty($homeDirectory)) {
    $homeDirectory = getenv('HOMEDRIVE') . getenv('HOMEPATH');
  }
  return str_replace('~', realpath($homeDirectory), $path);
}

/**
 * Returns a list of reporting jobs. (jobs.listJobs)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportingJobs(Google_Service_YouTubeReporting $youtubeReporting,
    $onBehalfOfContentOwner = '', $includeSystemManaged = False) {
  $reportingJobs = $youtubeReporting->jobs->listJobs(
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner,
            'includeSystemManaged' => $includeSystemManaged));
  print ('REPORTING JOBS' . PHP_EOL . '**************' . PHP_EOL);
  foreach ($reportingJobs as $job) {
    print($job['reportTypeId'] . ':' . $job['id'] . PHP_EOL);
  }
  print(PHP_EOL);
}

/**
 * Lists reports created by a specific job. (reports.listJobsReports)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $jobId The ID of the job.
 * @param string $onBehalfOfContentOwner A content owner ID.
 */
function listReportsForJob(Google_Service_YouTubeReporting $youtubeReporting,
    $jobId, $onBehalfOfContentOwner = '') {
  $reports = $youtubeReporting->jobs_reports->listJobsReports($jobId,
      array('onBehalfOfContentOwner' => $onBehalfOfContentOwner));
  print ('DOWNLOADABLE REPORTS' . PHP_EOL . '********************' . PHP_EOL);
  foreach ($reports['reports'] as $report) {
    print('Created: ' . date('d M Y', strtotime($report['createTime'])) .
          ' (' . date('d M Y', strtotime($report['startTime'])) .
          ' to ' . date('d M Y', strtotime($report['endTime'])) . ')' .
          PHP_EOL .  '    ' . $report['downloadUrl'] . PHP_EOL . PHP_EOL);
  }
}

/**
 * Download the report specified by the URL. (media.download)
 *
 * @param Google_Service_YouTubereporting $youtubeReporting YouTube Reporting service object.
 * @param string $reportUrl The URL of the report to be downloaded.
 * @param string $outputFile The file to write the report to locally.
 * @param $htmlBody - html body.
 */
function downloadReport(Google_Service_YouTubeReporting $youtubeReporting,
    $reportUrl, $outputFile) {
  $client = $youtubeReporting->getClient();
  // Setting the defer flag to true tells the client to return a request that
  // can be called with ->execute(); instead of making the API call immediately.
  $client->setDefer(true);

  // Call YouTube Reporting API's media.download method to download a report.
  $request = $youtubeReporting->media->download('', array('alt' => 'media'));
  $request = $request->withUri(new \GuzzleHttp\Psr7\Uri($reportUrl));
  $responseBody = '';
  try {
    $response = $client->execute($request);
    $responseBody = $response->getBody();
  } catch (Google_Service_Exception $e) {
    $responseBody = $e->getTrace()[0]['args'][0]->getResponseBody();
  }
  file_put_contents($outputFile, $responseBody);
  $client->setDefer(false);
}

// Define an object that will be used to make all API requests.
$client = getClient();
// YouTube Reporting object used to make YouTube Reporting API requests.
$youtubeReporting = new Google_Service_YouTubeReporting($client);

if ($CONTENT_OWNER_ID) {
  if (!$DOWNLOAD_URL && !$JOB_ID) {
    listReportingJobs($youtubeReporting, $CONTENT_OWNER_ID,
                      $INCLUDE_SYSTEM_MANAGED);
  } else if ($JOB_ID) {
    listReportsForJob($youtubeReporting, $JOB_ID, $CONTENT_OWNER_ID);
  } else if ($DOWNLOAD_URL && $OUTPUT_FILE) {
    downloadReport($youtubeReporting, $DOWNLOAD_URL, $OUTPUT_FILE);
  }
}

?>
retrieve_reports.php

Python

ตัวอย่างต่อไปนี้ใช้ไลบรารีของไคลเอ็นต์ Python

• ตัวอย่างที่ 1: สร้างงานการรายงาน
• ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างที่ 1: สร้างงานการรายงาน

ตัวอย่างโค้ดต่อไปนี้เรียกใช้เมธอด reportTypes.list เพื่อดึงข้อมูลรายการประเภทรายงานที่ใช้ได้ จากนั้นจะเรียกใช้เมธอด jobs.create เพื่อสร้างงานการรายงานใหม่

#!/usr/bin/python

# Create a reporting job for the authenticated user's channel or
# for a content owner that the user's account is linked to.
# Usage example:
# python create_reporting_job.py --name='<name>'
# python create_reporting_job.py --content-owner='<CONTENT OWNER ID>'
# python create_reporting_job.py --content-owner='<CONTENT_OWNER_ID>' --report-type='<REPORT_TYPE_ID>' --name='<REPORT_NAME>'

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from google_auth_oauthlib.flow import InstalledAppFlow


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains

# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to the YouTube Analytics monetary reports for
# authenticated user's account. Any request that retrieves earnings or ad performance metrics must
# use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's reportTypes.list method to retrieve report types.
def list_report_types(youtube_reporting, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)
  results = youtube_reporting.reportTypes().list(**kwargs).execute()
  reportTypes = results['reportTypes']

  if 'reportTypes' in results and results['reportTypes']:
    reportTypes = results['reportTypes']
    for reportType in reportTypes:
      print 'Report type id: %s\n name: %s\n' % (reportType['id'], reportType['name'])
  else:
    print 'No report types found'
    return False

  return True


# Call the YouTube Reporting API's jobs.create method to create a job.
def create_reporting_job(youtube_reporting, report_type_id, **kwargs):
  # Provide keyword arguments that have values as request parameters.
  kwargs = remove_empty_kwargs(**kwargs)

  reporting_job = youtube_reporting.jobs().create(
    body=dict(
      reportTypeId=args.report_type,
      name=args.name
    ),
    **kwargs
  ).execute()

  print ('Reporting job "%s" created for reporting type "%s" at "%s"'
         % (reporting_job['name'], reporting_job['reportTypeId'],
             reporting_job['createTime']))


# Prompt the user to enter a report type id for the job. Then return the id.
def get_report_type_id_from_user():
  report_type_id = raw_input('Please enter the reportTypeId for the job: ')
  print ('You chose "%s" as the report type Id for the job.' % report_type_id)
  return report_type_id

# Prompt the user to set a job name
def prompt_user_to_set_job_name():
  job_name = raw_input('Please set a name for the job: ')
  print ('Great! "%s" is a memorable name for this job.' % job_name)
  return job_name


if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  # The 'name' option specifies the name that will be used for the reporting job.
  parser.add_argument('--content-owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports.')
  parser.add_argument('--include-system-managed', default=False,
      help='Whether the API response should include system-managed reports')
  parser.add_argument('--name', default='',
    help='Name for the reporting job. The script prompts you to set a name ' +
         'for the job if you do not provide one using this argument.')
  parser.add_argument('--report-type', default=None,
    help='The type of report for which you are creating a job.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()

  try:
    # Prompt user to select report type if they didn't set one on command line.
    if not args.report_type:
      if list_report_types(youtube_reporting,
                           onBehalfOfContentOwner=args.content_owner,
                           includeSystemManaged=args.include_system_managed):
        args.report_type = get_report_type_id_from_user()
    # Prompt user to set job name if not set on command line.
    if not args.name:
      args.name = prompt_user_to_set_job_name()
    # Create the job.
    if args.report_type:
      create_reporting_job(youtube_reporting,
                           args,
                           onBehalfOfContentOwner=args.content_owner)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
create_reporting_job.py

ตัวอย่างที่ 2: เรียกข้อมูลรายงาน

ตัวอย่างโค้ดเรียกใช้เมธอด jobs.list เพื่อดึงข้อมูลรายการงานการรายงาน จากนั้นจะเรียกใช้เมธอด reports.list โดยตั้งค่าพารามิเตอร์ jobId เป็นรหัสงานที่เจาะจงเพื่อดึงรายงานที่สร้างโดยงานนั้น สุดท้าย ตัวอย่างจะพิมพ์ URL การดาวน์โหลดของรายงานแต่ละฉบับ

#!/usr/bin/python

###
#
# This script retrieves YouTube Reporting API reports. Use cases:
# 1. If you specify a report URL, the script downloads that report.
# 2. Otherwise, if you specify a job ID, the script retrieves a list of
#    available reports for that job and prompts you to select a report.
#    Then it retrieves that report as in case 1.
# 3. Otherwise, the list retrieves a list of jobs for the user or,
#    if specified, the content owner that the user is acting on behalf of.
#    Then it prompts the user to select a job, and then executes case 2 and
#    then case 1.
# Usage examples:
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --job_id=<JOB_ID> --local_file=<LOCAL_FILE>
# python retrieve_reports.py --content_owner_id=<CONTENT_OWNER_ID> --report_url=<REPORT_URL> --local_file=<LOCAL_FILE>
#
###

import argparse
import os

import google.oauth2.credentials
import google_auth_oauthlib.flow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload
from google_auth_oauthlib.flow import InstalledAppFlow
from io import FileIO


# The CLIENT_SECRETS_FILE variable specifies the name of a file that contains
# the OAuth 2.0 information for this application, including its client_id and
# client_secret. You can acquire an OAuth 2.0 client ID and client secret from
# the {{ Google Cloud Console }} at
# {{ https://cloud.google.com/console }}.
# Please ensure that you have enabled the YouTube Data API for your project.
# For more information about using OAuth2 to access the YouTube Data API, see:
#   https://developers.google.com/youtube/v3/guides/authentication
# For more information about the client_secrets.json file format, see:
#   https://developers.google.com/api-client-library/python/guide/aaa_client_secrets
CLIENT_SECRETS_FILE = 'client_secret.json'

# This OAuth 2.0 access scope allows for read access to YouTube Analytics
# monetary reports for the authenticated user's account. Any request that
# retrieves earnings or ad performance metrics must use this scope.
SCOPES = ['https://www.googleapis.com/auth/yt-analytics-monetary.readonly']
API_SERVICE_NAME = 'youtubereporting'
API_VERSION = 'v1'

# Authorize the request and store authorization credentials.
def get_authenticated_service():
  flow = InstalledAppFlow.from_client_secrets_file(CLIENT_SECRETS_FILE, SCOPES)
  credentials = flow.run_console()
  return build(API_SERVICE_NAME, API_VERSION, credentials = credentials)

# Remove keyword arguments that are not set.
def remove_empty_kwargs(**kwargs):
  good_kwargs = {}
  if kwargs is not None:
    for key, value in kwargs.iteritems():
      if value:
        good_kwargs[key] = value
  return good_kwargs

# Call the YouTube Reporting API's jobs.list method to retrieve reporting jobs.
def list_reporting_jobs(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve the reporting jobs for the user (or content owner).
  results = youtube_reporting.jobs().list(**kwargs).execute()

  if 'jobs' in results and results['jobs']:
    jobs = results['jobs']
    for job in jobs:
      print ('Reporting job id: %s\n name: %s\n for reporting type: %s\n'
        % (job['id'], job['name'], job['reportTypeId']))
  else:
    print 'No jobs found'
    return False

  return True

# Call the YouTube Reporting API's reports.list method to retrieve reports created by a job.
def retrieve_reports(youtube_reporting, **kwargs):
  # Only include the onBehalfOfContentOwner keyword argument if the user
  # set a value for the --content_owner argument.
  kwargs = remove_empty_kwargs(**kwargs)

  # Retrieve available reports for the selected job.
  results = youtube_reporting.jobs().reports().list(
    **kwargs
  ).execute()

  if 'reports' in results and results['reports']:
    reports = results['reports']
    for report in reports:
      print ('Report dates: %s to %s\n       download URL: %s\n'
        % (report['startTime'], report['endTime'], report['downloadUrl']))


# Call the YouTube Reporting API's media.download method to download the report.
def download_report(youtube_reporting, report_url, local_file):
  request = youtube_reporting.media().download(
    resourceName=' '
  )
  request.uri = report_url
  fh = FileIO(local_file, mode='wb')
  # Stream/download the report in a single request.
  downloader = MediaIoBaseDownload(fh, request, chunksize=-1)

  done = False
  while done is False:
    status, done = downloader.next_chunk()
    if status:
      print 'Download %d%%.' % int(status.progress() * 100)
  print 'Download Complete!'


# Prompt the user to select a job and return the specified ID.
def get_job_id_from_user():
  job_id = raw_input('Please enter the job id for the report retrieval: ')
  print ('You chose "%s" as the job Id for the report retrieval.' % job_id)
  return job_id

# Prompt the user to select a report URL and return the specified URL.
def get_report_url_from_user():
  report_url = raw_input('Please enter the report URL to download: ')
  print ('You chose "%s" to download.' % report_url)
  return report_url

if __name__ == '__main__':
  parser = argparse.ArgumentParser()
  parser.add_argument('--content_owner', default='',
      help='ID of content owner for which you are retrieving jobs and reports')
  parser.add_argument('--job_id', default=None,
      help='ID of the job for which you are retrieving reports. If not ' +
           'provided AND report_url is also not provided, then the script ' +
           'calls jobs.list() to retrieve a list of jobs.')
  parser.add_argument('--report_url', default=None,
      help='URL of the report to retrieve. If not specified, the script ' +
           'calls reports.list() to retrieve a list of reports for the ' +
           'selected job.')
  parser.add_argument('--local_file', default='yt_report.txt',
      help='The name of the local file where the downloaded report will be written.')
  args = parser.parse_args()

  youtube_reporting = get_authenticated_service()
  try:
    # If the user has not specified a job ID or report URL, retrieve a list
    # of available jobs and prompt the user to select one.
    if not args.job_id and not args.report_url:
      if list_reporting_jobs(youtube_reporting,
                             onBehalfOfContentOwner=args.content_owner):
        args.job_id = get_job_id_from_user()

    # If the user has not specified a report URL, retrieve a list of reports
    # available for the specified job and prompt the user to select one.
    if args.job_id and not args.report_url:
      retrieve_reports(youtube_reporting,
                       jobId=args.job_id,
                       onBehalfOfContentOwner=args.content_owner)
      args.report_url = get_report_url_from_user()

    # Download the selected report.
    if args.report_url:
      download_report(youtube_reporting, args.report_url, args.local_file)
  except HttpError, e:
    print 'An HTTP error %d occurred:\n%s' % (e.resp.status, e.content)
retrieve_reports.py