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