Videos: list

แสดงรายการวิดีโอที่ตรงกับพารามิเตอร์คำขอ API

ผลกระทบต่อโควต้า: การเรียกใช้เมธอดนี้มีค่าใช้จ่ายโควต้า 1 หน่วย

กรณีการใช้งานทั่วไป

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/youtube/v3/videos

พารามิเตอร์

ตารางต่อไปนี้แสดงพารามิเตอร์ที่การค้นหานี้รองรับ พารามิเตอร์ทั้งหมดที่ระบุไว้เป็นพารามิเตอร์การค้นหา

พารามิเตอร์
พารามิเตอร์ที่จำเป็น
part string
พารามิเตอร์ part ระบุรายการพร็อพเพอร์ตี้ของทรัพยากร video อย่างน้อย 1 รายการที่คั่นด้วยคอมมา ซึ่งการตอบกลับจาก API จะรวมไว้

หากพารามิเตอร์ระบุพร็อพเพอร์ตี้ที่มีพร็อพเพอร์ตี้ย่อย ระบบจะรวมพร็อพเพอร์ตี้ย่อยไว้ในการตอบกลับ เช่น ในทรัพยากร video พร็อพเพอร์ตี้ snippet มีพร็อพเพอร์ตี้ channelId, title, description, tags และ categoryId ดังนั้น หากคุณตั้งค่า part=snippet การตอบกลับจาก API จะมีพร็อพเพอร์ตี้ทั้งหมดเหล่านั้น

รายการต่อไปนี้มีชื่อ part ที่คุณสามารถรวมไว้ในค่าพารามิเตอร์
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
ตัวกรอง (ระบุพารามิเตอร์ต่อไปนี้เพียง 1 รายการ)
chart string
พารามิเตอร์ chart ระบุแผนภูมิที่คุณต้องการดึงข้อมูล

ค่าที่ยอมรับได้มีดังนี้
id string
พารามิเตอร์ id ระบุรายการรหัสวิดีโอ YouTube อย่างน้อย 1 รายการที่คั่นด้วยคอมมาสำหรับทรัพยากรที่จะดึงข้อมูล ในทรัพยากร video พร็อพเพอร์ตี้ id จะระบุรหัสของวิดีโอ
myRating string

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



API จำกัดชุดผลลัพธ์ที่แสดงไว้ที่วิดีโอสูงสุด 1,000 รายการ แม้ว่าพร็อพเพอร์ตี้ pageInfo.totalResults ของการตอบกลับจะระบุจำนวนทั้งหมดที่สูงกว่า แต่การแบ่งหน้าโดยใช้พารามิเตอร์ pageToken จะอนุญาตให้ดึงข้อมูลรายการล่าสุด 1, 000 รายการเท่านั้น



พารามิเตอร์ยอมรับค่าต่อไปนี้

  • dislike \- แสดงเฉพาะวิดีโอที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วกดไม่ชอบ
  • like \- แสดงเฉพาะวิดีโอที่ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วกดชอบ
พารามิเตอร์ที่ไม่บังคับ
hl string
พารามิเตอร์ hl สั่งให้ API ดึงข้อมูลเมตาของทรัพยากรที่แปลเป็นภาษาท้องถิ่นสำหรับภาษาแอปพลิเคชันที่เฉพาะเจาะจงซึ่งเว็บไซต์ YouTube รองรับ ค่าพารามิเตอร์ต้องเป็นรหัสภาษาที่รวมอยู่ในรายการที่เมธอด i18nLanguages.list แสดง

หากมีรายละเอียดทรัพยากรที่แปลเป็นภาษาท้องถิ่นในภาษานั้น ออบเจ็กต์ snippet.localized ของทรัพยากรจะมีค่าที่แปลเป็นภาษาท้องถิ่น อย่างไรก็ตาม หากไม่มีรายละเอียดที่แปลเป็นภาษาท้องถิ่น ออบเจ็กต์ snippet.localized จะมีรายละเอียดทรัพยากรในภาษาเริ่มต้นของทรัพยากร
maxHeight unsigned integer
พารามิเตอร์ maxHeight ระบุความสูงสูงสุดของเพลเยอร์ที่ฝังซึ่งแสดงในพร็อพเพอร์ตี้ player.embedHtml คุณสามารถใช้พารามิเตอร์นี้เพื่อระบุว่าโค้ดฝังควรใช้ความสูงที่เหมาะสมกับเลย์เอาต์แอปพลิเคชันแทนที่จะใช้ขนาดเริ่มต้น หากระบุพารามิเตอร์ maxWidth ด้วย เพลเยอร์อาจมีความสูงน้อยกว่า maxHeight เพื่อไม่ให้ละเมิดความกว้างสูงสุด ค่าที่ยอมรับได้คือ 72 ถึง 8192
maxResults unsigned integer
พารามิเตอร์ maxResults ระบุจำนวนสูงสุดของรายการที่ควรแสดงในชุดผลลัพธ์

หมายเหตุ: ระบบรองรับการใช้พารามิเตอร์นี้ร่วมกับพารามิเตอร์ myRating แต่ไม่รองรับการใช้ร่วมกับพารามิเตอร์ id ค่าที่ยอมรับได้คือ 1 ถึง 50 ค่าเริ่มต้นคือ 5
maxWidth unsigned integer
พารามิเตอร์ maxWidth ระบุความกว้างสูงสุดของเพลเยอร์ที่ฝังซึ่งแสดงในพร็อพเพอร์ตี้ player.embedHtml คุณสามารถใช้พารามิเตอร์นี้เพื่อระบุว่าโค้ดฝังควรใช้ความกว้างที่เหมาะสมกับเลย์เอาต์แอปพลิเคชันแทนที่จะใช้ขนาดเริ่มต้น

