API istek parametreleriyle eşleşen yorumların 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/comments
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 comment kaynak özelliğinin virgülle ayrılmış listesini belirtir.Aşağıdaki liste, parametre değerine ekleyebileceğiniz part adlarını içerir:
|
|
Filtreler (aşağıdaki parametrelerden tam olarak birini belirtin) | ||
id |
string id parametresi, alınan kaynaklar için yorum kimliklerinin virgülle ayrılmış listesini belirtir. Bir comment kaynağında, id özelliği yorumun kimliğini belirtir. |
|
parentId |
string parentId parametresi, yanıtların alınması gereken yorumun kimliğini belirtir. Not: YouTube şu anda yalnızca üst düzey yorumlara verilen yanıtları desteklemektedir. Ancak yanıtlara yanıt verme özelliği gelecekte 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ılması desteklenmez. Kabul edilebilir değerler 1 ile 100 arasındadır (bu değerler dahil). Varsayılan değer 20 değeridir. |
|
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. |
|
textFormat |
string Bu parametre, API'nin HTML olarak mı yoksa düz metin olarak mı biçimlendirilmiş yorumları döndürmesi gerektiğini ifade eder. Varsayılan değer html değeridir.Kabul edilebilir değerler şunlardır:
|
İstek içeriği
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 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 yorumların 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 lütfen hata mesajı dokümanlarına bakın.
Hata türü | Hata ayrıntısı | Açıklama |
---|---|---|
badRequest (400) |
operationNotSupported |
Kimlik filtresi yalnızca Google+'daki yorumlarla uyumludur. |
forbidden (403) |
forbidden |
İstenen yorumlardan biri veya daha fazlası yetersiz izinler nedeniyle 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 kullanın.