search ผลลัพธ์ประกอบด้วยข้อมูลเกี่ยวกับวิดีโอ YouTube ช่อง หรือเพลย์ลิสต์บน 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 |
etagEtag ของทรัพยากรนี้ |
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ค่าคีย์ที่ใช้ได้มีดังนี้
หมายเหตุ: ผลการค้นหาไม่รองรับภาพปก 1080p+ ( |
snippet.thumbnails.(key).url |
stringURL ของรูปภาพ |
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 หมายความว่าช่องมี การถ่ายทอดสด ที่กำลังเผยแพร่ |