search sonucu, bir API isteğinde belirtilen arama parametreleriyle eşleşen bir YouTube videosu, kanalı veya oynatma listesi hakkında bilgi içerir. Arama sonuçları, video gibi benzersiz şekilde tanımlanabilen bir kaynağı işaret etse de kendi kalıcı verilerine sahip değildir.
Yöntemler
API, arama için aşağıdaki yöntemleri destekler:
- list
- API isteğinde belirtilen sorgu parametreleriyle eşleşen bir arama sonucu koleksiyonu döndürür. Varsayılan olarak bir arama sonucu kümesi, eşleşen
video,channelveplaylistkaynaklarını tanımlar ancak sorguları yalnızca belirli bir kaynak türünü alacak şekilde de yapılandırabilirsiniz. Hemen deneyin.
Kaynak temsili
Aşağıdaki JSON yapısında bir arama sonucunun biçimi gösterilmektedir:
{
"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
}
}Özellikler
Aşağıdaki tabloda, bir arama sonucunda görünen özellikler tanımlanmaktadır:
| Özellikler | |
|---|---|
kind |
stringAPI kaynağının türünü tanımlar. Değer youtube#searchResult olur. |
etag |
etagBu kaynağın Etag değeri. |
id |
objectid nesnesi, arama isteğiyle eşleşen kaynağı benzersiz şekilde tanımlamak için kullanılabilecek bilgileri içerir. |
id.kind |
stringAPI kaynağının türü. |
id.videoId |
stringid.type mülkünün değeri youtube#video ise bu mülk mevcut olur ve değeri, YouTube'un arama sorgusuyla eşleşen bir videoyu benzersiz şekilde tanımlamak için kullandığı kimliği içerir. |
id.channelId |
stringid.type mülkünün değeri youtube#channel ise bu mülk mevcut olur ve değeri, YouTube'un arama sorgusuyla eşleşen bir kanalı benzersiz şekilde tanımlamak için kullandığı kimliği içerir. |
id.playlistId |
stringid.type mülkünün değeri youtube#playlist ise bu mülk mevcut olur ve değeri, YouTube'un arama sorgusuyla eşleşen bir oynatma listesini benzersiz şekilde tanımlamak için kullandığı kimliği içerir. |
snippet |
objectsnippet nesnesi, bir arama sonucuyla ilgili temel ayrıntıları (ör. başlığı veya açıklaması) içerir. Örneğin, arama sonucu bir videoysa başlık videonun başlığı, açıklama ise videonun açıklaması olur. |
snippet.publishedAt |
datetimeArama sonucunun tanımladığı kaynağın oluşturulma tarihi ve saati. Değer ISO 8601 biçiminde belirtilir. |
snippet.channelId |
stringYouTube'un, arama sonucunun tanımladığı kaynağı yayınlayan kanalı benzersiz şekilde tanımlamak için kullandığı değer. |
snippet.title |
stringArama sonucunun başlığı. |
snippet.description |
stringArama sonucunun açıklaması. |
snippet.thumbnails |
objectArama sonucuyla ilişkili küçük resimlerin haritası. Haritadaki her nesne için anahtar, küçük resmin adıdır ve değer, küçük resimle ilgili diğer bilgileri içeren bir nesnedir. |
snippet.thumbnails.(key) |
objectGeçerli anahtar değerleri:
|
snippet.thumbnails.(key).url |
stringResmin URL'si. |
snippet.thumbnails.(key).width |
unsigned integerResmin genişliği. |
snippet.thumbnails.(key).height |
unsigned integerResmin yüksekliği. |
snippet.channelTitle |
stringArama sonucunun tanımladığı kaynağı yayınlayan kanalın adı. |
snippet.liveBroadcastContent |
stringvideo veya channel kaynağının canlı yayın içeriği içerip içermediğini belirtir. Geçerli özellik değerleri upcoming, live ve none'dir.video kaynağı için upcoming değeri, videonun henüz başlamamış bir canlı yayın olduğunu, live değeri ise videonun etkin bir canlı yayın olduğunu gösterir. channel kaynağı için upcoming değeri, kanalın henüz başlatılmamış planlanmış bir yayını olduğunu, live değeri ise kanalın etkin bir canlı yayını olduğunu gösterir. |