Playlists: list

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

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/playlists

Parametreler

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

Parametreler
Gerekli parametreler
partstring
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 mülkler 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:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
channelIdstring
Bu değer, API'nin yalnızca belirtilen kanalın oynatma listelerini döndürmesi gerektiğini ifade eder.
idstring
id parametresi, alınan kaynaklar için YouTube oynatma listesi kimliklerinin virgülle ayrılmış listesini belirtir. Bir playlist kaynağında id özelliği, oynatma listesinin YouTube oynatma listesi kimliğini belirtir.
mineboolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. API'nin yalnızca kimliği doğrulanmış kullanıcıya ait oynatma listelerini döndürmesini sağlamak için bu parametrenin değerini true olarak ayarlayın.
İsteğe bağlı parametreler
hlstring
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.
maxResultsunsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir. Kabul edilebilir değerler 0 ile 50 arasındadır (bu değerler dahil). Varsayılan değer 5 değeridir.
onBehalfOfContentOwnerstring
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.
onBehalfOfContentOwnerChannelstring
Bu parametre yalnızca doğru ş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 istek onBehalfOfContentOwner parametresi için bir değer belirttiğinde zorunludur ve yalnızca bu parametreyle birlikte kullanılabilir. Ayrıca istek, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İYS hesabı kullanılarak yetkilendirilmelidir. Son olarak, onBehalfOfContentOwnerChannel parametre değerinin belirttiği kanal, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlanmalıdır.

Bu parametre, birçok farklı YouTube kanalına sahip olan ve bunları yöneten YouTube içerik iş ortakları içindir. İçerik sahiplerinin, bir kez kimlik doğrulaması yaparak parametre değerinde belirtilen kanal adına her ayrı kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan işlem gerçekleştirmesine olanak tanır.
pageTokenstring
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.

İ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#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
kindstring
API kaynağının türünü tanımlar. Değer youtube#playlistListResponse olur.
etagetag
Bu kaynağın Etag'i.
nextPageTokenstring
Sonuç grubundaki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
prevPageTokenstring
Sonuç grubundaki önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
pageInfoobject
pageInfo nesnesi, sonuç kümesiyle ilgili sayfalama bilgilerini içerir.
pageInfo.totalResultsinteger
Sonuç kümesindeki toplam sonuç sayısı.
pageInfo.resultsPerPageinteger
API yanıtına dahil edilen sonuçların sayısı.
items[]list
İstek ölçütlerine uyan oynatma listelerinin 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
forbidden (403)channelClosedchannelId parametresinde belirtilen kanal kapatıldı.
forbidden (403)channelSuspendedchannelId 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)channelNotFoundchannelId parametresinde belirtilen kanal bulunamıyor.
notFound (404)playlistNotFoundİsteğin id parametresiyle tanımlanan oynatma listesi bulunamıyor.
invalidValue (400)playlistOperationUnsupportedAPI, belirtilen oynatma listesini listeleme özelliğini desteklemiyor. Örneğin, daha sonra izle oynatma listenizi listeleyemezsiniz.

Deneyin.

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