Videos: list

Gibt eine Liste von Videos zurück, die den Parametern der API-Anfrage entsprechen.

Kontingentauswirkungen: Ein Aufruf dieser Methode kostet 1 Kontingenteinheit.

Gängige Anwendungsfälle

Anfrage

HTTP-Anfrage

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

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 eine durch Kommas getrennte Liste mit einem oder mehreren Attributen der Ressource video an, die in der API-Antwort enthalten sein sollen.

Wenn der Parameter ein Attribut identifiziert, das untergeordnete Attribute enthält, werden diese untergeordneten Attribute in die Antwort aufgenommen. In einer video-Ressource enthält das Attribut snippet beispielsweise die Attribute channelId, title, description, tags und categoryId. Wenn Sie also part=snippet festlegen, enthält die API-Antwort alle diese Attribute.

Die folgende Liste enthält die part Namen, die Sie in den Parameterwert aufnehmen können:
  • brandPartner
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • paidProductPlacementDetails
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filter (genau einen der folgenden Parameter angeben)
chart string
Der Parameter chart gibt das Diagramm an, das Sie abrufen möchten.

Zulässige Werte sind:
id string
Der Parameter id gibt eine durch Kommas getrennte Liste der YouTube-Video-IDs für die abzurufenden Ressourcen an. In einer video-Ressource gibt das Attribut id die ID des Videos an.
myRating string

Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Legen Sie den Wert dieses Parameters auf like oder dislike fest, damit die API nur Videos zurückgibt, die vom authentifizierten Nutzer mit „Gefällt mir“ markiert oder mit „Gefällt mir nicht“ markiert wurden.



Die API beschränkt die zurückgegebene Ergebnismenge auf maximal 1.000 Videos. Auch wenn das Attribut pageInfo.totalResults der Antwort eine höhere Gesamtzahl angibt, können mit der Paginierung über den Parameter pageToken nur die letzten 1.000 Elemente abgerufen werden.



Der Parameter akzeptiert die folgenden Werte:

  • dislike : Gibt nur Videos zurück, die vom authentifizierten Nutzer mit „Gefällt mir nicht“ markiert wurden.
  • like : Gibt nur Videos zurück, die vom authentifizierten Nutzer mit „Gefällt mir“ markiert wurden.
Optionale Parameter
hl string
Der Parameter hl weist die API an, lokalisierte Ressourcenmetadaten für eine bestimmte Anwendungssprache abzurufen, die von der YouTube-Website unterstützt wird. Der Parameterwert muss ein Sprachcode sein, der in der Liste enthalten ist, die von der i18nLanguages.list Methode zurückgegeben wird.

Wenn lokalisierte Ressourcendetails in dieser Sprache verfügbar sind, enthält das Objekt snippet.localized der Ressource die lokalisierten Werte. Wenn keine lokalisierten Details verfügbar sind, enthält das snippet.localized Objekt Ressourcendetails in der Standardsprache der Ressource.
maxHeight unsigned integer
Der Parameter maxHeight gibt die maximale Höhe des eingebetteten Players an, der im Attribut player.embedHtml zurückgegeben wird. Mit diesem Parameter können Sie festlegen, dass der Einbettungscode anstelle der Standardabmessungen eine Höhe verwenden soll, die für das Layout Ihrer Anwendung geeignet ist. Wenn auch der Parameter maxWidth angegeben wird, ist der Player möglicherweise kürzer als maxHeight, um die maximale Breite nicht zu überschreiten. Zulässige Werte sind 72 bis 8192 (einschließlich).
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl der Elemente an, die in der Ergebnismenge zurückgegeben werden sollen.

Hinweis: Dieser Parameter kann in Verbindung mit dem Parameter myRating verwendet werden, aber nicht in Verbindung mit dem Parameter id. Zulässige Werte sind 1 bis 50 (einschließlich). Der Standardwert ist 5.
maxWidth unsigned integer
Der Parameter maxWidth gibt die maximale Breite des eingebetteten Players an, der im Attribut player.embedHtml zurückgegeben wird. Mit diesem Parameter können Sie festlegen, dass der Einbettungscode anstelle der Standardabmessungen eine Breite verwenden soll, die für das Layout Ihrer Anwendung geeignet ist.

Wenn auch der Parameter maxHeight angegeben wird, ist der Player möglicherweise schmaler als maxWidth, um die maximale Höhe nicht zu überschreiten. Zulässige Werte sind 72 bis 8192 (einschließlich).
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 Content-Inhabers handelt. Dieser Parameter ist für YouTube-Content-Partner vorgesehen, die viele verschiedene YouTube-Kanäle besitzen und verwalten. So können Rechteinhaber sich einmal authentifizieren und auf alle ihre Video- und Kanaldaten zugreifen, ohne für jeden einzelnen Kanal Authentifizierungsdaten angeben zu müssen. Das CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
pageToken string
Der Parameter pageToken gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort identifizieren die Attribute nextPageToken und prevPageToken andere Seiten, die abgerufen werden können.

Hinweis: Dieser Parameter kann in Verbindung mit dem Parameter myRating verwendet werden, aber nicht in Verbindung mit den Parameter id.
regionCode string
Der Parameter regionCode weist die API an, ein Video-Chart auszuwählen, das in der angegebenen Region verfügbar ist. Dieser Parameter kann nur in Verbindung mit dem Parameter chart verwendet werden. Der Parameterwert ist ein Ländercode gemäß ISO 3166-1 alpha-2.
videoCategoryId string
Der Parameter videoCategoryId gibt die Videokategorie an, für die das Chart abgerufen werden soll. Dieser Parameter kann nur in Verbindung mit dem Parameter chart verwendet werden. Standardmäßig sind Charts nicht auf eine bestimmte Kategorie beschränkt. Der Standardwert ist 0.

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#videoListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    video Resource
  ]
}

Attribute

In der folgenden Tabelle sind die Attribute definiert, die in dieser Ressource enthalten sind:

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#videoListResponse.
etag etag
Das ETag dieser Ressource.
nextPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die nächste Seite in der Ergebnismenge abzurufen.
prevPageToken string
Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite in der Ergebnismenge abzurufen.
pageInfo object
Das Objekt pageInfo enthält Paginierungsinformationen für die Ergebnismenge.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse in der Ergebnismenge.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse in der API-Antwort.
items[] list
Eine Liste von Videos, die den Anfragekriterien 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 Fehlerdetails Beschreibung
badRequest (400) videoChartNotFound Das angeforderte Video-Chart wird nicht unterstützt oder ist nicht verfügbar.
forbidden (403) forbidden Die Anfrage ist nicht ordnungsgemäß autorisiert, um auf Videodatei- oder Verarbeitungsinformationen zuzugreifen. Die Teile fileDetails, processingDetails und suggestions sind nur für den Inhaber dieses Videos verfügbar.
forbidden (403) forbidden Die Anfrage kann nicht auf Nutzerbewertungsinformationen zugreifen. Dieser Fehler kann auftreten, weil die Anfrage nicht ordnungsgemäß autorisiert ist, den Parameter myRating zu verwenden.
notFound (404) videoNotFound Das Video, das Sie abzurufen versuchen, wurde nicht gefunden. Prüfen Sie den Wert des Parameters id der Anfrage, um sicherzustellen, dass er korrekt ist.

Testen!

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