CommentThreads: list

Devuelve una lista de subprocesos de comentarios que coinciden con los parámetros de solicitud de la API.

Impacto de 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 commentThread que la respuesta de la API incluirá.

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 subprocesos de comentarios asociados con el canal especificado.
id string
El parámetro id especifica una lista separada por comas de IDs de conversaciones de comentarios para los recursos que se deben recuperar.
videoId string
El parámetro videoId le indica a la API que muestre 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 se admite para su uso junto con el parámetro id. Los valores aceptables son 1 a 100, ambos inclusive. El valor predeterminado es20.
moderationStatus string
Este parámetro solo se puede usar en una solicitud autorizada debidamente. Establece este parámetro para limitar las conversaciones de comentarios que se muestran a un estado de moderación determinado.

Nota: No se admite este parámetro junto con el parámetro id. El valor predeterminado es published.

Los valores aceptables son los siguientes:
  • heldForReview: recupera las conversaciones de comentarios que están en espera de la revisión de un moderador. Se puede incluir una conversación en la respuesta si el comentario de nivel superior o al menos una de sus respuestas está pendiente de revisión.
  • likelySpam: Recupera las conversaciones de comentarios clasificadas como probables de spam. Se puede incluir una conversación en la respuesta si se considera que el comentario de nivel superior o al menos una de las respuestas a ese comentario es spam.
  • published: Recupera conversaciones de comentarios publicados. Este es el valor predeterminado. Se puede incluir una conversación de comentarios 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 enumerar los subprocesos de comentarios. Los valores válidos son:
  • time: Las conversaciones de comentarios se ordenan por tiempo. Este es el comportamiento predeterminado.
  • relevance: Las conversaciones de comentarios se ordenan por relevancia.
Nota: No se admite este parámetro para su uso junto 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 su uso 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 contenga solo comentarios que contengan los términos de búsqueda especificados.

Nota: Este parámetro no se admite para su uso 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 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 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
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 contiene 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
Cantidad de resultados incluidos en la respuesta de la API.
items[] list
Una lista de conversaciones 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 sobre mensajes de error.

Tipo de error Detalle del error Descripción
badRequest (400) operationNotSupported El filtro id solo es compatible con los comentarios de Google+.
badRequest (400) processingFailure El servidor de la API no pudo procesar la solicitud correctamente. Si bien puede ser un error transitorio, generalmente 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álido.
forbidden (403) commentsDisabled Se inhabilitaron los comentarios en el video identificado por el parámetro videoId.
forbidden (403) forbidden No se pueden recuperar una o más conversaciones de comentarios solicitadas porque no tienes los permisos necesarios. 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 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ébalo

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