CommentThreads: list

Muestra una lista de los hilos de comentarios que coinciden con los parámetros de la solicitud a 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 del recurso commentThread que incluirá la respuesta de la API.

La siguiente lista contiene los nombres part que puedes incluir en el valor del parámetro:
  • id
  • replies
  • snippet
Filtros (especifica exactamente uno de los siguientes parámetros)
allThreadsRelatedToChannelId string
El parámetro allThreadsRelatedToChannelId le indica a la API que muestre todos los hilos de comentarios asociados con el canal especificado.
id string
El parámetro id especifica una lista separada por comas de IDs de hilos de comentarios para los recursos que se deben recuperar.
videoId string
El parámetro videoId le indica a la API que muestre los hilos de comentarios asociados 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 se admite para usar en conjunto con el parámetro id. Los valores aceptables son de 1 a 100, inclusive. El valor predeterminado es 20.
moderationStatus string
Este parámetro solo se puede usar en una solicitud debidamente autorizada. Establece este parámetro para limitar los hilos de comentarios que se muestran a un estado de moderación en particular.

Nota: Este parámetro no se admite para usar en conjunto con el parámetro id. El valor predeterminado es published.

Los valores aceptables son los siguientes:
  • heldForReview : Recupera los hilos de comentarios que están pendientes de revisión por parte de un moderador. Un hilo de comentarios se puede incluir en la respuesta si el comentario de nivel superior o al menos una de las respuestas a ese comentario están pendientes de revisión.
  • likelySpam : Recupera los hilos de comentarios clasificados como posibles spam. Un hilo de comentarios se puede incluir en la respuesta si el comentario de nivel superior o al menos una de las respuestas a ese comentario se consideran posibles spam.
  • published : Recupera los hilos de comentarios publicados. Este es el valor predeterminado. Un hilo de comentarios se puede incluir en la respuesta si se publicó su comentario de nivel superior.
order string
El parámetro order especifica el orden en el que la respuesta de la API debe mostrar los hilos de comentarios. Los valores válidos son los siguientes:
  • time : Los hilos de comentarios se ordenan por hora. Este es el comportamiento predeterminado.
  • relevance : Los hilos de comentarios se ordenan por relevancia.
Nota: Este parámetro no se admite para usar en conjunto con el parámetro 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 siguiente página del resultado que se puede recuperar.

Nota: Este parámetro no se admite para usar en conjunto 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 incluyan los términos de búsqueda especificados.

Nota: Este parámetro no se admite para usar en conjunto 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 dejaron los usuarios en formato HTML o en texto sin formato. El valor predeterminado es html.

Los valores aceptables son los siguientes:
  • html : Muestra los comentarios en formato HTML. Este es el valor predeterminado.
  • plainText : Muestra los comentarios en formato de texto sin formato.

Cuerpo de la solicitud

No proporciones un cuerpo de la solicitud cuando llames a 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 la API. El valor será youtube#commentThreadListResponse.
etag etag
Es el Etag de este recurso.
nextPageToken string
Es el token que se puede usar como el valor del parámetro pageToken para recuperar la siguiente página en el conjunto de resultados.
pageInfo object
El objeto pageInfo encapsula la información de paginación para el conjunto de resultados.
pageInfo.totalResults integer
Es 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
Es una lista de hilos de comentarios 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. Para obtener más detalles, consulta la documentación del mensaje de error.

Tipo de error Detalle del error Descripción
badRequest (400) operationNotSupported El filtro 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, suele indicar 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 tiene inhabilitados los comentarios.
forbidden (403) forbidden No se pueden recuperar uno o más de los hilos de comentarios solicitados debido a que no tienes los permisos suficientes. Puede que la solicitud no esté debidamente autorizada.
notFound (404) channelNotFound No se pudo encontrar el canal identificado por el parámetro allThreadsRelatedToChannelId.
notFound (404) commentThreadNotFound No se pueden encontrar uno o más de los hilos de comentarios especificados. Verifica los valores del parámetro id de la solicitud para asegurarte de que sean correctos.
notFound (404) videoNotFound No se pudo encontrar el video identificado por el parámetro videoId.

Pruébalo

Usa el APIs Explorer para llamar a esta API y ver la solicitud a la API y la respuesta.