API istek parametreleriyle eşleşen videoların listesini döndürür.
Kota etkisi: Bu yönteme yapılan bir çağrının 1 birim kota maliyeti olur.
Yaygın kullanım alanları
İstek
HTTP isteği
GET https://www.googleapis.com/youtube/v3/videos
Parametreler
Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen parametrelerin tümü sorgu parametreleridir.
Parametreler | ||
---|---|---|
Gerekli parametreler | ||
part |
string part parametresi, API yanıtının içereceği bir veya daha fazla video kaynak özelliğinin virgülle ayrılmış listesini belirtir.Parametre alt özellikler içeren bir özelliği tanımlarsa alt özellikler yanıta dahil edilir. Örneğin, bir video kaynağında snippet özelliği channelId , title , description , tags ve categoryId özelliklerini içerir. Bu nedenle, part=snippet öğesini ayarlarsanız API yanıtı bu özelliklerin tümünü içerir.Aşağıdaki listede parametre değerine ekleyebileceğiniz part adları yer almaktadır:
|
|
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin) | ||
chart |
string chart parametresi, almak istediğiniz grafiği tanımlar.Kabul edilebilir değerler şunlardır:
|
|
id |
string id parametresi, alınan kaynaklar için YouTube video kimliklerinin virgülle ayrılmış listesini belirtir. Bir video kaynağında, id özelliği videonun kimliğini belirtir. |
|
myRating |
string Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. API'ye yalnızca kimliği doğrulanmış kullanıcı tarafından beğenilen veya beğenilmeyen videoları döndürecek şekilde bilgi vermek için bu parametrenin değerini like veya dislike olarak ayarlayın.Kabul edilebilir değerler şunlardır:
|
|
İsteğe bağlı parametreler | ||
hl |
string hl parametresi, API'ye YouTube web sitesinin desteklediği belirli bir uygulama dili için yerelleştirilmiş kaynak meta verilerini almasını söyler. Parametre değeri, i18nLanguages.list yöntemi tarafından döndürülen listeye eklenmiş bir dil kodu olmalıdır.Yerelleştirilmiş kaynak ayrıntıları söz konusu dilde mevcutsa kaynağın snippet.localized nesnesi, yerelleştirilmiş değerleri içerir. Ancak yerelleştirilmiş ayrıntılar mevcut değilse snippet.localized nesnesi, kaynağın varsayılan dilindeki kaynak ayrıntılarını içerir. |
|
maxHeight |
unsigned integer maxHeight parametresi, player.embedHtml mülkünde döndürülen yerleştirilmiş oynatıcının maksimum yüksekliğini belirtir. Yerleştirme kodunun, varsayılan boyutlar yerine uygulama düzeninize uygun bir yükseklik kullanması gerektiğini belirtmek için bu parametreyi kullanabilirsiniz. maxWidth parametresi de sağlanmışsa maksimum genişliği ihlal etmemek için oynatıcı, maxHeight değerinden daha kısa olabilir. Kabul edilebilir değerler 72 ile 8192 arasındadır (bu değerler dahil). |
|
maxResults |
unsigned integer maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir.Not: Bu parametre, myRating parametresiyle birlikte kullanılması desteklenir ancak id parametresiyle birlikte kullanılması desteklenmez. Kabul edilebilir değerler 1 ile 50 arasındadır (bu değerler dahil). Varsayılan değer 5 değeridir. |
|
maxWidth |
unsigned integer maxWidth parametresi, player.embedHtml mülkünde döndürülen yerleştirilmiş oynatıcının maksimum genişliğini belirtir. Yerleştirme kodunda, varsayılan boyutlar yerine uygulamanızın düzenine uygun bir genişlik kullanılması gerektiğini belirtmek için bu parametreyi kullanabilirsiniz.Ayrıca maxHeight parametresi sağlanmışsa oynatıcı maksimum yüksekliği ihlal etmemek için maxWidth değerinden daha dar olabilir. Kabul edilebilir değerler 72 ile 8192 arasındadır (bu değerler dahil). |
|
onBehalfOfContentOwner |
string Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortaklarına yöneliktir. onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube CMS kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. İçerik sahiplerinin, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yaparak tüm video ve kanal verilerine erişmelerine olanak tanır. Kullanıcının kimlik doğrulaması yaptığı CMS hesabı, belirtilen YouTube içerik sahibine bağlanmalıdır. |
|
pageToken |
string pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. Bir API yanıtında, nextPageToken ve prevPageToken özellikleri alınabilecek diğer sayfaları tanımlar.Not: Bu parametrenin myRating parametresiyle birlikte kullanılması desteklenir ancak id parametresiyle birlikte kullanılması desteklenmez. |
|
regionCode |
string regionCode parametresi, API'ye belirtilen bölgede mevcut olan bir video grafiği seçmesini bildirir. Bu parametre yalnızca chart parametresiyle birlikte kullanılabilir. Parametre değeri bir ISO 3166-1 alfa-2 ülke kodudur. |
|
videoCategoryId |
string videoCategoryId parametresi, grafiğin alınması gereken video kategorisini tanımlar. Bu parametre yalnızca chart parametresiyle birlikte kullanılabilir. Grafikler varsayılan olarak belirli bir kategoriyle sınırlı değildir. Varsayılan değer 0 değeridir. |
İstek içeriği
Bu yöntemi çağırırken istek gövdesi sağlamayın.
Yanıt
Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt gövdesi döndürür:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
Özellikler
Aşağıdaki tabloda bu kaynakta görünen özellikler tanımlanmaktadır:
Özellikler | |
---|---|
kind |
string API kaynağının türünü tanımlar. Değer youtube#videoListResponse olur. |
etag |
etag Bu kaynağın Etag'i. |
nextPageToken |
string Sonuç grubundaki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. |
prevPageToken |
string Sonuç grubundaki önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. |
pageInfo |
object pageInfo nesnesi, sonuç kümesiyle ilgili sayfalama bilgilerini içerir. |
pageInfo.totalResults |
integer Sonuç kümesindeki toplam sonuç sayısı. |
pageInfo.resultsPerPage |
integer API yanıtına dahil edilen sonuçların sayısı. |
items[] |
list İstek ölçütlerine uyan videoların listesi. |
Hatalar
Aşağıdaki tabloda, API'nin bu yönteme yapılan çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için lütfen hata mesajı dokümanlarına bakın.
Hata türü | Hata ayrıntısı | Açıklama |
---|---|---|
badRequest (400) |
videoChartNotFound |
İstenen video grafiği desteklenmiyor veya kullanılamıyor. |
forbidden (403) |
forbidden |
İsteğin, video dosyasına veya işleme bilgilerine erişmek için gerektiği gibi yetkisi yok. fileDetails , processingDetails ve suggestions bölümlerini yalnızca videonun sahibi kullanabileceğini unutmayın. |
forbidden (403) |
forbidden |
İstek, kullanıcı puanı bilgilerine erişemez. Bu hata, isteğin myRating parametresini kullanmak için doğru şekilde yetkilendirilmemesinden kaynaklanabilir. |
notFound (404) |
videoNotFound |
Getirmeye çalıştığınız video bulunamıyor. İsteğin id parametre değerinin doğru olup olmadığını kontrol edin. |
Deneyin.
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer kullanın.