CommentThreads: list

API istek parametreleriyle eşleşen yorum ileti dizilerinin listesini 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/commentThreads

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 commentThread kaynak özelliğinin virgülle ayrılmış listesini belirtir.

Aşağıdaki liste, parametre değerine ekleyebileceğiniz part adlarını içerir:
  • id
  • replies
  • snippet
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin)
allThreadsRelatedToChannelId string
allThreadsRelatedToChannelId parametresi, API'ye belirtilen kanalla ilişkili tüm yorum dizilerini döndürmesi talimatını verir.
id string
id parametresi, alınması gereken kaynaklar için yorum ileti dizisi kimliklerinin virgülle ayrılmış listesini belirtir.
videoId string
videoId parametresi, API'ye belirtilen video kimliğiyle ilişkili yorum ileti dizilerini döndürme talimatı verir.
İsteğe bağlı parametreler
maxResults unsigned integer
maxResults parametresi, sonuç kümesinde döndürülmesi gereken maksimum öğe sayısını belirtir.

Not: Bu parametre, id parametresiyle birlikte kullanılması desteklenmez. Kabul edilebilir değerler 1 ile 100 arasındadır (bu değerler dahil). Varsayılan değer 20 değeridir.
moderationStatus string
Bu parametre yalnızca doğru şekilde yetkilendirilmiş bir istekte kullanılabilir. Döndürülen yorum ileti dizilerini belirli bir denetleme durumuyla sınırlandırmak için bu parametreyi ayarlayın.

Not: Bu parametrenin id parametresiyle birlikte kullanılması desteklenmez. Varsayılan değer published değeridir.

Kabul edilebilir değerler şunlardır:
  • heldForReview – Moderatör tarafından incelenmeyi bekleyen yorum ileti dizilerini alın. Üst düzey yorum veya bir yoruma verilen yanıtlardan en az biri incelenmeyi bekliyorsa yoruma bir yorum dizisi eklenebilir.
  • likelySpam – Spam olabilecek şekilde sınıflandırılan yorum ileti dizilerini alın. En üst düzey yorumun veya bir yoruma verilen yanıtlardan en az birinin spam olma olasılığı varsa yanıta bir yorum ileti dizisi eklenebilir.
  • published – Yayınlanan yorumların ileti dizilerini alın. Bu, varsayılan değerdir. Bir yorum ileti dizisinin üst düzey yorumu yayınlanmışsa yanıta dahil edilebilir.
order string
order parametresi, API yanıtının yorum ileti dizilerini listelemesi gereken sırayı belirtir. Geçerli değerler şunlardır:
  • time - Yorum ileti dizileri zamana göre sıralanır. Bu, varsayılan davranıştır.
  • relevance - Yorum ileti dizileri alaka düzeyine göre sıralanır.
Not: Bu parametrenin id parametresiyle birlikte kullanılması desteklenmez.
pageToken string
pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken özelliği, alınabilecek sonuçtaki sonraki sayfayı tanımlar.

Not: Bu parametrenin id parametresiyle birlikte kullanımı desteklenmez.
searchTerms string
searchTerms parametresi, API'ye API yanıtını yalnızca belirtilen arama terimlerini içeren yorumları içerecek şekilde sınırlamasını bildirir.

Not: Bu parametrenin id parametresiyle birlikte kullanılması desteklenmez.
textFormat string
API'ye kullanıcıların bıraktığı yorumları HTML biçiminde veya düz metin olarak döndürmesi talimatını vermek için bu parametrenin değerini html veya plainText olarak ayarlayın. Varsayılan değer html değeridir.

Kabul edilebilir değerler şunlardır:
  • html – Yorumları HTML biçiminde döndürür. Bu, varsayılan değerdir.
  • plainText – Yorumları düz metin biçiminde döndürür.

İstek içeriği

Bu yöntemi çağırırken istek metni 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#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread 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#commentThreadListResponse 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 yorum ileti dizilerinin 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 hata mesajı dokümanlarına göz atın.

Hata türü Hata ayrıntısı Açıklama
badRequest (400) operationNotSupported id filtresi yalnızca Google+'daki yorumlarla uyumludur.
badRequest (400) processingFailure API sunucusu, isteği başarıyla işleyemedi. Bu geçici bir hata olabileceği gibi, genellikle istek girişinin geçersiz olduğunu gösterir. Geçerli olduğundan emin olmak için istek gövdesindeki commentThread kaynağının yapısını kontrol edin.
forbidden (403) commentsDisabled videoId parametresiyle tanımlanan videoda yorumlar devre dışı bırakıldı.
forbidden (403) forbidden İstenen yorum ileti dizilerinden biri veya daha fazlası, yetersiz izinler nedeniyle alınamıyor. İstek düzgün şekilde yetkilendirilmemiş olabilir.
notFound (404) channelNotFound allThreadsRelatedToChannelId parametresiyle tanımlanan kanal bulunamadı.
notFound (404) commentThreadNotFound Belirtilen yorum dizilerinden biri veya daha fazlası bulunamıyor. İsteğin id parametresinin değerlerini kontrol ederek doğru olduğundan emin olun.
notFound (404) videoNotFound videoId parametresiyle tanımlanan video bulunamadı.

Deneyin.

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