Search

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

เมธอด

API รองรับวิธีการค้นหาต่อไปนี้

list
แสดงผลชุดผลการค้นหาที่ตรงกับพารามิเตอร์การค้นหาที่ระบุในคําขอ API โดยค่าเริ่มต้น ชุดผลการค้นหาจะระบุทรัพยากร video, channel และ playlist ที่ตรงกัน แต่คุณยังกําหนดค่าการค้นหาให้ดึงเฉพาะทรัพยากรบางประเภทได้ด้วย ลองใช้เลย

การนําเสนอทรัพยากร

โครงสร้าง JSON ต่อไปนี้แสดงรูปแบบของผลการค้นหา

{
  "kind": "youtube#searchResult",
  "etag": etag,
  "id": {
    "kind": string,
    "videoId": string,
    "channelId": string,
    "playlistId": string
  },
  "snippet": {
    "publishedAt": datetime,
    "channelId": string,
    "title": string,
    "description": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "channelTitle": string,
    "liveBroadcastContent": string
  }
}

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

ตารางต่อไปนี้จะกำหนดพร็อพเพอร์ตี้ที่ปรากฏในผลการค้นหา

พร็อพเพอร์ตี้
kind string
ระบุประเภทของทรัพยากร API ค่าจะเป็น youtube#searchResult
etag etag
Etag ของทรัพยากรนี้
id object
ออบเจ็กต์ id มีข้อมูลที่สามารถใช้เพื่อระบุทรัพยากรที่ตรงกับคำขอค้นหาได้อย่างไม่ซ้ำกัน
id.kind string
ประเภทของทรัพยากร API
id.videoId string
หากค่าของพร็อพเพอร์ตี้ id.type คือ youtube#video พร็อพเพอร์ตี้นี้จะแสดงอยู่และค่าของพร็อพเพอร์ตี้จะมีรหัสที่ YouTube ใช้เพื่อระบุวิดีโอที่ตรงกับคำค้นหาอย่างเจาะจง
id.channelId string
หากค่าของพร็อพเพอร์ตี้ id.type คือ youtube#channel พร็อพเพอร์ตี้นี้จะแสดงอยู่และค่าของพร็อพเพอร์ตี้จะมีรหัสที่ YouTube ใช้เพื่อระบุช่องที่ตรงกับคำค้นหาอย่างเจาะจง
id.playlistId string
หากค่าของพร็อพเพอร์ตี้ id.type คือ youtube#playlist พร็อพเพอร์ตี้นี้จะแสดงอยู่และค่าของพร็อพเพอร์ตี้จะมีรหัสที่ YouTube ใช้เพื่อระบุเพลย์ลิสต์ที่ตรงกับคำค้นหาอย่างเจาะจง
snippet object
ออบเจ็กต์ snippet มีรายละเอียดพื้นฐานเกี่ยวกับผลการค้นหา เช่น ชื่อหรือคำอธิบาย เช่น หากผลการค้นหาเป็นวิดีโอ ชื่อจะเป็นชื่อของวิดีโอและคำอธิบายจะเป็นคำอธิบายของวิดีโอ
snippet.publishedAt datetime
วันที่และเวลาที่สร้างทรัพยากรที่ผลการค้นหาระบุ ค่าที่ระบุอยู่ในรูปแบบ ISO 8601
snippet.channelId string
ค่าที่ YouTube ใช้เพื่อระบุช่องที่เผยแพร่ทรัพยากรซึ่งผลการค้นหาระบุโดยไม่ซ้ำกัน
snippet.title string
ชื่อของผลการค้นหา
snippet.description string
คําอธิบายผลการค้นหา
snippet.thumbnails object
แผนที่รูปภาพขนาดย่อที่เชื่อมโยงกับผลการค้นหา สำหรับออบเจ็กต์แต่ละรายการในแผนที่ คีย์คือชื่อรูปภาพขนาดย่อ และค่าคือออบเจ็กต์ที่มีข้อมูลอื่นๆ เกี่ยวกับรูปภาพขนาดย่อ
snippet.thumbnails.(key) object
คีย์-ค่าที่ใช้ได้มีดังนี้
  • default – รูปภาพขนาดย่อเริ่มต้น ภาพปกเริ่มต้นของวิดีโอหรือแหล่งข้อมูลที่อ้างอิงวิดีโอ เช่น รายการเพลย์ลิสต์หรือผลการค้นหา จะมีความกว้าง 120 พิกเซลและความสูง 90 พิกเซล ภาพปกเริ่มต้นของช่องมีความกว้าง 88 พิกเซลและสูง 88 พิกเซล
  • medium – รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงขึ้น สำหรับวิดีโอ (หรือทรัพยากรที่อ้างอิงถึงวิดีโอ) รูปภาพนี้มีความกว้าง 320 พิกเซลและความสูง 180 พิกเซล สำหรับช่อง รูปภาพนี้ควรมีความกว้าง 240 พิกเซลและสูง 240 พิกเซล
  • high – รูปภาพขนาดย่อเวอร์ชันความละเอียดสูง สำหรับวิดีโอ (หรือแหล่งข้อมูลที่อ้างอิงวิดีโอ) รูปภาพนี้มีความกว้าง 480 พิกเซลและความสูง 360 พิกเซล สำหรับช่อง รูปภาพนี้ควรมีความกว้าง 800 พิกเซลและสูง 800 พิกเซล
  • standard – รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงกว่ารูปภาพความละเอียด high รูปภาพนี้ใช้ได้กับวิดีโอบางรายการและแหล่งข้อมูลอื่นๆ ที่อ้างอิงถึงวิดีโอ เช่น รายการในเพลย์ลิสต์หรือผลการค้นหา รูปภาพนี้กว้าง 640 พิกเซลและสูง 480 พิกเซล
  • maxres – รูปภาพขนาดย่อเวอร์ชันที่มีความละเอียดสูงสุด รูปภาพขนาดนี้มีให้สำหรับวิดีโอบางรายการและทรัพยากรอื่นๆ ที่อ้างอิงถึงวิดีโอ เช่น รายการในเพลย์ลิสต์หรือผลการค้นหา รูปภาพนี้มีความกว้าง 1280 พิกเซลและสูง 720 พิกเซล
snippet.thumbnails.(key).url string
URL ของรูปภาพ
snippet.thumbnails.(key).width unsigned integer
ความกว้างของรูปภาพ
snippet.thumbnails.(key).height unsigned integer
ความสูงของรูปภาพ
snippet.channelTitle string
ชื่อของช่องที่เผยแพร่ทรัพยากรที่ผลการค้นหาระบุ
snippet.liveBroadcastContent string
ตัวบ่งชี้ว่าทรัพยากร video หรือ channel มีเนื้อหาการออกอากาศสดหรือไม่ ค่าพร็อพเพอร์ตี้ที่ใช้ได้คือ upcoming, live และ none

สำหรับทรัพยากร video ค่า upcoming บ่งบอกว่าวิดีโอเป็นการถ่ายทอดสดที่ยังไม่ได้เริ่ม ขณะที่ค่า live บ่งบอกว่าวิดีโอเป็นการถ่ายทอดสดที่ดำเนินอยู่ สำหรับทรัพยากร channel ค่า upcoming บ่งบอกว่าช่องมีการออกอากาศตามกำหนดการที่ยังไม่ได้เริ่ม ส่วนค่า live บ่งบอกว่าช่องมีการออกอากาศสดที่ดำเนินอยู่