Bir kanalın üyelerini (eski adıyla "sponsorlar") listeler. API isteği, kanal sahibi tarafından yetkilendirilmelidir.
Kota etkisi: Bu yönteme yapılan çağrının kota maliyeti 2 birimdir.
İ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 tüm parametreler 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 belirtir. Parametre değerini aşağıdaki değerlerden birine ayarlayın:
|
|
maxResults |
unsigned integer maxResults parametresi, sonuç grubunda 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 |
|
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 özgüdür. Bu nedenle, 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 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#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 olacak. |
etag |
etag Bu kaynağın Etag'i. |
nextPageToken |
string Sonuç kümesindeki bir sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton. Sayfa jetonlarının süresi dolabilir ve uygulamanız, yeni bir istek başlatmak için jetonu bırakıp pageToken olmadan API'yi çağırmalıdır. |
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 ü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 ayrıntı için lütfen hata mesajı dokümanlarını inceleyin.
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 belirtiyorsa bu hata oluşabilir. |
badRequest (400) |
invalidPageToken |
pageToken parametre değeri geçersiz. İstekte kullanılan sayfa jetonunun süresi dolduysa veya tanınmazsa bu hata meydana gelebilir. |
badRequest (400) |
invalidHasAccessToLevel |
hasAccessToLevel parametre değeri geçersiz. Belirtilen id düzeyi yok. |
badRequest (400) |
invalidFilterByMemberChannelId |
filterByMemberChannelId parametre değeri geçersiz. Bu hata, filterByMemberChannelId parametre değeri 100'den fazla kanal belirtiyorsa ortaya çıkar. |