Members: list

Not: Bu uç nokta, yalnızca içerik üreticiler tarafından kanal üyeliklerinin etkin olduğu kendi YouTube kanalları için istekte bulunmak amacıyla kullanılabilir. Erişim istemek için Google veya YouTube temsilcinizle iletişime geçin.

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

Kota etkisi: Bu yönteme yapılan bir çağrının 2 birimlik kota maliyeti olur.

İstek

HTTP isteği

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

Yetkilendirme

Bu istek, aşağıdaki kapsamla yetkilendirme gerektiriyor:

Kapsam
https://www.googleapis.com/auth/youtube.channel-memberships.creator

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 member kaynak özelliklerini belirtir. Parametre değerini snippet olarak ayarlayın.
İsteğe bağlı parametreler
mode string
mode parametresi, API yanıtına hangi üyelerin dahil edileceğini gösterir. Parametre değerini aşağıdaki değerlerden birine ayarlayın:
  • all_current (varsayılan) - Mevcut üyeleri en yeniden en eskiye doğru listeler. Bu değer kullanıldığında, API yanıtı bir nextPageToken içermediğinde listenin sonuna ulaşılır.
  • updates: Yalnızca önceki API çağrısından bu yana katılan veya yükseltilmiş üyeleri listeleyin. İlk görüşmenin yeni bir güncelleme akışı başlatacağını, ancak gerçekte herhangi bir üye döndürmeyeceğini unutmayın. Üyelik güncellemelerini almaya başlamak için nextPageToken işlevini kullanarak istediğiniz sıklıkta uç noktayı sorgulamanız gerekir.

    Bu değer kullanıldığında API yanıtının her zaman bir nextPageToken içerdiğini unutmayın.
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 1000 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. Jeton, orijinal API isteğiyle kullanılan mode öğesine özel olduğundan bir modla alınan sayfa jetonunu daha sonra farklı bir moda geçmek için kullanamazsınız.
hasAccessToLevel string
hasAccessToLevel parametre değeri, sonuç grubundaki üyelerin sahip olması gereken minimum düzeyi belirten seviye kimliğidir.
filterByMemberChannelId string
filterByMemberChannelId parametresi, belirli kullanıcıların üyelik durumunu kontrol etmek için kullanılabilecek kanal kimliklerinin virgülle ayrılmış listesini belirtir. Örneğin, UC_1,UC_2,UC_3. Arama başına en fazla 100 kanal belirtilebilir.

İ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#memberListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    member 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#memberListResponse 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. Sayfa jetonlarının süresi dolabilir. Uygulamanızın, yeni bir istek başlatmak için jetonu bırakması ve pageToken olmadan API'yi çağırması gerekir.
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çütlerine uyan üyelerin 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) channelMembershipsNotEnabled İsteği yetkilendiren içerik üretici kanalında kanal üyelikleri etkinleştirilmemiş.
badRequest (400) invalidMode mode parametre değeri geçersiz. pageToken parametresi, belirtilenden farklı bir mod kullanılarak alınan bir jetonu belirtirse bu hata oluşabilir.
badRequest (400) invalidPageToken pageToken parametre değeri geçersiz. Bu hata, istekte kullanılan sayfa jetonunun süresi dolduysa veya tanınmıyorsa ortaya çıkabilir.
badRequest (400) invalidHasAccessToLevel hasAccessToLevel parametre değeri geçersiz. Belirtilen id ile bir seviye yok.
badRequest (400) invalidFilterByMemberChannelId filterByMemberChannelId parametre değeri geçersiz. Bu hata, filterByMemberChannelId parametre değeri 100'den fazla kanal belirtiyorsa ortaya çıkar.