Muestra una lista de conversaciones que coinciden con los parámetros de solicitud de la API.
Impacto en la cuota: Una llamada a este método tiene un costo de cuota de 1 unidad.
Casos de uso habituales
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/youtube/v3/commentThreads
Parámetros
En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.
Parámetros | ||
---|---|---|
Parámetros obligatorios | ||
part |
string El parámetro part especifica una lista separada por comas de una o más propiedades de recursos de commentThread que la respuesta de API va a incluir.La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
|
|
Filtros (especifica exactamente uno de los siguientes parámetros) | ||
allThreadsRelatedToChannelId |
string El parámetro allThreadsRelatedToChannelId le indica a la API que muestre todas las conversaciones relacionadas con el canal especificado. La respuesta puede incluir comentarios sobre el canal o los videos del canal. |
|
channelId |
string El parámetro channelId le indica a la API que muestre conversaciones de comentarios sobre el canal especificado. (La respuesta no incluirá comentarios que se hayan dejado en videos que el canal subió). |
|
id |
string El parámetro id especifica una lista separada por comas de ID de conversaciones de recursos para los recursos que se deben recuperar. |
|
videoId |
string El parámetro videoId le indica a la API que muestre las conversaciones de comentarios asociadas con el ID de video especificado. |
|
Parámetros opcionales | ||
maxResults |
unsigned integer El parámetro maxResults especifica la cantidad máxima de elementos que se deben mostrar en el conjunto de resultados.Nota: Este parámetro no es compatible para usarse junto con el parámetro id . Los valores aceptables son 1 a 100 , ambos inclusive. El valor predeterminado es 20 . |
|
moderationStatus |
string Este parámetro solo se puede utilizar en una solicitud autorizada debidamente. Establece este parámetro para limitar las conversaciones de comentarios mostradas a un estado de moderación particular. Nota: Este parámetro no es compatible para usarse junto con el parámetro id . El valor predeterminado es published .Los valores aceptables son los siguientes:
|
|
order |
string El parámetro order especifica el orden en el que la respuesta de la API debe enumerar las conversaciones de comentarios. Los valores válidos son:
id .
|
|
pageToken |
string El parámetro pageToken identifica una página específica en el conjunto de resultados que se debe mostrar. En una respuesta de la API, la propiedad nextPageToken identifica la página siguiente del resultado que se puede recuperar.Nota: Este parámetro no es compatible para usarse junto con el parámetro id . |
|
searchTerms |
string El parámetro searchTerms le indica a la API que limite la respuesta de la API para que solo contenga comentarios que contengan los términos de búsqueda especificados.Nota: Este parámetro no es compatible para usarse junto con el parámetro id . |
|
textFormat |
string Establece el valor de este parámetro en html o plainText para indicarle a la API que muestre los comentarios que dejan los usuarios en formato HTML o en texto sin formato. El valor predeterminado es html .Los valores aceptables son los siguientes:
|
Cuerpo de la solicitud
No proporciones un cuerpo de solicitud cuando invoques este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{ "kind": "youtube#commentThreadListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ commentThread Resource ] }
Propiedades
La siguiente tabla define las propiedades que aparecen en este recurso:
Propiedades | |
---|---|
kind |
string Identifica el tipo de recurso de API. El valor será youtube#commentThreadListResponse . |
etag |
etag Es la Etag de este recurso. |
nextPageToken |
string Es el token que se puede usar como valor del parámetro pageToken para recuperar la página siguiente en el conjunto de resultados. |
pageInfo |
object El objeto pageInfo encapsula la información de paginación del conjunto de resultados. |
pageInfo.totalResults |
integer La cantidad total de resultados en el conjunto de resultados. |
pageInfo.resultsPerPage |
integer Es la cantidad de resultados incluidos en la respuesta de la API. |
items[] |
list Lista de conversaciones que coinciden con los criterios de la solicitud. |
Errores
En la siguiente tabla se identifican los mensajes de error que la API podría mostrar en respuesta a una llamada a este método. Consulta la documentación sobre mensajes de error para obtener más información.
Tipo de error | Detalle del error | Descripción |
---|---|---|
badRequest (400) |
operationNotSupported |
El filtro de ID solo es compatible con los comentarios basados en Google+. |
badRequest (400) |
processingFailure |
El servidor de la API no pudo procesar la solicitud correctamente. Si bien puede ser un error transitorio, por lo general, indica que la entrada de la solicitud no es válida. Verifica la estructura del recurso commentThread en el cuerpo de la solicitud para asegurarte de que sea válida. |
forbidden (403) |
commentsDisabled |
El video identificado por el parámetro videoId inhabilitó los comentarios. |
forbidden (403) |
forbidden |
No se pueden recuperar una o más de las conversaciones solicitadas debido a permisos insuficientes. Puede que la solicitud no esté debidamente autorizada. |
notFound (404) |
channelNotFound |
No se pudo encontrar el canal identificado por el parámetro channelId o allThreadsRelatedToChannelId . |
notFound (404) |
commentThreadNotFound |
No se pueden encontrar una o más de las conversaciones de comentarios especificadas. Comprueba los valores del parámetro id de la solicitud para asegurarte de que sea correcto. |
notFound (404) |
videoNotFound |
No se pudo encontrar el video identificado por el parámetro videoId . |
Pruébela.
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.