CommentThreads: list

API isteği parametreleriyle eşleşen yorum dizilerinin listesini döndürür.

Kota etkisi: Bu yönteme yapılan bir ç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 alır:
  • 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ürmesini bildirir.
id string
id parametresi, alınması gereken kaynaklar için virgülle ayrılmış yorum dizisi kimlikleri listesini belirtir.
videoId string
videoId parametresi, API'ye belirtilen video kimliğiyle ilişkili yorum 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ılamaz. Kabul edilen değerler, 1 ile 100 (bu değerler dahil) arasındadır. Varsayılan değer 20'dır.
moderationStatus string
Bu parametre yalnızca uygun şekilde yetkilendirilmiş bir istekte kullanılabilir. Döndürülen yorum dizilerini belirli bir moderasyon durumuyla sınırlamak için bu parametreyi ayarlayın.

Not: Bu parametre, id parametresiyle birlikte kullanılamaz. Varsayılan değer published şeklindedir.

Kabul edilen değerler:
  • heldForReview – Moderatör tarafından incelenmeyi bekleyen yorum dizilerini alın. Üst düzey yorum veya bu yoruma verilen yanıtlardan en az biri inceleme bekliyorsa yanıta bir yorum dizisi dahil edilebilir.
  • likelySpam: Spam olabileceği şeklinde sınıflandırılan yorum dizilerini alma. Üst düzey yorumun veya bu yoruma verilen yanıtlardan en az birinin spam olma olasılığı varsa yanıta bir yorum dizisi dahil edilebilir.
  • published: Yayınlanan yorumların ileti dizilerini alma. Bu, varsayılan değerdir. Üst düzey yorumu yayınlanmışsa yorum dizisi yanıta dahil edilebilir.
order string
order parametresi, API yanıtının yorum dizilerini listelemesi gereken sırayı belirtir. Geçerli değerler:
  • time: Yorum dizileri zamana göre sıralanır. Bu, varsayılan davranıştır.
  • relevance - Yorum dizileri alaka düzeyine göre sıralanır.
Not: Bu parametre, id parametresiyle birlikte kullanılamaz.
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, alınabilecek sonuçların sonraki sayfasını tanımlar.

Not: Bu parametrenin id parametresiyle birlikte kullanılması desteklenmez.
searchTerms string
searchTerms parametresi, API'ye API yanıtını yalnızca belirtilen arama terimlerini içeren yorumlarla sınırlaması talimatını verir.

Not: Bu parametre, id parametresiyle birlikte kullanılamaz.
textFormat string
API'nin, kullanıcıların bıraktığı yorumları HTML biçiminde veya düz metin olarak döndürmesini sağlamak için bu parametrenin değerini html ya da plainText olarak ayarlayın. Varsayılan değer html şeklindedir.

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 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ümesindeki sonraki sayfayı almak için pageToken parametresinin değeri olarak kullanılabilecek jeton.
pageInfo object
pageInfo nesnesi, sonuç kümesi için sayfalama bilgilerini kapsar.
pageInfo.totalResults integer
Sonuç kümesindeki toplam sonuç sayısı.
pageInfo.resultsPerPage integer
API yanıtına dahil edilen sonuç sayısı.
items[] list
İstek ölçütleriyle eşleşen yorum dizilerinin listesi.

Hatalar

Aşağıdaki tabloda, API'nin bu yönteme yapılan bir çağrıya yanıt olarak döndürebileceği hata mesajları tanımlanmaktadır. Daha fazla bilgi için hata mesajı belgelerine bakın.

Hata türü Hata ayrıntısı Açıklama
badRequest (400) operationNotSupported id filtresi yalnızca Google+'a dayalı yorumlarla uyumludur.
badRequest (400) processingFailure API sunucusu, isteği başarıyla işleyemedi. Bu geçici bir hata olabilir ancak 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ış.
forbidden (403) forbidden İstenen yorum 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. Doğru olduğundan emin olmak için isteğin id parametresinin değerlerini kontrol edin.
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 kullanın.