Data API'yi, YouTube'un Shorts görüntülemelerini sayma şekliyle eşleşecek şekilde güncelliyoruz.
Daha fazla bilgi
Comments: list
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
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:
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 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 |
Deneyin.
Bu API'yi çağırmak ve API isteğini ve yanıtını görmek için APIs Explorer kullanın.
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2024-04-26 UTC.
[null,null,["Son güncelleme tarihi: 2024-04-26 UTC."],[],[],null,["# Comments: list\n\nReturns a list of comments that match the API request parameters.\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 1 unit.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/comments\n```\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies a comma-separated list of one or more `comment` resource properties that the API response will include. The following list contains the `part` names that you can include in the parameter value: - `id` - `snippet` |\n| **Filters (specify exactly one of the following parameters)** |||\n| `id` | `string` The **id** parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a `comment` resource, the `id` property specifies the comment's ID. |\n| `parentId` | `string` The **parentId** parameter specifies the ID of the comment for which replies should be retrieved. **Note:** YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future. |\n| **Optional parameters** |||\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. **Note:** This parameter is not supported for use in conjunction with the [id](#id) parameter. Acceptable values are `1` to `100`, inclusive. The default value is `20`. |\n| `pageToken` | `string` The **pageToken** parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies the next page of the result that can be retrieved. **Note:** This parameter is not supported for use in conjunction with the [id](#id) parameter. |\n| `textFormat` | `string` This parameter indicates whether the API should return comments formatted as HTML or as plain text. The default value is `html`. Acceptable values are: - **html** -- Returns the comments in HTML format. This is the default value. - **plainText** -- Returns the comments in plain text format. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#commentListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n comment Resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#commentListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of comments that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|--------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `badRequest (400)` | `operationNotSupported` | The id filter is only compatible with comments based on Google+. |\n| `forbidden (403)` | `forbidden` | One or more of the requested comments cannot be retrieved due to insufficient permissions. The request might not be properly authorized. |\n| `notFound (404)` | `commentNotFound` | One or more of the specified comments cannot be found. Check the values of the request's [id](/youtube/v3/docs/comments/list#id) and [parentId](/youtube/v3/docs/comments/list#parentId) parameters to ensure that they are correct. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]