API Reference

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

คู่มืออ้างอิงนี้อธิบายวิธีใช้ API เพื่อดำเนินการทั้งหมดเหล่านี้ คู่มือนี้จัดเรียงตามประเภททรัพยากร ทรัพยากรแสดงถึงประเภทของรายการที่เป็นส่วนหนึ่งของประสบการณ์การใช้งาน YouTube เช่น วิดีโอ เพลย์ลิสต์ หรือการติดตาม สำหรับทรัพยากรแต่ละประเภท คู่มือจะแสดงการแสดงข้อมูลอย่างน้อย 1 รายการ และทรัพยากรจะแสดงเป็นออบเจ็กต์ JSON คู่มือนี้ยังแสดงรายการวิธีการที่รองรับอย่างน้อย 1 วิธี (LIST, POST, DELETE ฯลฯ) สำหรับทรัพยากรแต่ละประเภท และอธิบายวิธีใช้วิธีการเหล่านั้นในแอปพลิเคชัน

เรียก API

คำขอ API ข้อมูลของ YouTube ต้องเป็นไปตามข้อกำหนดต่อไปนี้

  1. คำขอทุกรายการต้องระบุคีย์ API (ด้วยพารามิเตอร์ key) หรือระบุโทเค็น OAuth 2.0 คีย์ API จะอยู่ในแผงการเข้าถึง API ของDeveloper Console สำหรับโปรเจ็กต์ของคุณ

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

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

  3. API รองรับโปรโตคอลการตรวจสอบสิทธิ์ OAuth 2.0 คุณระบุโทเค็น OAuth 2.0 ได้ด้วยวิธีใดวิธีหนึ่งต่อไปนี้

    • ใช้พารามิเตอร์การค้นหา access_token ดังนี้ ?access_token=oauth2-token
    • ใช้ส่วนหัว HTTP ของ Authorization ดังนี้ Authorization: Bearer oauth2-token

    ดูวิธีการที่สมบูรณ์สำหรับการติดตั้งใช้งานการตรวจสอบสิทธิ์ OAuth 2.0 ในแอปพลิเคชันได้ในคู่มือการตรวจสอบสิทธิ์

ประเภททรัพยากร

กิจกรรม

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /activities แสดงผลรายการกิจกรรมในช่องที่ตรงกับเกณฑ์คำขอ เช่น คุณสามารถดึงข้อมูลเหตุการณ์ที่เชื่อมโยงกับช่องใดช่องหนึ่งหรือช่องของผู้ใช้เองได้

คำอธิบาย

caption ทรัพยากรแสดงถึงแทร็กคำบรรยายแทนเสียงของ YouTube แทร็กคำบรรยายแทนเสียงจะเชื่อมโยงกับวิดีโอ YouTube เพียง 1 รายการเท่านั้น

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
delete DELETE /captions ลบแทร็กคำบรรยายแทนเสียงที่ระบุ
download GET /captions/id ดาวน์โหลดแทร็กคำบรรยายแทนเสียง ระบบจะแสดงผลแทร็กคำบรรยายแทนเสียงในรูปแบบเดิม เว้นแต่คำขอจะระบุค่าสำหรับพารามิเตอร์ tfmt และในภาษาเดิม เว้นแต่คำขอจะระบุค่าสำหรับพารามิเตอร์ tlang
insert POST /captions อัปโหลดแทร็กคำบรรยายแทนเสียง
list GET /captions แสดงรายการแทร็กคำบรรยายแทนเสียงที่เชื่อมโยงกับวิดีโอที่ระบุ การตอบกลับจาก API ไม่มีคำบรรยายแทนเสียงจริง และเมธอด captions.download ช่วยให้ดึงข้อมูลแทร็กคำบรรยายแทนเสียงได้
update PUT /captions อัปเดตแทร็กคำบรรยายแทนเสียง เมื่ออัปเดตแทร็กคำบรรยายแทนเสียง คุณจะเปลี่ยนสถานะฉบับร่างของแทร็ก อัปโหลดไฟล์คำบรรยายแทนเสียงใหม่สำหรับแทร็ก หรือทั้ง 2 อย่างก็ได้

ChannelBanners

