Actualizaremos la API de datos para que coincida con la forma en que YouTube cuenta las vistas de Shorts.
Más información
Implementación: Subtítulos
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En los siguientes ejemplos, se muestra cómo usar la API de YouTube Data (v3) para realizar funciones relacionadas con los subtítulos.
Recupera una lista de pistas de subtítulos de un video
Crea una pista de subtítulos
Esta consulta no se puede probar con el Explorador de APIs porque no admite la carga de archivos, que es un requisito para este método.
Puedes usar el método captions.insert de la API para subir una nueva pista de subtítulos para un video. Cuando subas una pista, debes especificar un valor para las siguientes propiedades del recurso caption:
Las siguientes opciones adicionales están disponibles cuando subes una pista de subtítulos:
-
Si estableces el parámetro sync en true, YouTube ignorará los códigos de tiempo que se encuentren en el archivo de subtítulos subido y generará códigos de tiempo nuevos para los subtítulos.
Debes establecer el parámetro sync en true si subes una transcripción que no tiene códigos de tiempo o si sospechas que los códigos de tiempo de tu archivo son incorrectos y quieres que YouTube intente corregirlos.
-
Si configuras la propiedad snippet.isDraft del recurso caption en true, la pista no será visible para el público.
Consulta la documentación del método captions.insert para ver muestras de código.
Descarga una pista de subtítulos
Esta consulta no se puede probar con el Explorador de APIs porque no admite la capacidad de descargar archivos.
Para descargar una pista de subtítulos específica, llama al método captions.download. Establece el valor del parámetro id en el ID de la pista de subtítulos de YouTube que identifica de forma exclusiva la pista de subtítulos que descargas. Tu solicitud debe estar autorizada con OAuth 2.0.
La API de v3 admite las siguientes opciones:
-
Para especificar que una pista de subtítulos se debe mostrar en un formato específico, establece el valor del parámetro tfmt para identificar el formato deseado. La definición del parámetro enumera los valores admitidos.
-
Para recuperar una traducción de una pista de subtítulos, establece el valor del parámetro tlang en un código de idioma de dos letras ISO 639-1 que identifique el idioma de subtítulos deseado. La traducción se genera con la traducción automática, como Google Traductor.
Consulta la documentación del método captions.download para ver muestras de código.
Cómo actualizar una pista de subtítulos
La API admite la capacidad de cambiar el estado de borrador de una pista de subtítulos, subir una pista de subtítulos nueva para un archivo o ambas opciones.
Puedes usar el Explorador de APIs para probar la capacidad de cambiar el estado de borrador de una pista. Sin embargo, no puedes usar el Explorador de APIs para actualizar la pista de subtítulos real porque la herramienta no admite la capacidad de subir archivos.
La siguiente solicitud recupera una lista de subtítulos de un video del canal de YouTube de Google Stories:
La solicitud actualiza el estado de borrador de una pista de subtítulos a true, lo que significa que la pista no será visible de forma pública. Para completar la solicitud en el Explorador de APIs, debes establecer el valor de la propiedad id para identificar una pista de subtítulos.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet
Consulta la documentación del método captions.update para ver muestras de código.
Cómo borrar una pista de subtítulos
En este ejemplo, se muestra cómo borrar una pista de subtítulos. El ejemplo tiene los siguientes pasos:
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-23 (UTC)
[null,null,["Última actualización: 2024-11-23 (UTC)"],[[["\u003cp\u003eThis document provides instructions on how to use the YouTube Data API (v3) to manage video captions.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a list of caption tracks for a specific video using the \u003ccode\u003ecaptions.list\u003c/code\u003e method, requiring OAuth 2.0 authorization.\u003c/p\u003e\n"],["\u003cp\u003eUploading a new caption track to a video is achieved using the \u003ccode\u003ecaptions.insert\u003c/code\u003e method, requiring the \u003ccode\u003esnippet.videoId\u003c/code\u003e, \u003ccode\u003esnippet.language\u003c/code\u003e, and \u003ccode\u003esnippet.name\u003c/code\u003e properties to be set.\u003c/p\u003e\n"],["\u003cp\u003eDownloading a specific caption track is possible via the \u003ccode\u003ecaptions.download\u003c/code\u003e method, including options to specify the desired format and retrieve a translated version.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows for updating a caption track's draft status and even deleting it completely using the \u003ccode\u003ecaptions.update\u003c/code\u003e and \u003ccode\u003ecaptions.delete\u003c/code\u003e methods respectively.\u003c/p\u003e\n"]]],["The YouTube Data API (v3) facilitates caption management. Key actions include: retrieving caption track lists for a video via `captions.list`; creating new tracks with `captions.insert`, specifying video ID, language, and name; downloading tracks with `captions.download`, allowing format and language selection; updating track status or file with `captions.update`; and deleting tracks using `captions.delete` after retrieving the track ID. Uploading caption files cannot be tested in the APIs Explorer.\n"],null,["# Implementation: Captions\n\nThe following examples show how to use the YouTube Data API (v3) to perform functions related to captions.\n\nRetrieve a list of caption tracks for a video\n---------------------------------------------\n\nTo retrieve a list of caption tracks that are available for a specific video, call the [captions.list](/youtube/v3/docs/captions/list) method. Set the [videoId](/youtube/v3/docs/captions/list#videoId) parameter value to the YouTube video ID that uniquely identifies the video for which you are retrieving captions. Your request must be authorized using OAuth 2.0.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel: \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list?\npart=snippet\n&videoId=PRU2ShMzQRg\n```\n\nSee the [captions.list](/youtube/v3/docs/captions/list#usage) method's documentation for code samples.\n\nCreate a caption track\n----------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to upload files, which is a requirement for this method.\n\nYou can use the API's [captions.insert](/youtube/v3/docs/captions/insert) method to upload a new caption track for a video. When uploading a track, you must specify a value for the following `caption` resource properties:\n\n\u003cbr /\u003e\n\n- [snippet.videoId](/youtube/v3/docs/captions#snippet.videoId) - This identifies the video to which the caption track is being added.\n- [snippet.language](/youtube/v3/docs/captions#snippet.language) - The language of the caption track.\n- [snippet.name](/youtube/v3/docs/captions#snippet.name) - The name of the caption track.\n\n\u003cbr /\u003e\n\nThe following additional options are available when uploading a caption track:\n\n- If you set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true`, YouTube will disregard any time codes that are in the uploaded caption file and generate new time codes for the captions.\n\n You should set the [sync](/youtube/v3/docs/captions/insert#sync) parameter to `true` if you are uploading a transcript, which has no time codes, or if you suspect the time codes in your file are incorrect and want YouTube to try to fix them.\n- If you set the `caption` resource's [snippet.isDraft](/youtube/v3/docs/captions#snippet.isDraft) property to `true`, the track will not be publicly visible.\n\nSee the [captions.insert](/youtube/v3/docs/captions/insert#examples) method's documentation for code samples.\n\nDownload a caption track\n------------------------\n\nThis query cannot be tested using the APIs Explorer because the APIs Explorer does not support the ability to download files.\n\nTo download a specific caption track, call the [captions.download](/youtube/v3/docs/captions/download) method. Set the [id](/youtube/v3/docs/captions/download#id) parameter value to the YouTube caption track ID that uniquely identifies the caption track that you are downloading. Your request must be authorized using OAuth 2.0.\n\nThe v3 API supports the following options:\n\n- To specify that a caption track should be returned in a specific format, set the [tfmt](/youtube/v3/docs/captions/download#tfmt) parameter value to identify the desired format. The parameter definition lists supported values.\n\n- To retrieve a translation of a caption track, set the [tlang](/youtube/v3/docs/captions/download#tlang) parameter value to an [ISO 639-1 two-letter language code](http://www.loc.gov/standards/iso639-2/php/code_list.php) that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.\n\nSee the [captions.download](/youtube/v3/docs/captions/download#examples) method's documentation for code samples.\n\nUpdate a caption track\n----------------------\n\nThe API supports the ability to change a caption track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption track for a file, or both.\n\nYou can use the APIs Explorer to test the ability to change a track's draft status. However, you cannot use the APIs Explorer to update the actual caption track because tool does not support the ability to upload files.\n\nThe request below retrieves a list of captions for a video on the Google Stories YouTube channel:\n\nThe request updates the draft status of a caption track to `true`, which means the track will not be publicly visible. To complete the request in the APIs Explorer, you need to set the `id` property's value to identify a caption track. \n\n```\nhttps://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?\npart=snippet\n```\n\nSee the [captions.update](/youtube/v3/docs/captions/update#usage) method's documentation for code samples.\n\nDelete a caption track\n----------------------\n\nThis example shows how to delete a caption track. The example has the following steps:\n\n- **Step 1: Retrieve the caption track ID**\n\n Follow the steps above to [retrieve a list of caption tracks](#captions-list) for a video. The list could be used to display a list of caption tracks, using each track's ID as a key.\n- **Step 2: Delete the track**\n\n Call the [captions.delete](/youtube/v3/docs/captions/delete) method to delete a specific video. In the request, the `id` parameter specifies the caption track ID of the track that you are deleting. The request must be authorized using OAuth 2.0. If you are testing this query in the APIs Explorer, you will need to substitute a valid caption track ID for the `id` parameter value. \n\n ```\n https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?\n id=CAPTION_TRACK_ID\n ```"]]
