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
Rufe die Methode captions.list
auf, um eine Liste der Untertiteltracks abzurufen, die für ein bestimmtes Video verfügbar sind. Lege den Parameterwert videoId
auf die YouTube-Video-ID fest, die das Video eindeutig identifiziert, für das du Untertitel abrufen möchtest. Ihre Anfrage muss mit OAuth 2.0 autorisiert sein.
Mit der folgenden Anfrage wird eine Liste der Untertitel für ein Video auf dem YouTube-Kanal von Google Stories abgerufen:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.list? part=snippet &videoId=PRU2ShMzQRg
Codebeispiele finden Sie in der Dokumentation der Methode captions.list
.
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:
snippet.videoId
: Damit wird das Video angegeben, dem der Untertitel-Track hinzugefügt wird.snippet.language
: Die Sprache des Untertitel-Tracks.snippet.name
: Der Name des Untertitel-Tracks.
Beim Hochladen eines Untertitel-Tracks sind die folgenden zusätzlichen Optionen verfügbar:
-
Wenn du den Parameter
sync
auftrue
setzt, ignoriert YouTube alle Zeitcodes in der hochgeladenen Untertiteldatei und generiert neue Zeitcodes für die Untertitel.Du solltest den Parameter
sync
auftrue
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
“ dercaption
-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 Parameterid
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 Parameterwertid
durch eine gültige Untertitel-Track-ID ersetzen.https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.captions.delete? id=CAPTION_TRACK_ID