Channels: list

Not: channel kaynağının statistics.subscriberCount özellik değeri, abone sayılarının gösterilme şeklini etkileyen bir YouTube politikası değişikliğini yansıtacak şekilde güncellendi. Daha fazla bilgi için lütfen Düzeltme Geçmişi'ni veya YouTube Yardım Merkezi'ni inceleyin.

İstek ölçütleriyle eşleşen sıfır veya daha fazla channel kaynağının koleksiyonunu 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/channels

Yetkilendirme

channel kaynağı için auditDetails bölümünü alan istek, https://www.googleapis.com/auth/youtubepartner-channel-audit kapsamını içeren bir yetkilendirme jetonu sağlamalıdır. Ayrıca bu kapsamı kullanan tüm jetonlar, MCN kanalı kabul etmeye veya reddetmeye karar verdiğinde ya da jetonun verildiği tarihten itibaren iki hafta içinde iptal edilmelidir.

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 channel 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 channel kaynağında contentDetails özelliği uploads özellikleri gibi başka özellikleri içerir. Bu nedenle, part=contentDetails öğesini ayarlarsanız API yanıtı, iç içe yerleştirilmiş tüm bu özellikleri de içerir.

Aşağıdaki listede, parametre değerine ekleyebileceğiniz part adları yer almaktadır:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
categoryId string
Bu parametrenin desteği sonlandırıldı. categoryId parametresi bir YouTube rehber kategorisi belirtiyordu ve bu kategoriyle ilişkilendirilmiş YouTube kanalları için istekte bulunmak için kullanılabilirdi.
forHandle string
forHandle parametresi, bir YouTube herkese açık kullanıcı adı belirleyerek bu herkese açık kullanıcı adıyla ilişkilendirilmiş kanalı ister. Parametre değerinin başına @ sembolü eklenebilir. Örneğin, "Geliştiriciler için Google" kanalının kaynağını almak üzere forHandle parametre değerini GoogleDevelopers veya @GoogleDevelopers olarak ayarlayın.
forUsername string
forUsername parametresi bir YouTube kullanıcı adını belirterek kanalın bu kullanıcı adıyla ilişkilendirilmiş olmasını ister.
id string
id parametresi, alınan kaynaklar için YouTube kanal kimliklerinin virgülle ayrılmış listesini belirtir. Bir channel kaynağında, id özelliği kanalın YouTube kanal kimliğini belirtir.
managedByMe boolean
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.

API'ye, yalnızca onBehalfOfContentOwner parametresinin belirttiği içerik sahibi tarafından yönetilen kanalları döndürecek şekilde bilgi vermek için bu parametrenin değerini true olarak ayarlayın. Kullanıcının, belirtilen içerik sahibine bağlı CMS hesabı olarak kimliği doğrulanmalıdır ve onBehalfOfContentOwner sağlanmalıdır.
mine boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. API'nin yalnızca kimliği doğrulanmış kullanıcıya ait kanalları döndürmesini sağlamak 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ı 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.
maxResults unsigned 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.
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.

İ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#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel 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#channelListResponse 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 bir önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. İlgili API isteği managedByMe parametresini true olarak ayarladıysa bu özelliğin API yanıtına dahil edilmediğini unutmayın.
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çütleriyle eşleşen kanalları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) invalidCriteria Şu filtrelerden en fazla biri belirtilebilir:id, categoryId, mine, managedByMe, forHandle, forUsername. İçerik sahibi için onBehalfOfContentOwner parametresiyle kimlik doğrulaması yapıldığında yalnızca id veya managedByMe belirtilebilir.
forbidden (403) channelForbidden id parametresiyle belirtilen kanal, isteği desteklemiyor veya istek düzgün şekilde yetkilendirilmemiş.
notFound (404) categoryNotFound categoryId parametresiyle tanımlanan kategori bulunamıyor. Geçerli değerlerin listesini almak için guideCategories.list yöntemini kullanın.
notFound (404) channelNotFound id parametresinde belirtilen kanal bulunamıyor.

Deneyin.

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