Videos: list

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

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

Use Case ทั่วไป

ส่งคำขอ

คำขอ 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 ระบุว่าข้อมูลเข้าสู่ระบบการให้สิทธิ์ของคำขอระบุผู้ใช้ 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