channelBanner ทรัพยากรมี URL ที่คุณจะใช้เพื่อตั้งค่ารูปภาพที่อัปโหลดใหม่เป็นรูปภาพแบนเนอร์ของช่อง

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
insert POST /channelBanners/insert อัปโหลดรูปภาพแบนเนอร์ของช่องไปยัง YouTube วิธีนี้แสดงถึง 2 ขั้นตอนแรกในกระบวนการ 3 ขั้นตอนในการอัปเดตรูปภาพแบนเนอร์ของช่อง
  1. เรียกใช้เมธอด channelBanners.insert เพื่ออัปโหลดข้อมูลรูปภาพไบนารีไปยัง YouTube รูปภาพต้องมีสัดส่วนภาพเป็น 16:9 และมีขนาดอย่างน้อย 2048x1152 พิกเซล เราขอแนะนำให้อัปโหลดรูปภาพขนาด 2560 x 1440 พิกเซล
  2. ดึงค่าของพร็อพเพอร์ตี้ url จากการตอบกลับที่ API แสดงผลสำหรับขั้นตอนที่ 1
  3. เรียกใช้เมธอด channels.update เพื่ออัปเดตการตั้งค่าการสร้างแบรนด์ของช่อง ตั้งค่าพร็อพเพอร์ตี้ brandingSettings.image.bannerExternalUrl เป็น URL ที่ได้รับในขั้นตอนที่ 2

ChannelSections

channelSection ทรัพยากรมีข้อมูลเกี่ยวกับชุดวิดีโอที่ช่องเลือกแสดง เช่น ส่วนอาจแสดงการอัปโหลดล่าสุด การอัปโหลดที่ได้รับความนิยมมากที่สุด หรือวิดีโอจากเพลย์ลิสต์อย่างน้อย 1 รายการของช่อง

ส่วนของช่องจะปรากฏก็ต่อเมื่อช่องแสดงเนื้อหาในมุมมองการเรียกดู (แทนที่จะเป็นมุมมองฟีด) หากต้องการให้ช่องแสดงเนื้อหาในมุมมองแบบเรียกดู ให้ตั้งค่าพร็อพเพอร์ตี้ brandingSettings.channel.showBrowseView เป็น true สำหรับช่องที่ระบุ

ช่องจะสร้างชั้นวางได้สูงสุด 10 ชั้น

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
delete DELETE /channelSections ลบส่วนช่อง
insert POST /channelSections เพิ่มส่วนช่องไปยังช่องของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ ช่องสร้างชั้นวางได้สูงสุด 10 ชั้น
list GET /channelSections แสดงรายการchannelSectionที่ตรงกับเกณฑ์คำขอ API
update PUT /channelSections อัปเดตส่วนของช่อง

ช่อง

channel ทรัพยากรมีข้อมูลเกี่ยวกับช่อง YouTube

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /channels แสดงผลคอลเล็กชันของทรัพยากร channel ตั้งแต่ 0 รายการขึ้นไปที่ตรงกับเกณฑ์คำขอ
update PUT /channels อัปเดตข้อมูลเมตาของช่อง วิธีนี้รองรับเฉพาะการอัปเดตออบเจ็กต์ brandingSettings และ invideoPromotion ของchannelทรัพยากร รวมถึงพร็อพเพอร์ตี้ย่อยของออบเจ็กต์เหล่านั้น

CommentThreads

commentThreadทรัพยากรประกอบด้วยข้อมูลเกี่ยวกับชุดข้อความความคิดเห็นบน YouTube ซึ่งประกอบด้วยความคิดเห็นระดับบนสุดและการตอบกลับความคิดเห็นนั้น (หากมี) commentThread ทรัพยากรอาจแสดงความคิดเห็นเกี่ยวกับวิดีโอหรือช่อง

ทั้งความคิดเห็นระดับบนสุดและการตอบกลับเป็นcomment ทรัพยากรที่ซ้อนอยู่ภายในทรัพยากร commentThread commentThread ไม่จำเป็นต้องมีคำตอบทั้งหมดของความคิดเห็นในแหล่งข้อมูล และคุณต้องใช้วิธี comments.list หากต้องการดึงคำตอบทั้งหมดของความคิดเห็นหนึ่งๆ นอกจากนี้ ความคิดเห็นบางรายการอาจไม่มีการตอบกลับ

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /commentThreads แสดงรายการเธรดความคิดเห็นที่ตรงกับพารามิเตอร์คำขอ API
insert POST /commentThreads สร้างความคิดเห็นระดับบนสุดใหม่ หากต้องการเพิ่มคำตอบให้กับความคิดเห็นที่มีอยู่ ให้ใช้เมธอด comments.insert แทน

