Videos: list

Gibt eine Liste von Videos zurück, die den API-Anfrageparametern entsprechen.

Kontingentauswirkung: Ein Aufruf dieser Methode hat Kontingentkosten von 1 Einheit.

Gängige Anwendungsfälle

Anfragen

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
Mit dem Parameter part wird eine durch Kommas getrennte Liste mit einem oder mehreren video-Ressourcenattributen angegeben, die in der API-Antwort enthalten sein werden.

Bezeichnet der Parameter eine Property, die untergeordnete Properties enthält, werden die untergeordneten Attribute in die Antwort aufgenommen. In einer video-Ressource enthält beispielsweise das Attribut snippet die Attribute channelId, title, description, tags und categoryId. Wenn du also part=snippet festlegst, enthält die API-Antwort alle diese Eigenschaften.

Die folgende Liste enthält die part-Namen, die du in den Parameterwert aufnehmen kannst:
  • contentDetails
  • fileDetails
  • id
  • liveStreamingDetails
  • localizations
  • player
  • processingDetails
  • recordingDetails
  • snippet
  • statistics
  • status
  • suggestions
  • topicDetails
Filter (geben Sie genau einen der folgenden Parameter an)
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 abgerufene Ressource an. In einer video-Ressource gibt die id-Eigenschaft die Video-ID an.
myRating string
Dieser Parameter kann nur in einer ordnungsgemäß autorisierten Anfrage verwendet werden. Setze den Wert dieses Parameters auf like oder dislike, um die API anzuweisen, nur Videos zurückzugeben, die ein authentifizierter Nutzer mit „Mag ich“ oder „Mag ich nicht“ bewertet hat.

Zulässige Werte sind:
  • dislike: Gibt nur Videos zurück, die vom authentifizierten Nutzer negativ bewertet wurden.
  • like: Gibt nur das Video zurück, das der authentifizierte Nutzer mit „Gefällt mir“ bewertet hat.
Optionale Parameter
hl string
Mit dem Parameter hl wird die API angewiesen, 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 in dieser Sprache lokalisierte Ressourcendetails verfügbar sind, enthält das snippet.localized-Objekt der Ressource die lokalisierten Werte. Wenn jedoch 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 in der Eigenschaft player.embedHtml zurückgegeben wird. Mit diesem Parameter kannst du angeben, dass der Einbettungscode anstelle der Standardabmessungen eine Höhe verwenden soll, die dem Layout deiner App entspricht. Wird auch der maxWidth-Parameter angegeben, kann der Player kürzer als maxHeight sein, damit die maximale Breite nicht überschritten wird. Zulässige Werte sind 72 bis 8192 (einschließlich).
maxResults unsigned integer
Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die in der Ergebnismenge zurückgegeben werden sollen.

Hinweis:Dieser Parameter wird in Verbindung mit dem Parameter myRating unterstützt, aber nicht zusammen 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 in der Eigenschaft player.embedHtml zurückgegeben wird. Mit diesem Parameter kannst du angeben, dass der Einbettungscode anstelle der Standardabmessungen eine Breite verwenden soll, die für das Layout deiner App geeignet ist.

Wenn auch der Parameter maxHeight angegeben wird, kann der Player schmaler als maxWidth sein, damit die maximale Höhe nicht überschritten wird. 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-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 CMS-Konto, mit dem sich der Nutzer authentifiziert, muss mit dem angegebenen YouTube-Rechteinhaber verknüpft sein.
pageToken string
Der pageToken-Parameter gibt eine bestimmte Seite in der Ergebnismenge an, die zurückgegeben werden soll. In einer API-Antwort geben die Attribute nextPageToken und prevPageToken andere Seiten an, die abgerufen werden könnten.

Hinweis:Dieser Parameter wird für die Verwendung in Verbindung mit dem Parameter myRating unterstützt, aber nicht in Verbindung mit dem Parameter id.
regionCode string
Mit dem Parameter regionCode wird die API angewiesen, ein Videodiagramm 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 Diagramm abgerufen werden soll. Dieser Parameter kann nur in Verbindung mit dem Parameter chart verwendet werden. Standardmäßig sind Diagramme 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 werden die Attribute definiert, die in dieser Ressource angezeigt werden:

Attribute
kind string
Identifiziert den Typ der API-Ressource. 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 Seiteninformationen für den Ergebnissatz.
pageInfo.totalResults integer
Die Gesamtzahl der Ergebnisse im Ergebnissatz.
pageInfo.resultsPerPage integer
Die Anzahl der Ergebnisse, die in der API-Antwort enthalten sind.
items[] list
Eine Liste der Videos, 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
badRequest (400) videoChartNotFound Das angeforderte Videodiagramm wird nicht unterstützt oder ist nicht verfügbar.
forbidden (403) forbidden Die Anfrage ist nicht korrekt für den Zugriff auf die Videodatei oder die Verarbeitungsinformationen autorisiert. Die Teile fileDetails, processingDetails und suggestions sind nur für den Rechteinhaber dieses Videos verfügbar.
forbidden (403) forbidden Mit der Anfrage kann nicht auf Nutzerbewertungsinformationen zugegriffen werden. Dieser Fehler kann auftreten, wenn die Anfrage nicht ordnungsgemäß für die Verwendung des myRating-Parameters autorisiert ist.
notFound (404) videoNotFound Das Video, das du abrufen möchtest, kann nicht gefunden werden. Prüfen Sie, ob der Wert des id-Parameters der Anfrage korrekt ist.

Jetzt testen

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