Arama sonucu, YouTube videosu, kanalı veya oynatma listesi hakkında API isteğinde belirtilen arama parametreleriyle eşleşen bilgiler içerir. Arama sonuçları video gibi benzersiz şekilde tanımlanabilir bir kaynağa 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 arama sonuçları koleksiyonunu döndürür. Varsayılan olarak, bir arama sonucu grubu eşleşen
video
,channel
veplaylist
kaynakları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ı, bir arama sonucunun biçimini göstermektedir:
{ "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, arama sonucunda görünen özellikler tanımlanmaktadır:
Özellikler | |
---|---|
kind |
string API kaynağının türünü tanımlar. Değer youtube#searchResult olacak. |
etag |
etag Bu kaynağın Etag'i. |
id |
object id nesnesi, arama isteğiyle eşleşen kaynağı benzersiz şekilde tanımlamak için kullanılabilecek bilgiler içerir. |
id.kind |
string API kaynağının türü. |
id.videoId |
string id.type özelliğinin 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 |
string id.type özelliğinin 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 |
string id.type özelliğinin 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 |
object snippet nesnesi, bir arama sonucuyla ilgili başlık veya açıklama gibi temel ayrıntıları içerir. Örneğin, arama sonucu bir video ise başlık videonun başlığı ve açıklama da videonun açıklaması olur. |
snippet.publishedAt |
datetime Arama sonucunun tanımladığı kaynağın oluşturulma tarihi ve saati. Değer ISO 8601 biçiminde belirtilir. |
snippet.channelId |
string YouTube'un, arama sonucunun tespit ettiği kaynağı yayınlayan kanalı benzersiz şekilde tanımlamak için kullandığı değer. |
snippet.title |
string Arama sonucunun başlığı. |
snippet.description |
string Arama sonucunun açıklaması. |
snippet.thumbnails |
object Arama sonucuyla ilişkili küçük resim haritası. Haritadaki her bir nesne için anahtar, küçük resmin adı, değer de küçük resim hakkında diğer bilgileri içeren bir nesnedir. |
snippet.thumbnails.(key) |
object Geçerli anahtar değerleri şunlardır:
|
snippet.thumbnails.(key).url |
string Resmin URL'si. |
snippet.thumbnails.(key).width |
unsigned integer Resmin genişliği. |
snippet.thumbnails.(key).height |
unsigned integer Resmin yüksekliği. |
snippet.channelTitle |
string Arama sonucunun tanımladığı kaynağı yayınlayan kanalın başlığı. |
snippet.liveBroadcastContent |
string video veya channel kaynağında canlı yayın içeriği olup olmadığına dair bir gösterge. Geçerli özellik değerleri upcoming , live ve none 'dir.video kaynağı için upcoming değeri, videonun henüz başlatılmamış bir canlı yayın olduğunu belirtirken live değeri, videonun etkin bir canlı yayın olduğunu belirtir. channel kaynağı için upcoming değeri, kanalın henüz başlamamış planlanmış bir yayını olduğunu gösterirken live değeri kanalın etkin bir canlı yayınının olduğunu gösterir. |