Captions: list

Gibt eine Liste von Untertiteln zurück, die mit dem angegebenen Video verknüpft sind. Beachte, dass die API-Antwort nicht die tatsächlichen Untertitel enthält und dass die captions.download-Methode die Möglichkeit bietet, einen Untertiteltrack abzurufen.

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 50 Einheiten.

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).

Bereich
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 die API-Antwort enthalten soll.

Die folgende Liste enthält die part-Namen, die du in den Parameterwert aufnehmen kannst:
  • 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 abzurufenden caption-Ressourcen angeben. Mit jeder ID muss ein Untertiteltrack identifiziert werden, der dem angegebenen Video zugeordnet ist.
onBehalfOfContentOwner string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Hinweis: Dieser Parameter ist ausschließlich für YouTube-Contentpartner vorgesehen.

Der Parameter onBehalfOfContentOwner gibt an, dass durch die Autorisierungsanmeldedaten der Anfrage ein YouTube CMS-Nutzer identifiziert wird, 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 nur einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das eigentliche CMS-Konto, bei 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 finden Sie Fehlermeldungen, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben könnte. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetails Beschreibung
forbidden (403) forbidden Mindestens ein Untertiteltrack konnte nicht abgerufen werden, da die mit der Anfrage verknüpften Berechtigungen nicht zum Abrufen der angeforderten Ressourcen 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 echtes Video identifiziert, der Parameter id aber entweder nicht vorhandene Untertitel-Track-IDs oder Track-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 angegebene Video wurde nicht gefunden.

Jetzt testen

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