Captions: list

Muestra una lista de pistas de subtítulos asociadas con un video específico. Ten en cuenta que la respuesta de la API no contiene los subtítulos reales y que el método captions.download proporciona la capacidad de recuperar una pista de subtítulos.

Impacto de la cuota: Una llamada a este método tiene un costo de cuota de 50 unidades.

Casos de uso habituales

Solicitud

Solicitud HTTP

GET https://www.googleapis.com/youtube/v3/captions

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

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 las partes del recurso caption que incluirá la respuesta de la API.

La siguiente lista contiene los nombres de part que puedes incluir en el valor del parámetro:
  • id
  • snippet
videoId string
El parámetro videoId especifica el ID de video de YouTube del video para el que la API debe mostrar pistas de subtítulos.
Parámetros opcionales
id string
El parámetro id especifica una lista de IDs separados por comas que identifican los recursos caption que se deben recuperar. Cada ID debe identificar una pista de subtítulos asociada con el video especificado.
onBehalfOfContentOwner string
Este parámetro solo se puede usar en una solicitud autorizada debidamente. Nota: Este parámetro está dirigido exclusivamente a socios de contenido de YouTube.

El parámetro onBehalfOfContentOwner indica que las credenciales de autorización de la solicitud identifican a un usuario de CMS de YouTube que actúa en nombre del propietario del contenido especificado en el valor del parámetro. Este parámetro está dirigido a socios de contenido de YouTube que poseen y administran varios canales de YouTube diferentes. Permite a los propietarios de contenido autenticarse una vez y acceder a todos los datos de sus videos y canales, sin tener que proporcionar credenciales de autenticación para cada canal. La cuenta de CMS con la que se autentica el usuario debe estar relacionada con el propietario del contenido de YouTube especificado.

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#captionListResponse",
  "etag": etag,
  "items": [
    caption 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#captionListResponse.
etag etag
La Etag de este recurso.
items[] list
Una lista de subtítulos 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
forbidden (403) forbidden No fue posible recuperar una o más pistas de subtítulos porque los permisos asociados con la solicitud no son suficientes para recuperar los recursos solicitados. Puede que la solicitud no esté debidamente autorizada.
notFound (404) captionNotFound No se encontraron una o más de las pistas de subtítulos especificadas. Este error ocurre si el parámetro videoId identifica un video real, pero el parámetro id identifica IDs de pistas de subtítulos que no existen o IDs de pistas asociados con otros videos. Comprueba los valores de los parámetros id y videoId 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 APIs Explorer para llamar a esta API y ver la solicitud y la respuesta a la API.