ความคิดเห็น

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /comments แสดงรายการความคิดเห็นที่ตรงกับพารามิเตอร์คำขอ API
setModerationStatus POST /comments/setModerationStatus ตั้งค่าสถานะการดูแลของความคิดเห็นอย่างน้อย 1 รายการ เจ้าของช่องหรือวิดีโอที่เชื่อมโยงกับความคิดเห็นต้องให้สิทธิ์คำขอ API
insert POST /comments สร้างการตอบกลับความคิดเห็นที่มีอยู่ หมายเหตุ: หากต้องการสร้างความคิดเห็นระดับบนสุด ให้ใช้วิธี commentThreads.insert
delete DELETE /comments ลบความคิดเห็น
update PUT /comments แก้ไขความคิดเห็น

I18nLanguages

i18nLanguageทรัพยากรจะระบุภาษาของแอปพลิเคชันที่เว็บไซต์ YouTube รองรับ ภาษาของแอปพลิเคชันยังเรียกว่าภาษา UI ได้ด้วย สำหรับเว็บไซต์ YouTube ระบบอาจเลือกภาษาของแอปพลิเคชันโดยอัตโนมัติตามการตั้งค่าบัญชี Google, ภาษาของเบราว์เซอร์ หรือตำแหน่ง IP นอกจากนี้ ผู้ใช้ยังเลือกภาษา UI จากส่วนท้ายของเว็บไซต์ YouTube ด้วยตนเองได้ด้วย

ทรัพยากร i18nLanguage แต่ละรายการจะระบุรหัสภาษาและชื่อ คุณใช้รหัสภาษาเป็นค่าของพารามิเตอร์ hl ได้เมื่อเรียกใช้เมธอด API เช่น videoCategories.list

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /i18nLanguages แสดงรายการภาษาของแอปพลิเคชันที่เว็บไซต์ YouTube รองรับ

I18nRegions

i18nRegion ทรัพยากรระบุพื้นที่ทางภูมิศาสตร์ที่ผู้ใช้ YouTube เลือกเป็นภูมิภาคเนื้อหาที่ต้องการได้ ภูมิภาคของเนื้อหาอาจเรียกว่าภาษาของเนื้อหาด้วย สำหรับเว็บไซต์ YouTube ระบบอาจเลือกภูมิภาคเนื้อหาโดยอัตโนมัติตามฮิวริสติก เช่น โดเมน YouTube หรือตำแหน่ง IP ของผู้ใช้ นอกจากนี้ ผู้ใช้ยังเลือกภูมิภาคของเนื้อหาจากส่วนท้ายของเว็บไซต์ YouTube ด้วยตนเองได้ด้วย

i18nRegionแต่ละแหล่งข้อมูลจะระบุรหัสและชื่อภูมิภาค คุณใช้รหัสภูมิภาคเป็นค่าของพารามิเตอร์ regionCode ได้เมื่อเรียกใช้เมธอด API เช่น search.list, videos.list, activities.list และ videoCategories.list

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /i18nRegions แสดงรายการภูมิภาคเนื้อหาที่เว็บไซต์ YouTube รองรับ

สมาชิก

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับแหล่งข้อมูลนี้ได้ที่ การแสดงทรัพยากรและรายการ พร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /members แสดงรายชื่อสมาชิก (เดิมเรียกว่า "ผู้สนับสนุน") ของช่อง คำขอ API ต้องได้รับอนุญาตจากเจ้าของช่อง

MembershipsLevels

membershipsLevel ทรัพยากรระบุระดับราคาสำหรับ ครีเอเตอร์ที่ให้สิทธิ์คำขอ API

ดูข้อมูลเพิ่มเติมเกี่ยวกับแหล่งข้อมูลนี้ได้ที่ การแสดงทรัพยากรและรายการ พร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /membershipsLevels แสดงผลคอลเล็กชันของทรัพยากร membershipsLevel ตั้งแต่ 0 รายการขึ้นไปซึ่งเป็นของช่องที่ให้สิทธิ์คำขอ API ระบบจะแสดงระดับตาม ลำดับการแสดงผลโดยนัย

PlaylistItems

playlistItem ทรัพยากรจะระบุทรัพยากรอื่น เช่น วิดีโอ ที่รวมอยู่ในเพลย์ลิสต์ นอกจากนี้ playlistItem resource ยังมีรายละเอียดเกี่ยวกับทรัพยากรที่รวมไว้ซึ่งเกี่ยวข้องโดยเฉพาะกับวิธีใช้ทรัพยากรนั้น ในเพลย์ลิสต์นั้น

นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุรายการวิดีโอที่อัปโหลดของช่อง โดยแต่ละ playlistItemในรายการนั้นแสดงถึงวิดีโอที่อัปโหลด 1 รายการ คุณสามารถดึงข้อมูล รหัสเพลย์ลิสต์สำหรับเพลย์ลิสต์นั้นจาก channel resource ของช่องที่ต้องการ จากนั้นคุณจะใช้ playlistItems.list เพื่อ รายการได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
delete DELETE /playlistItems ลบรายการในเพลย์ลิสต์
insert POST /playlistItems เพิ่มแหล่งข้อมูลลงในเพลย์ลิสต์
list GET /playlistItems แสดงผลคอลเล็กชันของรายการในเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API คุณสามารถดึงข้อมูลรายการเพลย์ลิสต์ทั้งหมดในเพลย์ลิสต์ที่ระบุ หรือดึงข้อมูลรายการเพลย์ลิสต์อย่างน้อย 1 รายการตามรหัสที่ไม่ซ้ำกันของรายการนั้นๆ
update PUT /playlistItems แก้ไขรายการในเพลย์ลิสต์ เช่น คุณสามารถอัปเดตตำแหน่งของรายการในเพลย์ลิสต์ได้

เพลย์ลิสต์

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

นอกจากนี้ YouTube ยังใช้เพลย์ลิสต์เพื่อระบุคอลเล็กชันวิดีโอพิเศษสำหรับช่องด้วย เช่น

  • วิดีโอที่อัปโหลด
  • วิดีโอที่ได้รับการจัดประเภทในเชิงบวก (ชอบ)
  • ประวัติการดู
  • ดูภายหลัง

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

จากนั้นคุณจะใช้วิธี playlistItems.list เพื่อดึงข้อมูลรายการใดก็ได้ นอกจากนี้ คุณยังเพิ่มหรือนำรายการออกจากลิสต์เหล่านั้นได้โดยเรียกใช้เมธอด playlistItems.insert และ playlistItems.delete

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
delete DELETE /playlists ลบเพลย์ลิสต์
list GET /playlists แสดงคอลเล็กชันเพลย์ลิสต์ที่ตรงกับพารามิเตอร์คำขอ API เช่น คุณสามารถดึงข้อมูลเพลย์ลิสต์ทั้งหมดที่ผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์เป็นเจ้าของ หรือดึงข้อมูลเพลย์ลิสต์อย่างน้อย 1 รายการตามรหัสที่ไม่ซ้ำกันของเพลย์ลิสต์
insert POST /playlists สร้างเพลย์ลิสต์
update PUT /playlists แก้ไขเพลย์ลิสต์ เช่น คุณอาจเปลี่ยนชื่อ คำอธิบาย หรือสถานะความเป็นส่วนตัวของเพลย์ลิสต์ได้

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /search แสดงผลคอลเล็กชันของผลการค้นหาที่ตรงกับพารามิเตอร์การค้นหาที่ระบุในคำขอ API โดยค่าเริ่มต้น ชุดผลการค้นหาจะระบุทรัพยากร video, channel และ playlist ที่ตรงกัน แต่คุณยังกำหนดค่าคำค้นหาให้ดึงข้อมูลทรัพยากรประเภทใดประเภทหนึ่งเท่านั้นได้ด้วย

การติดตาม

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
delete DELETE /subscriptions ลบการสมัครใช้บริการ
insert POST /subscriptions เพิ่มการติดตามช่องของผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์
list GET /subscriptions แสดงผลทรัพยากรการติดตามที่ตรงกับเกณฑ์คำขอ API

ภาพขนาดย่อ

