Subscriptions: list

API isteği ölçütleriyle eşleşen abonelik kaynaklarını döndürür.

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

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 subscription 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, subscription kaynağında snippet özelliği, aboneliğin görünen başlığı gibi başka özellikler içerir. part=snippet değerini ayarlarsanız API yanıtı, iç içe yerleştirilmiş tüm özellikleri de içerir.

Aşağıdaki listede, parametre değerine ekleyebileceğiniz part adları vardır:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtreler (aşağıdaki parametrelerden birini tam olarak belirtin)
channelId string
channelId parametresi, bir YouTube kanal kimliği belirtir. API yalnızca bu kanalın aboneliklerini döndürür.
id string
id parametresi, alınan kaynaklara ait YouTube abonelik kimliklerinin virgülle ayrılmış listesini belirtir. subscription kaynağında id özelliği, YouTube abonelik kimliğini belirtir.
mine boolean
Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Kimliği doğrulanmış kullanıcının aboneliklerine ait bir feed almak için bu parametrenin değerini true olarak ayarlayın.
myRecentSubscribers boolean
Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Kimliği doğrulanmış kullanıcının aboneleri feed'ini ters kronolojik sırayla (önce en yeni) almak için bu parametrenin değerini true olarak ayarlayın.

Bu API üzerinden döndürülen maksimum abone sayısının sınırlı olabileceğini unutmayın.
mySubscribers boolean
Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Kimliği doğrulanmış kullanıcının aboneleri feed'ini belirli bir sırada almak için bu parametrenin değerini true olarak ayarlayın. Bu API üzerinden döndürülen maksimum abone sayısının sınırlı olabileceğini unutmayın.
İsteğe bağlı parametreler
forChannelId string
forChannelId parametresi, kanal kimliklerinin virgülle ayrılmış listesini belirtir. API yanıtı, yalnızca bu kanallarla eşleşen abonelikleri 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
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 İ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.
order string
order parametresi, API yanıtında kaynakları sıralamak için kullanılacak yöntemi belirtir. Varsayılan değer SUBSCRIPTION_ORDER_RELEVANCE.

Kabul edilen değerler şunlardır:
  • alphabetical – Alfabetik olarak sırala.
  • relevance – Alaka düzeyine göre sırala.
  • unread – Etkinlik sırasına göre sıralanı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 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#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription 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#subscriptionListResponse 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 aboneliklerin 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) accountClosed Abonenin hesabı kapalı olduğu için abonelikler alınamadı.
forbidden (403) accountSuspended Abonenin hesabı askıya alındığı için abonelikler alınamadı.
forbidden (403) subscriptionForbidden Talep edenin, istenen aboneliklere erişmesine izin verilmiyor.
notFound (404) subscriberNotFound İstekte tanımlanan abone bulunamadı.

Deneyin.

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