Playlists: list

API isteği parametreleriyle eşleşen oynatma listelerinin bir koleksiyonunu döndürür. Örneğin, kimliği doğrulanmış kullanıcının sahip olduğu tüm oynatma listelerini veya benzersiz kimliklerine göre bir ya da daha fazla oynatma listesini alabilirsiniz.

Kota etkisi: Bu yönteme yapılan bir çağrının kota maliyeti 1 birimdir.

Yaygın kullanım alanları

İstek

HTTP isteği

GET https://www.googleapis.com/youtube/v3/playlists

Parametreler

Aşağıdaki tabloda, bu sorgunun desteklediği parametreler listelenmiştir. Listelenen tüm parametreler sorgu parametreleridir.

Parametreler
Gerekli parametreler
part string
part parametresi, API yanıtının içereceği bir veya daha fazla playlist 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 playlist kaynağında snippet özelliği author, title, description ve timeCreated gibi özellikleri içerir. Bu nedenle, part=snippet değerini 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:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtreler (Aşağıdaki parametrelerden tam olarak birini belirtin)
channelId string
Bu değer, API'nin yalnızca belirtilen kanalın oynatma listelerini döndürmesi gerektiğini belirtir.
id string
id parametresi, alınan kaynakların YouTube oynatma listesi kimliklerinin virgülle ayrılmış listesini belirtir. playlist kaynağında, id özelliği oynatma listesinin YouTube oynatma listesi kimliğini belirtir.
mine boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. API'ye yalnızca kimliği doğrulanmış kullanıcıya ait oynatma listelerini döndürmesi talimatını vermek için bu parametrenin değerini true olarak ayarlayın.
İ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 alma talimatı verir. Parametre değeri, i18nLanguages.list yönteminin döndürdüğü listede yer alan bir dil kodu olmalıdır.

Yerelleştirilmiş kaynak ayrıntıları bu 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.
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilen değerler, 0 ile 50 (bu değerler dahil) arasındadır. Varsayılan değer 5'dır.
onBehalfOfContentOwner string
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları için tasarlanmıştır.

onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube İçerik Yönetim Sistemi 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 sahipleri, bu özellik sayesinde bir kez kimlik doğrulama yaparak tüm video ve kanal verilerine erişebilir. Her kanal için ayrı ayrı kimlik doğrulama bilgileri sağlamaları gerekmez. Kullanıcının kimliğini doğruladığı içerik yönetim sistemi hesabı, belirtilen YouTube içerik sahibine bağlı olmalıdır.
onBehalfOfContentOwnerChannel string
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları için tasarlanmıştır.

onBehalfOfContentOwnerChannel parametresi, videonun eklendiği kanalın YouTube kanal kimliğini belirtir. Bu parametre, bir istekte onBehalfOfContentOwner parametresi için değer belirtildiğinde gereklidir ve yalnızca bu parametreyle birlikte kullanılabilir. Ayrıca, istek, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İçerik Yönetim Sistemi hesabı kullanılarak yetkilendirilmelidir. Son olarak, onBehalfOfContentOwnerChannel parametre değerinin belirttiği kanal, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı olmalıdır.

Bu parametre, birçok farklı YouTube kanalının sahibi olan ve bunları yöneten YouTube içerik iş ortakları için tasarlanmıştır. İçerik sahiplerinin bir kez kimlik doğrulaması yapmasına ve her bir kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan, parametre değerinde belirtilen kanal adına işlem yapmasına olanak tanır.
pageToken string
pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken ve prevPageToken özellikleri, alınabilecek diğer sayfaları tanımlar.

İstek metni

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#playlistListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    playlist 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#playlistListResponse olur.
etag etag
Bu kaynağın Etag'i.
nextPageToken string
Sonuç kümesindeki sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
prevPageToken string
Sonuç kümesindeki önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
pageInfo object
pageInfo nesnesi, sonuç kümesi için sayfalama bilgilerini kapsar.
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çütleriyle eşleşen oynatma listelerinin listesi.

Hatalar

Aşağıdaki tabloda, API'nin bu yönteme yapılan bir çağrıya yanıt olarak döndürebileceği hata mesajları belirtilmektedir. Daha fazla bilgi için lütfen hata mesajı belgelerine bakın.

Hata türü Hata ayrıntısı Açıklama
forbidden (403) channelClosed channelId parametresinde belirtilen kanal kapatıldı.
forbidden (403) channelSuspended channelId parametresinde belirtilen kanal askıya alındı.
forbidden (403) playlistForbidden İsteğin id parametresiyle tanımlanan oynatma listesi, isteği desteklemiyor veya istek düzgün şekilde yetkilendirilmemiş.
notFound (404) channelNotFound channelId parametresinde belirtilen kanal bulunamıyor.
notFound (404) playlistNotFound İsteğin id parametresiyle tanımlanan oynatma listesi bulunamadı.
invalidValue (400) playlistOperationUnsupported API, belirtilen oynatma listesini listeleme özelliğini desteklemiyor. Örneğin, "Daha sonra izle" oynatma listenizi listeleyemezsiniz.

Deneyin.

Bu API'yi çağırmak ve API isteği ile yanıtını görmek için APIs Explorer kullanın.