Stiamo aggiornando l'API Data in modo che corrisponda al modo in cui YouTube conteggia le visualizzazioni di Shorts.
Scopri di più
Comments: list
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Restituisce un elenco di commenti che corrispondono ai parametri della richiesta API.
Impatto della quota: una chiamata a questo metodo ha un costo della quota di 1 unità.
Casi d'uso comuni
Richiesta
Richiesta HTTP
GET https://www.googleapis.com/youtube/v3/comments
Parametri
La tabella seguente elenca i parametri supportati da questa query. Tutti i parametri elencati sono parametri di query.
| Parametri |
| Parametri obbligatori |
part |
string
Il parametro part specifica un elenco separato da virgole di una o più proprietà delle risorse comment che verranno incluse nella risposta dell'API.
Il seguente elenco contiene i part nomi che puoi includere nel valore del parametro:
|
| Filtri (specificare esattamente uno dei seguenti parametri) |
id |
string
Il parametro id specifica un elenco separato da virgole di ID commento per le risorse recuperate. In una risorsa comment, la proprietà id specifica l'ID del commento. |
parentId |
string
Il parametro parentId specifica l'ID del commento per il quale devono essere recuperate le risposte.
Nota: YouTube al momento supporta le risposte solo per i commenti di primo livello. Tuttavia, le risposte alle risposte potrebbero essere supportate in futuro. |
| Parametri facoltativi |
maxResults |
unsigned integer
Il parametro maxResults specifica il numero massimo di elementi da restituire nel set di risultati.
Nota: l'uso di questo parametro non è supportato in combinazione con il parametro id. I valori accettati sono compresi tra 1 e 100. Il valore predefinito è 20. |
pageToken |
string
Il parametro pageToken identifica una pagina specifica da restituire del set di risultati. In una risposta dell'API, la proprietà nextPageToken identifica la pagina successiva del risultato recuperabile.
Nota: l'uso di questo parametro non è supportato in combinazione con il parametro id. |
textFormat |
string
Questo parametro indica se l'API deve restituire commenti formattati come HTML o come testo normale. Il valore predefinito è html.
I valori accettati sono:
html: restituisce i commenti in formato HTML. Questo è il valore predefinito.plainText: restituisce i commenti in formato di testo normale.
|
Corpo della richiesta
Non fornire il corpo della richiesta quando chiami questo metodo.
Risposta
Se l'esito è positivo, questo metodo restituisce un corpo della risposta con la seguente struttura:
{
"kind": "youtube#commentListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
comment Resource
]
}
Proprietà
La tabella seguente definisce le proprietà visualizzate in questa risorsa:
| Proprietà |
kind |
string
Identifica il tipo di risorsa API. Il valore sarà youtube#commentListResponse. |
etag |
etag
L'Etag di questa risorsa. |
nextPageToken |
string
Il token che può essere utilizzato come valore del parametro pageToken per recuperare la pagina successiva nel set di risultati. |
pageInfo |
object
L'oggetto pageInfo incapsula le informazioni sul paging per il set di risultati. |
pageInfo.totalResults |
integer
Il numero totale di risultati nel set di risultati. |
pageInfo.resultsPerPage |
integer
Il numero di risultati inclusi nella risposta dell'API. |
items[] |
list
Un elenco di commenti che corrispondono ai criteri della richiesta. |
Errori
La tabella seguente identifica i messaggi di errore che l'API potrebbe restituire in risposta a una chiamata a questo metodo. Per ulteriori dettagli, consulta la documentazione relativa ai messaggi di errore.
| Tipo di errore |
Dettagli errore |
Descrizione |
Prova.
Usa APIs Explorer per chiamare questa API e visualizzare la richiesta e la risposta dell'API.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-04-26 UTC.
[null,null,["Ultimo aggiornamento 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."]]
