Comments: list

Muestra una lista 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/comments

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

La siguiente lista contiene los nombres part que puedes incluir en el valor del parámetro:
  • id
  • snippet
Filtros (especifica exactamente uno de los siguientes parámetros)
id string
El parámetro id especifica una lista separada por comas de IDs de comentarios para los recursos que se recuperan. En un recurso comment, la propiedad id especifica el ID del comentario.
parentId string
El parámetro parentId especifica el ID del comentario para el que se deben recuperar las respuestas.

Nota: Actualmente, YouTube solo admite respuestas para comentarios de nivel superior. Sin embargo, es posible que se admitan respuestas a respuestas en el futuro.
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 1 a 100, inclusive. El valor predeterminado es 20.
pageToken string
El parámetro pageToken identifica una página específica del 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.
textFormat string
Este parámetro indica si la API debe mostrar comentarios con formato HTML o como 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 invoques este método.

Respuesta

Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment 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#commentListResponse.
etag etag
Es la etiqueta Etag de este recurso.
nextPageToken string
Es el token que se puede usar como valor del parámetro pageToken para recuperar la siguiente página del conjunto de resultados.
pageInfo object
El objeto pageInfo encapsula la información de paginación del 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 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. 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+.
forbidden (403) forbidden No se pueden recuperar uno o más de los comentarios solicitados debido a que no tienes los permisos suficientes. Puede que la solicitud no esté debidamente autorizada.
notFound (404) commentNotFound No se encontraron uno o más de los comentarios especificados. Verifica los valores de los parámetros id y parentId de la solicitud para asegurarte de que sean correctos.

Pruébalo

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