Subscriptions: list

API isteği ölçütleriyle eşleşen abonelik kaynaklarını 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/subscriptions

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 subscription 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 subscription kaynağında snippet özelliği, aboneliğin görünen başlığı gibi başka özellikleri içerir. part=snippet öğ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:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
channelId string
channelId parametresi bir YouTube kanal kimliğini belirtir. API yalnızca bu kanalın aboneliklerini döndürür.
id string
id parametresi, alınan kaynaklar için YouTube abonelik kimliklerinin virgülle ayrılmış listesini belirtir. Bir subscription kaynağında, id özelliği YouTube abonelik kimliğini belirtir.
mine boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Kimliği doğrulanmış kullanıcının aboneliklerinin feed'ini almak için bu parametrenin değerini true olarak ayarlayın.
myRecentSubscribers boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Kimliği doğrulanmış kullanıcının abonelerinin feed'ini ters kronolojik sırada (önce en yeni) almak için bu parametrenin değerini true olarak ayarlayın.

Bu API aracılığıyla döndürülen maksimum abone sayısının sınırlı olabileceğini unutmayın.
mySubscribers boolean
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Kimliği doğrulanmış kullanıcının abonelerinin feed'ini belirli bir sıra olmadan almak için bu parametrenin değerini true olarak ayarlayın. Bu API aracılığıyla 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ç 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
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.
onBehalfOfContentOwnerChannel string
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.

onBehalfOfContentOwnerChannel parametresi, videonun eklendiği kanalın YouTube kanal kimliğini belirtir. Bu parametre, bir istek onBehalfOfContentOwner parametresi için bir değer belirttiğinde zorunludur ve yalnızca bu parametreyle birlikte kullanılabilir. Ayrıca istek, onBehalfOfContentOwner parametresinin belirttiği içerik sahibine bağlı bir İYS hesabı kullanılarak yetkilendirilmelidir. 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ına sahip olan ve bunları yöneten YouTube içerik iş ortakları içindir. İçerik sahiplerinin, bir kez kimlik doğrulaması yaparak parametre değerinde belirtilen kanal adına her ayrı kanal için kimlik doğrulama bilgileri sağlamak zorunda kalmadan işlem gerçekleştirmesine olanak tanır.
order string
order parametresi, API yanıtındaki kaynakları sıralamak için kullanılacak yöntemi belirtir. Varsayılan değer SUBSCRIPTION_ORDER_RELEVANCE değeridir.

Kabul edilebilir değerler şunlardır:
  • alphabetical: Alfabetik olarak sıralar.
  • relevance – Alaka düzeyine göre sıralayın.
  • unread – Etkinlik sırasına göre sıralayın.
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#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 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 önceki 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 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 bilgi için lütfen hata mesajı dokümanlarına bakın.

Hata türü Hata ayrıntısı Açıklama
forbidden (403) accountClosed Abonenin hesabı kapalı olduğundan abonelikler alınamadı.
forbidden (403) accountSuspended Abonenin hesabı askıya alındığı için abonelikler alınamadı.
forbidden (403) subscriptionForbidden İstek sahibinin, istenen aboneliklere erişmesine izin verilmiyor.
notFound (404) subscriberNotFound İstekle tanımlanan abone bulunamıyor.

Deneyin.

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