Channels: list

Not: channel kaynağının statistics.subscriberCount mülk değeri, abone sayılarının görüntülenme şeklini etkileyen bir YouTube politikası değişikliğini yansıtacak şekilde güncellendi. Daha fazla bilgi için Düzeltme Geçmişi'ne veya YouTube Yardım Merkezi'ne göz atın.

İstek ölçütleriyle eşleşen sıfır veya daha fazla channel kaynağından oluşan bir koleksiyon döndürür.

Kota etkisi: Bu yöntemin çağrısı 1 birim kota maliyetine sahiptir.

Yaygın kullanım örnekleri

İstek

HTTP isteği

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

Yetkilendirme

Bir channel kaynağının 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 tüm parametreler sorgu parametreleridir.

Parametreler
Gerekli parametreler
part string
part parametresi, API yanıtının içereceği bir veya daha fazla channel kaynak mülkünün virgül ile ayrılmış bir listesini belirtir.

Parametre, alt mülkler içeren bir mülkü tanımlarsa alt mülkler yanıta dahil edilir. Örneğin, bir channel kaynağında contentDetails mülkü, uploads mülkleri gibi diğer mülkleri içerir. Bu nedenle, part=contentDetails değerini ayarlarsanız API yanıtı bu iç içe yerleştirilmiş özelliklerin tümünü de içerir.

Aşağıdaki listede, parametre değerine dahil edebileceğ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ılmıştır. categoryId parametresi, bir YouTube kılavuzu kategorisini belirtmiştir ve bu kategoriyle ilişkili YouTube kanallarını istemek için kullanılabilir.
forHandle string
forHandle parametresi bir YouTube herkese açık kullanıcı adını belirtir ve bu kullanıcı adıyla ilişkili kanalı ister. Parametre değerinin başına @ sembolü eklenebilir. Örneğin, "Google for Developers" kanalının kaynağını almak için forHandle parametre değerini GoogleDevelopers veya @GoogleDevelopers olarak ayarlayın.
forUsername string
forUsername parametresi bir YouTube kullanıcı adını belirtir ve bu kullanıcı adıyla ilişkili kanalı ister.
id string
id parametresi, alınan kaynakların YouTube kanal kimliklerinin virgülle ayrılmış listesini belirtir. channel kaynağındaki id mülkü, kanalın YouTube kanal kimliğini belirtir.
managedByMe boolean
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.

API'ye yalnızca onBehalfOfContentOwner parametresinin belirttiği içerik sahibi tarafından yönetilen kanalları döndürmesini talimatlandırmak için bu parametrenin değerini true olarak ayarlayın. Kullanıcının kimliği, belirtilen içerik sahibine bağlı bir içerik yönetim sistemi hesabı olarak doğrulanmalı ve onBehalfOfContentOwner sağlanmalıdır.
mine boolean
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. API'ye yalnızca kimliği doğrulanmış kullanıcıya ait kanalları döndürmesini talimatlandırmak 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 dahil edilmiş 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 dilinde kaynak ayrıntılarını içerir.
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülecek maksimum öğe sayısını belirtir. Kabul edilen değerler 0 ile 50 arasıdır (bu değerler dahil). Varsayılan değer: 5.
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 içerik yönetim sistemi kullanıcısını tanımladığını gösterir. Bu parametre, birçok farklı YouTube kanalına sahip olan ve bu kanalları yöneten YouTube içerik iş ortakları için tasarlanmıştır. Bu sayede içerik sahipleri, her kanal için kimlik doğrulama kimlik bilgilerini sağlamak zorunda kalmadan tek seferde 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ğlı olmalıdır.
pageToken string
pageToken parametresi, sonuç grubunda döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken ve prevPageToken mülkleri, alınabilecek diğer sayfaları tanımlar.

İstek içeriği

Bu yöntemi çağırırken istek gövdesi sağlamaz.

Yanıt

Başarılı olursa bu yöntem aşağıdaki yapıya sahip bir yanıt metni 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 değeri.
nextPageToken string
Sonuç kümesindeki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilen jeton.
prevPageToken string
Sonuç kümesindeki önceki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilen jeton. İlgili API isteği managedByMe parametresini true olarak ayarlarsa bu özelliğin API yanıtına dahil edilmediğini unutmayın.
pageInfo object
pageInfo nesnesi, sonuç kümesinin sayfa oluşturma bilgilerini kapsar.
pageInfo.totalResults integer
Sonuç kümesindeki toplam sonuç sayısı.
pageInfo.resultsPerPage integer
API yanıtına dahil edilen sonuç 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 bir çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için YouTube Data API - Errors başlıklı makaleyi inceleyin.

Hata türü Hata ayrıntısı Açıklama
badRequest (400) invalidCriteria Aşağıdaki filtrelerden en fazla biri belirtilebilir:id, categoryId, mine, managedByMe, forHandle, forUsername. onBehalfOfContentOwner parametresi aracılığıyla içerik sahibi kimlik doğrulaması yapılması durumunda yalnızca id veya managedByMe belirtilebilir.
forbidden (403) channelForbidden id parametresi tarafından belirtilen kanal isteği desteklemiyor veya istek düzgün bir şekilde yetkilendirilmemiş.
notFound (404) categoryNotFound categoryId parametresi tarafından 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 simgesini kullanın.