Captions: list

Gibt eine Liste der Untertiteltracks zurück, die mit einem bestimmten Video verknüpft sind. Die API-Antwort enthält nicht die tatsächlichen Untertitel. Mit der Methode captions.download können Sie einen Untertiteltrack abrufen.

Kontingentbelastung:Ein Aufruf dieser Methode hat eine Kontingentbelastung von 50 Einheiten.

Gängige Anwendungsfälle

Anfrage

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
Mit dem Parameter part werden die Teile der Ressource caption angegeben, die in der API-Antwort enthalten sein sollen.

Die folgende Liste enthält die part-Namen, die Sie in den Parameterwert aufnehmen können:
  • id
  • snippet
videoId string
Mit dem Parameter videoId wird die YouTube-Video-ID des Videos angegeben, für das die API Untertiteltracks zurückgeben soll.
Optionale Parameter
id string
Mit dem Parameter id wird eine durch Kommas getrennte Liste von IDs angegeben, die die abzurufenden caption Ressourcen identifizieren. 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 onBehalfOfContentOwner Parameter gibt an, dass die Autorisierungsdaten 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. So können sich Rechteinhaber einmal authentifizieren und auf alle Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten 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 sind die Attribute definiert, die in dieser Ressource enthalten sind:

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

Fehler

In der folgenden Tabelle sind die Fehlermeldungen aufgeführt, die die API als Antwort auf einen Aufruf dieser Methode zurückgeben kann. Weitere Informationen finden Sie in der Dokumentation zu Fehlermeldungen.

Fehlertyp Fehlerdetail Beschreibung
forbidden (403) forbidden Mindestens ein Untertiteltrack konnte nicht abgerufen werden, da die mit der Anfrage verknüpften Berechtigungen nicht ausreichen, um die angeforderten Ressourcen abzurufen. Die Anfrage ist möglicherweise nicht ordnungsgemäß autorisiert.
notFound (404) captionNotFound Mindestens einer der angegebenen Untertiteltracks konnte nicht gefunden werden. Dieser Fehler tritt auf, wenn der Parameter videoId ein tatsächliches Video identifiziert, der Parameter id jedoch Untertiteltrack-IDs identifiziert, die nicht vorhanden sind, 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 identifizierte Video konnte nicht gefunden werden.

Testen!

Mit dem APIs Explorer können Sie diese API aufrufen und die API-Anfrage und -Antwort ansehen.