Arama sonuçları, bir API isteğinde belirtilen arama parametreleriyle eşleşen bir YouTube videosu, kanalı veya oynatma listesiyle ilgili bilgiler içerir. Bir arama sonucu, video gibi benzersiz şekilde tanımlanabilir bir kaynağa işaret etse de kendine ait kalıcı verileri yoktur.
Yöntemler
API, aşağıdaki arama yöntemlerini destekler:
- list
- API isteğinde belirtilen sorgu parametreleriyle eşleşen arama sonuçlarının koleksiyonunu döndürür. Varsayılan olarak, bir arama sonucu kümesi 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österir:
{ "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 |
string API kaynağının türünü tanımlar. Değer youtube#searchResult olur. |
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 bilgileri içerir. |
id.kind |
string API kaynağının türü. |
id.videoId |
string id.type özelliğinin değeri youtube#video ise bu özellik 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 özellik 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 özellik 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 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 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 tanımladığı kaynağı yayınlayan kanalı benzersiz bir şekilde tanımlamak için kullandığı değerdir. |
snippet.title |
string Arama sonucunun başlığı. |
snippet.description |
string Arama sonucunun açıklaması. |
snippet.thumbnails |
object Arama sonucuyla ilişkilendirilen küçük resimlerin haritası. Haritadaki her bir nesne için anahtar, küçük resmin adı ve değer, küçük resimle ilgili 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ığıdır. |
snippet.liveBroadcastContent |
string Bir video veya channel kaynağının canlı yayın içeriğine sahip olup olmadığının göstergesi. Geçerli özellik değerleri upcoming , live ve none 'dir.Bir video kaynağı için upcoming değeri videonun henüz başlatılmamış canlı yayın olduğunu belirtirken live değeri videonun etkin bir canlı yayın olduğunu belirtir. Bir channel kaynağı için upcoming değeri, kanalın henüz başlatılmamış planlanmış bir yayının olduğunu belirtir. live değeri ise kanalın etkin bir canlı yayının olduğunu belirtir. |