หากระบุพารามิเตอร์ maxHeight ด้วย เพลเยอร์อาจมีความกว้างน้อยกว่า maxWidth เพื่อไม่ให้ละเมิดความสูงสูงสุด ค่าที่ยอมรับได้คือ 72 ถึง 8192
onBehalfOfContentOwner string
พารามิเตอร์นี้ใช้ได้เฉพาะในคำขอที่ได้รับอนุญาตอย่างถูกต้อง หมายเหตุ: พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube เท่านั้น

พารามิเตอร์ onBehalfOfContentOwner บ่งชี้ว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ YouTube CMS ที่ดำเนินการในนามของเจ้าของเนื้อหาที่ระบุไว้ในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สำหรับพาร์ทเนอร์เนื้อหาของ YouTube ที่เป็นเจ้าของและจัดการช่อง YouTube หลายช่อง ซึ่งช่วยให้เจ้าของเนื้อหาตรวจสอบสิทธิ์ได้เพียงครั้งเดียวและเข้าถึงข้อมูลวิดีโอและช่องทั้งหมดได้โดยไม่ต้องระบุข้อมูลรับรองการตรวจสอบสิทธิ์สำหรับแต่ละช่อง บัญชี CMS ที่ผู้ใช้ตรวจสอบสิทธิ์ต้องลิงก์กับเจ้าของเนื้อหา YouTube ที่ระบุ
pageToken string
พารามิเตอร์ pageToken ระบุหน้าเฉพาะในชุดผลลัพธ์ที่ควรแสดง ในการตอบกลับจาก API พร็อพเพอร์ตี้ nextPageToken และ prevPageToken จะระบุหน้าอื่นๆ ที่ดึงข้อมูลได้

หมายเหตุ: ระบบรองรับการใช้พารามิเตอร์นี้ร่วมกับพารามิเตอร์ myRating แต่ไม่รองรับการใช้ร่วมกับพารามิเตอร์ id
regionCode string
พารามิเตอร์ regionCode สั่งให้ API เลือกแผนภูมิวิดีโอที่พร้อมให้บริการในภูมิภาคที่ระบุ พารามิเตอร์นี้ใช้ได้เฉพาะกับพารามิเตอร์ chart ค่าพารามิเตอร์คือรหัสประเทศ ISO 3166-1 alpha-2
videoCategoryId string
พารามิเตอร์ videoCategoryId ระบุหมวดหมู่วิดีโอที่ควรดึงข้อมูลแผนภูมิ พารามิเตอร์นี้ใช้ได้เฉพาะกับพารามิเตอร์ chart โดยค่าเริ่มต้น แผนภูมิจะไม่มีการจำกัดหมวดหมู่ใดหมวดหมู่หนึ่ง ค่าเริ่มต้นคือ 0

เนื้อความของคำขอ

อย่าระบุเนื้อความของคำขอเมื่อเรียกใช้เมธอดนี้

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับที่มีโครงสร้างดังต่อไปนี้

{
  "kind": "youtube#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video Resource
  ]
}

พร็อพเพอร์ตี้

ตารางต่อไปนี้กำหนดพร็อพเพอร์ตี้ที่ปรากฏในทรัพยากรนี้

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#videoListResponse
etag etag
Etag ของทรัพยากรนี้
nextPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าถัดไปในชุดผลลัพธ์
prevPageToken string
โทเค็นที่ใช้เป็นค่าของพารามิเตอร์ pageToken เพื่อดึงข้อมูลหน้าก่อนหน้าในชุดผลลัพธ์
pageInfo object
ออบเจ็กต์ pageInfo จะรวมข้อมูลการแบ่งหน้าสำหรับชุดผลลัพธ์
pageInfo.totalResults integer
จำนวนผลลัพธ์ทั้งหมดในชุดผลลัพธ์
pageInfo.resultsPerPage integer
จำนวนผลลัพธ์ที่รวมอยู่ในการตอบกลับจาก API
items[] list
รายการวิดีโอที่ตรงกับเกณฑ์คำขอ

ข้อผิดพลาด

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

ประเภทข้อผิดพลาด รายละเอียดข้อผิดพลาด คำอธิบาย
badRequest (400) videoChartNotFound ระบบไม่รองรับหรือไม่มีแผนภูมิวิดีโอที่ขอ
forbidden (403) forbidden คำขอไม่ได้รับอนุญาตอย่างถูกต้องในการเข้าถึงไฟล์วิดีโอหรือข้อมูลการประมวลผล โปรดทราบว่าส่วน fileDetails, processingDetails และ suggestions พร้อมให้บริการแก่เจ้าของวิดีโอนั้นๆ เท่านั้น
forbidden (403) forbidden คำขอไม่สามารถเข้าถึงข้อมูลการให้คะแนนของผู้ใช้ ข้อผิดพลาดนี้อาจเกิดขึ้นเนื่องจากคำขอไม่ได้รับอนุญาตอย่างถูกต้องในการใช้พารามิเตอร์ myRating
notFound (404) videoNotFound ไม่พบวิดีโอที่คุณพยายามดึงข้อมูล ตรวจสอบค่าของพารามิเตอร์ id ในคำขอเพื่อให้แน่ใจว่าถูกต้อง

ลองใช้งาน

ใช้ APIs Explorer เพื่อเรียกใช้ API นี้และดูคำขอและการตอบกลับของ API