API isteği parametreleriyle eşleşen yorumların 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/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:
|
|
Filtreler (aşağıdaki parametrelerden birini tam olarak belirtin) | ||
id |
string id parametresi, alınan kaynaklara ait yorum kimliklerinin virgülle ayrılmış listesini belirtir. 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, gelecekte bu yanıtlara verilen yanıtlar 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ılmak üzere desteklenmez. Kabul edilebilir değerler 1 ile 100 arasındadır (bu değerler dahil). Varsayılan değer: 20 |
|
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. |
|
textFormat |
string Bu parametre, API'nin HTML olarak mı yoksa düz metin olarak mı yorum vereceğini belirtir. Varsayılan değer html .Kabul edilen değerler şunlardı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#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ü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 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 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. |
forbidden (403) |
forbidden |
İstenen yorumlardan biri veya daha fazlası yetersiz izinler nedeniyle alınamıyor. İstek düzgün bir şekilde yetkilendirilmemiş olabilir. |
notFound (404) |
commentNotFound |
Belirtilen yorumlardan bir 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ği ile yanıtını görmek için APIs Explorer özelliğini kullanın.