CommentThreads: list

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

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

Aşağıdaki listede parametre değerine ekleyebileceğiniz part adları yer almaktadır:
  • id
  • replies
  • snippet
Filtreler (aşağıdaki parametrelerden birini tam olarak belirtin)
allThreadsRelatedToChannelId string
allThreadsRelatedToChannelId parametresi, API'ye belirtilen kanalla ilişkili tüm yorum ileti dizilerini döndürmesini bildirir. Yanıt, kanal veya kanalın videolarıyla ilgili yorumları içerebilir.
channelId string
channelId parametresi, API'ye belirtilen kanalla ilgili yorumları içeren yorum ileti dizilerini döndürmesini bildirir. (Yanıt, kanalın yüklediği videolara bırakılan yorumları içermez.)
id string
id parametresi, alınması gereken kaynakların 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ürmesini bildirir.
İ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ılmak üzere desteklenmez. Kabul edilebilir değerler 1 ile 100 arasındadır (bu değerler dahil). Varsayılan değer: 20
moderationStatus string
Bu parametre yalnızca uygun bir yetkili istekte kullanılabilir. Döndürülen yorum ileti dizilerini belirli bir moderasyon durumuyla sınırlamak için bu parametreyi ayarlayın.

Not: Bu parametre, id parametresiyle birlikte kullanılmak üzere desteklenmez. Varsayılan değer published.

Kabul edilen değerler şunlardır:
  • heldForReview – Moderatör tarafından incelenmeyi bekleyen yorum ileti dizilerini alın. Üst düzey yorum veya o yoruma verilen yanıtlardan en az biri incelenmeyi bekliyorsa yanıta bir yorum ileti dizisi eklenebilir.
  • likelySpam – Spam olabilecek olarak sınıflandırılan yorum ileti dizilerini alın. Üst düzey yorum veya o yoruma verilen yanıtlardan en az birinin spam olduğu düşünülürse yoruma bir yorum dizisi eklenebilir.
  • published – Yayınlanan yorumların ileti dizilerini alır. Bu, varsayılan değerdir. En üst düzey yorumu yayınlanmışsa yorum ileti dizisi yanıta eklenebilir.
order string
order parametresi, API yanıtının yorum ileti dizilerini listeleme sırasını 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. Bir API yanıtında nextPageToken özelliği, getirilebilecek sonucun sonraki sayfasını tanımlar.

Not: Bu parametre, id parametresiyle birlikte kullanılmak üzere desteklenmez.
searchTerms string
searchTerms parametresi, API'ye API yanıtını yalnızca belirtilen arama terimlerini içeren yorumları içerecek şekilde sınırlandırması talimatı verir.

Not: Bu parametre, id parametresiyle birlikte kullanılmak üzere desteklenmez.
textFormat string
Bu parametrenin değerini html veya plainText olarak ayarlayarak API'ye, kullanıcıların html biçiminde veya düz metin olarak bıraktığı yorumları döndürmesini sağlayın. Varsayılan değer html.

Kabul edilen 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 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#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 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.
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 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 ayrıntı için lütfen hata mesajı dokümanlarını inceleyin.

Hata türü Hata ayrıntısı Açıklama
badRequest (400) operationNotSupported Kimlik filtresi yalnızca Google+'yı temel alan yorumlarla uyumludur.
badRequest (400) processingFailure API sunucusu isteği başarıyla işleyemedi. Bu geçici bir hata olsa da genellikle isteğin girişinin geçersiz olduğunu gösterir. İstek gövdesindeki commentThread kaynağının yapısını kontrol ederek geçerli olduğundan emin olun.
forbidden (403) commentsDisabled videoId parametresiyle tanımlanan videoda yorumlar devre dışı bırakılmıştır.
forbidden (403) forbidden İstenen izinler nedeniyle bir veya daha fazla yorum dizisi alınamıyor. İstek düzgün bir şekilde yetkilendirilmemiş olabilir.
notFound (404) channelNotFound channelId veya allThreadsRelatedToChannelId parametresiyle tanımlanan kanal bulunamadı.
notFound (404) commentThreadNotFound Belirtilen yorum dizilerinden bir veya daha fazlası bulunamıyor. İsteğin id parametresinin değerlerini kontrol ederek doğruluğundan emin olun.
notFound (404) videoNotFound videoId parametresiyle tanımlanan video 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.