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 ที่สามารถรวมในค่าพารามิเตอร์ได้
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
ตัวกรอง (ระบุพารามิเตอร์ตัวใดตัวหนึ่งต่อไปนี้)
chart string
พารามิเตอร์ chart จะระบุแผนภูมิที่คุณต้องการเรียกดู

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

ค่าที่ยอมรับได้มีดังนี้
  • 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 ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคําขอระบุผู้ใช้ CMS ของ YouTube ที่ทําหน้าที่ในนามของเจ้าของเนื้อหาที่ระบุในค่าพารามิเตอร์ พารามิเตอร์นี้มีไว้สําหรับพาร์ทเนอร์เนื้อหา 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