Sponsors: list

Not: Bu yöntem 31 Mart 2020 itibarıyla kullanımdan kaldırılmıştır. Bu parametre, members.list yöntemiyle değiştirildi. Bu yöntemle ilgili bilgileri YouTube Data API belgelerinde bulabilirsiniz.

sponsors.list yöntemi, 30 Eylül 2020'de veya sonrasında artık desteklenmeyecektir. API istemcileri, bunun yerine members.list yöntemini kullanmak için sponsors.list yöntemine yapılan çağrıları güncellemelidir.

Bir kanalın üyelerini (önceki adıyla "sponsorlar") listeler. API isteği, kanal sahibi tarafından yetkilendirilmelidir.

Yaygın kullanım alanları

İstek

HTTP isteği

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

Yetkilendirme

Bu istek için aşağıdaki kapsamlardan en az biriyle yetkilendirme gerekir (kimlik doğrulama ve yetkilendirme hakkında daha fazla bilgi edinin).

Kapsam
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

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 sponsor kaynak parçalarını belirtir. id ve snippet değerleri desteklenir.
İsteğe bağlı parametreler
filter string
filter parametresi, hangi kanal sponsorlarının döndürüleceğini belirtir. Varsayılan değer newest değeridir.

Kabul edilebilir değerler şunlardır:
  • all – En yeniden en eskiye doğru tüm sponsorları döndürür.
  • newest – En son sponsorların bir sayfasını döndürür. nextPageToken kullanılarak gönderilen sonraki istekler, kaydolan yeni aboneleri alır.
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.
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#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor 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#sponsorListResponse 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.
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 sponsorları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
forbidden (403) insufficientPermissions Kanalın sponsorlarını görüntülemek için gerekli izinlere sahip değilsiniz.
invalidValue (400) invalidValueInRequest İstek geçersiz bir değer içeriyor.
invalidValue (400) sponsorshipNotEnabledForChannelId Kanalda sponsorluklar etkinleştirilmemiş.

Deneyin.

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