thumbnail ระบุขนาดรูปภาพปกต่างๆ ที่เชื่อมโยงกับทรัพยากร ลักษณะต่อไปนี้ของภาพปก

  • พร็อพเพอร์ตี้ snippet.thumbnails ของทรัพยากรคือออบเจ็กต์ที่ระบุรูปภาพขนาดย่อที่พร้อมใช้งานสำหรับทรัพยากรนั้น
  • thumbnail ทรัพยากรประกอบด้วยชุดออบเจ็กต์ ชื่อของแต่ละออบเจ็กต์ (default, medium, high ฯลฯ) หมายถึงขนาดรูปภาพขนาดย่อ
  • แหล่งข้อมูลประเภทต่างๆ อาจรองรับขนาดภาพปกที่แตกต่างกัน
  • แหล่งข้อมูลประเภทต่างๆ อาจกำหนดขนาดที่แตกต่างกันสำหรับภาพขนาดย่อที่มีชื่อเดียวกัน เช่น โดยปกติแล้วdefaultภาพขนาดย่อสำหรับvideoแหล่งข้อมูลจะมีขนาด 120x90 พิกเซล และdefaultภาพขนาดย่อสำหรับchannelแหล่งข้อมูลจะมีขนาด 88x88 พิกเซล
  • แหล่งข้อมูลประเภทเดียวกันอาจยังมีขนาดภาพขนาดย่อที่แตกต่างกันสำหรับรูปภาพบางรูป ทั้งนี้ขึ้นอยู่กับความละเอียดของรูปภาพหรือเนื้อหาต้นฉบับที่อัปโหลดไปยัง YouTube เช่น วิดีโอ HD อาจรองรับภาพปกที่มีความละเอียดสูงกว่าวิดีโอที่ไม่ใช่ HD
  • ออบเจ็กต์แต่ละรายการที่มีข้อมูลเกี่ยวกับขนาดรูปภาพขนาดย่อจะมีพร็อพเพอร์ตี้ width และพร็อพเพอร์ตี้ height อย่างไรก็ตาม ระบบอาจไม่แสดงผลพร็อพเพอร์ตี้ความกว้างและความสูงสำหรับรูปภาพนั้น
  • หากรูปภาพปกที่อัปโหลดไม่ตรงกับขนาดที่กำหนด ระบบจะปรับขนาดรูปภาพให้ตรงกับขนาดที่ถูกต้องโดยไม่เปลี่ยนสัดส่วนภาพ รูปภาพไม่ได้ถูกครอบตัด แต่อาจมีแถบสีดำเพื่อให้ขนาดถูกต้อง

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
set POST /thumbnails/set อัปโหลดภาพปกวิดีโอที่ทำเองไปยัง YouTube และตั้งค่าให้วิดีโอ

VideoAbuseReportReasons

videoAbuseReportReasonแหล่งข้อมูลมีข้อมูลเกี่ยวกับเหตุผลที่วิดีโอจะถูกแจ้งว่ามีเนื้อหาที่เป็นการละเมิด เมื่อแอปพลิเคชันเรียกใช้เมธอด videos.reportAbuse เพื่อรายงานวิดีโอที่มีการละเมิด คำขอจะใช้ข้อมูลจากทรัพยากร videoAbuseReportReason เพื่อระบุเหตุผลที่วิดีโอถูกรายงาน

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /videoAbuseReportReasons ดึงข้อมูลรายการเหตุผลที่ใช้รายงานวิดีโอที่มีการละเมิดได้

VideoCategories

videoCategoryทรัพยากรจะระบุหมวดหมู่ที่เชื่อมโยงหรืออาจเชื่อมโยงกับวิดีโอที่อัปโหลด

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
list GET /videoCategories แสดงผลรายการหมวดหมู่ที่เชื่อมโยงกับวิดีโอ YouTube ได้

วิดีโอ

video ทรัพยากรแสดงถึงวิดีโอ YouTube

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
insert POST /videos อัปโหลดวิดีโอไปยัง YouTube และตั้งค่าข้อมูลเมตาของวิดีโอ (ไม่บังคับ)
list GET /videos แสดงรายการวิดีโอที่ตรงกับพารามิเตอร์คำขอ API
delete DELETE /videos ลบวิดีโอ YouTube
update PUT /videos อัปเดตข้อมูลเมตาของวิดีโอ
rate POST /videos/rate ให้คะแนนชอบหรือไม่ชอบวิดีโอหรือนำคะแนนออกจากวิดีโอ
getRating GET /videos/getRating ดึงข้อมูลการให้คะแนนที่ผู้ใช้ที่ได้รับอนุญาตให้คะแนนวิดีโอที่ระบุไว้ในรายการ
reportAbuse POST /videos/reportAbuse รายงานวิดีโอว่ามีเนื้อหาที่เป็นการละเมิด

ลายน้ำ

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับทรัพยากรนี้ได้ที่การแสดงทรัพยากรและรายการพร็อพเพอร์ตี้

วิธีการ คำขอ HTTP คำอธิบาย
URI ที่เกี่ยวข้องกับ https://www.googleapis.com/youtube/v3
set POST /watermarks/set อัปโหลดรูปภาพลายน้ำไปยัง YouTube และตั้งค่าให้ช่อง
unset POST /watermarks/unset ลบรูปภาพลายน้ำของช่อง