Comments: list

API isteği parametreleriyle eşleşen yorumların 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/comments

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

Aşağıdaki listede, parametre değerine ekleyebileceğiniz part adları yer almaktadır:
  • id
  • snippet
Filtreler (Aşağıdaki parametrelerden tam olarak birini belirtin)
id string
id parametresi, alınan kaynakların yorum kimliklerinin virgülle ayrılmış bir listesini belirtir. comment kaynağında, id özelliği yorumun kimliğini belirtir.
parentId string
parentId parametresi, yanıtları alınacak yorumun kimliğini belirtir.

Not: YouTube şu anda yalnızca üst düzey yorumlara verilen yanıtları desteklemektedir. Ancak gelecekte yanıtların yanıtlanması desteklenebilir.
İ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.
pageToken string
pageToken parametresi, sonuç kümesinde döndürülmesi gereken belirli bir sayfayı tanımlar. API yanıtında nextPageToken özelliği, sonucun alınabilecek sonraki sayfasını tanımlar.

Not: Bu parametre, id parametresiyle birlikte kullanılamaz.
textFormat string
Bu parametre, API'nin yorumları HTML veya düz metin olarak biçimlendirilmiş şekilde döndürüp döndürmeyeceğini belirtir. Varsayılan değer html şeklindedir.

Kabul edilen değerler:
  • 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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse 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 yorumların 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ı belirtilmektedir. Daha fazla bilgi için lütfen hata mesajı belgelerine bakın.

Hata türü Hata ayrıntısı Açıklama
badRequest (400) operationNotSupported Kimlik filtresi yalnızca Google+ tabanlı yorumlarla uyumludur.
forbidden (403) forbidden Yetersiz izinler nedeniyle istenen yorumlardan biri veya daha fazlası alınamıyor. İstek düzgün şekilde yetkilendirilmemiş olabilir.
notFound (404) commentNotFound Belirtilen yorumlardan biri veya daha fazlası bulunamıyor. İsteğin id ve parentId parametrelerinin değerlerini kontrol ederek doğru olduklarından emin olun.

Deneyin.

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