Captions: list

Gibt eine Liste mit Untertiteln zurück, die einem bestimmten Video zugeordnet sind. Die API-Antwort enthält nicht die eigentlichen Untertitel und die Methode captions.download bietet die Möglichkeit, einen Untertiteltrack abzurufen.

Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 50 Einheiten an.

Gängige Anwendungsfälle

Anfragen

HTTP-Anfrage

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

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

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

Parameter

In der folgenden Tabelle sind die Parameter aufgeführt, die von dieser Abfrage unterstützt werden. Alle aufgeführten Parameter sind Abfrageparameter.

Parameter
Erforderliche Parameter
part string
Der Parameter part gibt die caption-Ressourcenteile an, die in der API-Antwort enthalten sein sollen.

Die Liste unten enthält die part-Namen, die Sie in den Parameterwert aufnehmen können:
  • id
  • snippet
videoId string
Der Parameter videoId gibt die YouTube-Video-ID des Videos an, für das die API Untertiteltracks zurückgeben soll.
Optionale Parameter
id string
Der Parameter id gibt eine durch Kommas getrennte Liste von IDs an, die die caption-Ressourcen angeben, die abgerufen werden sollen. Jede ID muss einen Untertiteltrack identifizieren, der mit dem angegebenen Video verknüpft ist.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Content-Partner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass die Autorisierungsanmeldedaten der Anfrage einen YouTube CMS-Nutzer identifizieren, der im Namen des im Parameterwert angegebenen Rechteinhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. Rechteinhaber können sich einmalig authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Anmeldedaten zur Authentifizierung angeben zu müssen. Das tatsächliche CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.

Anfragetext

Geben Sie beim Aufrufen dieser Methode keinen Anfragetext an.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "youtube#captionListResponse",
  "etag": etag,
  "items": [
    caption Resource
  ]
}

Attribute

In der folgenden Tabelle werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. Der Wert ist youtube#captionListResponse.
etag etag
Das ETag dieser Ressource.
items[] list
Eine Liste der Untertitel, die den Anfragekriterien entsprechen.

Fehler

In der folgenden Tabelle sind Fehlermeldungen aufgeführt, die von der API möglicherweise als Antwort auf einen Aufruf dieser Methode zurückgegeben werden. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) forbidden Mindestens ein Untertitel-Track konnte nicht abgerufen werden, da die mit der Anfrage verknüpften Berechtigungen zum Abrufen der angeforderten Ressourcen nicht ausreichen. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert.
notFound (404) captionNotFound Mindestens einer der angegebenen Untertitel-Tracks wurde nicht gefunden. Dieser Fehler tritt auf, wenn der Parameter videoId ein tatsächliches Video identifiziert, der Parameter id jedoch entweder die IDs von Untertitel-Tracks, die nicht vorhanden sind, oder Tracking-IDs, die mit anderen Videos verknüpft sind. Prüfen Sie, ob die Werte der Parameter id und videoId der Anfrage korrekt sind.
notFound (404) videoNotFound Das durch den Parameter videoId identifizierte Video wurde nicht gefunden.

Testen!

Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.