Wir aktualisieren die Data API, damit sie der Zählweise von YouTube-Aufrufen für Kurzvideos entspricht.
Weitere Informationen
Implementierung: Untertitel
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
In den folgenden Beispielen wird gezeigt, wie du mit der YouTube Data API (Version 3) Funktionen im Zusammenhang mit Untertiteln ausführen kannst.
Liste der Untertiteltracks für ein Video abrufen
Untertiteltrack erstellen
Diese Abfrage kann nicht mit dem APIs Explorer getestet werden, da der APIs Explorer das Hochladen von Dateien nicht unterstützt, was für diese Methode erforderlich ist.
Mit der Methode captions.insert der API kannst du einen neuen Untertiteltrack für ein Video hochladen. Beim Hochladen eines Titels müssen Sie einen Wert für die folgenden caption-Ressourceneigenschaften angeben:
Beim Hochladen eines Untertitel-Tracks sind die folgenden zusätzlichen Optionen verfügbar:
-
Wenn du den Parameter sync auf true setzt, ignoriert YouTube alle Zeitcodes in der hochgeladenen Untertiteldatei und generiert neue Zeitcodes für die Untertitel.
Du solltest den Parameter sync auf true setzen, wenn du ein Transkript hochlädst, das keine Zeitcodes enthält, oder wenn du vermutest, dass die Zeitcodes in deiner Datei falsch sind und du möchtest, dass YouTube versucht, sie zu korrigieren.
-
Wenn du die Property „snippet.isDraft“ der caption-Ressource auf „true“ festlegst, ist der Titel nicht öffentlich sichtbar.
Codebeispiele finden Sie in der Dokumentation der Methode captions.insert.
Untertiteltrack herunterladen
Diese Abfrage kann nicht mit dem APIs Explorer getestet werden, da der APIs Explorer das Herunterladen von Dateien nicht unterstützt.
Wenn du einen bestimmten Untertiteltrack herunterladen möchtest, rufe die Methode captions.download auf. Lege den Parameterwert id auf die ID des Untertitel-Tracks fest, der heruntergeladen werden soll. Ihre Anfrage muss mit OAuth 2.0 autorisiert sein.
Die v3 API unterstützt die folgenden Optionen:
-
Wenn du angeben möchtest, dass ein Untertiteltrack in einem bestimmten Format zurückgegeben werden soll, setze den Parameterwert tfmt auf das gewünschte Format. In der Parameterdefinition sind die unterstützten Werte aufgeführt.
-
Wenn du eine Übersetzung eines Untertitel-Tracks abrufen möchtest, setze den Parameterwert tlang auf einen ISO 639-1-Sprachcode mit zwei Buchstaben, der die gewünschte Untertitelsprache angibt. Die Übersetzung wird mithilfe von maschinellen Übersetzungsdiensten wie Google Übersetzer erstellt.
Codebeispiele finden Sie in der Dokumentation der Methode captions.download.
Untertitel-Track aktualisieren
Mit der API kannst du den Entwurfsstatus eines Untertiteltracks ändern, einen neuen Untertiteltrack für eine Datei hochladen oder beides.
Mit dem APIs Explorer können Sie testen, ob Sie den Entwurfsstatus eines Tracks ändern können. Du kannst den Untertiteltrack jedoch nicht über den APIs Explorer aktualisieren, da das Tool das Hochladen von Dateien nicht unterstützt.
Mit der folgenden Anfrage wird eine Liste der Untertitel für ein Video auf dem YouTube-Kanal von Google Stories abgerufen:
Durch die Anfrage wird der Entwurfsstatus eines Untertitel-Tracks auf true aktualisiert. Das bedeutet, dass der Track nicht öffentlich sichtbar ist. Damit die Anfrage im APIs Explorer abgeschlossen werden kann, musst du den Wert der Property id so festlegen, dass ein Untertitel-Track angegeben wird.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.update?
part=snippet
Codebeispiele finden Sie in der Dokumentation der Methode captions.update.
Untertitel-Track löschen
In diesem Beispiel wird gezeigt, wie du einen Untertiteltrack löschst. Das Beispiel umfasst die folgenden Schritte:
-
Schritt 1: Untertitel-Track-ID abrufen
Folge der Anleitung oben, um eine Liste der Untertiteltracks für ein Video abzurufen. Die Liste kann verwendet werden, um eine Liste der Untertiteltracks anzuzeigen, wobei die ID jedes Tracks als Schlüssel verwendet wird.
-
Schritt 2: Titel löschen
Rufe die Methode captions.delete auf, um ein bestimmtes Video zu löschen. In der Anfrage gibt der Parameter id die Untertitel-Track-ID des zu löschenden Tracks an. Die Anfrage muss mit OAuth 2.0 autorisiert sein. Wenn du diese Abfrage in APIs Explorer testest, musst du den Parameterwert id durch eine gültige Untertitel-Track-ID ersetzen.
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete?
id=CAPTION_TRACK_ID
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-11-23 (UTC).
[null,null,["Zuletzt aktualisiert: 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 ```"]]
