API isteği parametreleriyle eşleşen oynatma listelerinden oluşan bir koleksiyon 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 veya daha fazla oynatma listesi alabilirsiniz.
Kota etkisi: Bu yönteme yapılan ç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 mülkünün virgülle ayrılmış listesini belirtir.Parametre, alt özellikler içeren bir özellik tanımlarsa alt özellikler de yanıta dahil edilir. Örneğin, playlist kaynağında snippet özelliği author , title , description ve timeCreated gibi özellikler içerir. Bu nedenle, part=snippet değerini ayarlarsanız API yanıtı tüm bu özellikleri içerir.Aşağıdaki listede parametre değerine ekleyebileceğiniz part adları bulunmaktadır:
|
|
Filtreler (aşağıdaki parametrelerden birini tam olarak belirtin) | ||
channelId |
string Bu değer, API'nin yalnızca belirtilen kanalın oynatma listelerini döndürmesi gerektiğini gösterir. |
|
id |
string id parametresi, alınan kaynaklara ait 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 uygun bir yetkili istekte kullanılabilir. API'ye yalnızca kimliği doğrulanmış kullanıcıya ait oynatma listelerini döndürmesi 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 almasını bildirir. Parametre değeri, i18nLanguages.list yöntemi tarafından döndürülen listeye dahil edilen 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 yoksa snippet.localized nesnesi, kaynağın varsayılan dilinde kaynak ayrıntılarını içerir. |
|
maxResults |
unsigned integer maxResults parametresi, sonuç grubunda 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 |
|
onBehalfOfContentOwner |
string Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları içindir. onBehalfOfContentOwner parametresi, isteğin yetkilendirme kimlik bilgilerinin, parametre değerinde belirtilen içerik sahibi adına hareket eden bir YouTube İYS kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalının sahibi ve yöneticisi olan YouTube içerik iş ortakları için tasarlanmıştır. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan bir kez kimlik doğrulaması yapabilir ve tüm video ve kanal verilerine erişebilir. Kullanıcının kimlik doğrulaması yaptığı İYS hesabı, belirtilen YouTube içerik sahibine bağlanmalıdır. |
|
onBehalfOfContentOwnerChannel |
string Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Not: Bu parametre yalnızca YouTube içerik iş ortakları içindir. onBehalfOfContentOwnerChannel parametresi, bir videonun eklendiği kanalın YouTube kanal kimliğini belirtir. Bu parametre, bir istek onBehalfOfContentOwner parametresi için bir değer belirttiğinde gereklidir ve yalnızca bu parametreyle birlikte kullanılabilir. Buna ek olarak, isteğin onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İYS hesabı kullanılarak yetkilendirilmesi gerekir. 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ının sahibi ve yöneticisi olan YouTube içerik iş ortakları için tasarlanmıştır. Bu özellik, içerik sahiplerinin her bir kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan, parametre değerinde belirtilen kanal adına bir kez kimlik doğrulaması yapmasını ve işlem gerçekleştirmesini sağlar. |
|
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. |
İstek metni
Bu yöntemi çağırırken bir 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 olacak. |
etag |
etag Bu kaynağın Etag'i. |
nextPageToken |
string Sonuç kümesinde 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ç grubunun sayfa oluşturma 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çütleriyle eşleşen 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 ayrıntı için lütfen hata mesajı dokümanlarını inceleyin.
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 isteğin düzgün yetkilendirmesi yok. |
notFound (404) |
channelNotFound |
channelId parametresinde belirtilen kanal bulunamıyor. |
notFound (404) |
playlistNotFound |
İsteğin id parametresiyle tanımlanan oynatma listesi bulunamıyor. |
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 özelliğini kullanın.