Gibt eine Liste von Videos zurück, die mit den API-Anfrageparametern übereinstimmen.
Auswirkungen auf Kontingente: Bei einem Aufruf dieser Methode fallen Kontingentkosten von 1 Einheit an.
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 Der Parameter part gibt eine durch Kommas getrennte Liste mit einer oder mehreren video -Ressourceneigenschaften an, die in der API-Antwort enthalten sein werden.Wenn der Parameter eine Property mit untergeordneten Properties angibt, werden die untergeordneten Properties in die Antwort aufgenommen. In einer video -Ressource enthält die Property snippet beispielsweise die Attribute channelId , title , description , tags und categoryId . Wenn Sie part=snippet festlegen, enthält die API-Antwort daher alle diese Attribute.Die folgende Liste enthält die part -Namen, die Sie in den Parameterwert aufnehmen können:
|
|
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 abgerufenen YouTube-Video-IDs für die Ressource(n) an. In einer video -Ressource gibt die Property id 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 vom authentifizierten Nutzer mit „Mag ich“ oder „Mag ich nicht“ bewertet wurden.Zulässige Werte sind:
|
|
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 in der Liste sein, die von der Methode i18nLanguages.list zurückgegeben wird.Wenn lokalisierte Ressourcendetails in dieser Sprache 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 Objekt snippet.localized Ressourcendetails in der Standardsprache der Ressource. |
|
maxHeight |
unsigned integer Der Parameter maxHeight gibt die maximale Höhe des eingebetteten Players an, der in der Property player.embedHtml zurückgegeben wird. Mit diesem Parameter können Sie angeben, dass anstelle der Standardabmessungen für den Einbettungscode eine Höhe verwendet werden soll, die dem Layout Ihrer Anwendung entspricht. Wenn der Parameter maxWidth ebenfalls angegeben wird, ist der Player möglicherweise kürzer als maxHeight , damit die maximale Breite nicht überschritten wird. Zulässige Werte sind 72 bis 8192 . |
|
maxResults |
unsigned integer Der Parameter maxResults gibt die maximale Anzahl von Elementen an, die im Ergebnissatz zurückgegeben werden sollten.Hinweis: Dieser Parameter kann zusammen mit dem Parameter myRating verwendet werden, nicht aber in Verbindung mit dem Parameter id . Zulässige Werte sind 1 bis 50 . Der Standardwert ist 5 . |
|
maxWidth |
unsigned integer Der Parameter maxWidth gibt die maximale Breite des eingebetteten Players an, die in der Property player.embedHtml zurückgegeben wird. Du kannst mit diesem Parameter angeben, dass anstelle der Standardabmessungen für den Einbettungscode eine Breite verwendet werden soll, die für das Anwendungslayout geeignet ist.Wenn der Parameter maxHeight ebenfalls angegeben wird, kann der Player schmaler als maxWidth sein, damit die maximale Höhe nicht überschritten wird. Zulässige Werte sind 72 bis 8192 . |
|
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 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 im Ergebnissatz an, die zurückgegeben werden soll. In einer API-Antwort geben die Attribute nextPageToken und prevPageToken andere Seiten an, die abgerufen werden können.Hinweis: Dieser Parameter kann zusammen mit dem Parameter myRating verwendet werden, nicht aber in Verbindung mit dem Parameter id . |
|
regionCode |
string Der Parameter regionCode weist die API an, 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 ISO 3166-1 Alpha-2-Ländercode. |
|
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 im Ergebnissatz abzurufen. |
prevPageToken |
string Das Token, das als Wert des Parameters pageToken verwendet werden kann, um die vorherige Seite im Ergebnissatz abzurufen. |
pageInfo |
object Das pageInfo -Objekt enthält Seiteninformationen für die Ergebnismenge. |
pageInfo.totalResults |
integer Die Gesamtzahl der Ergebnisse in der Ergebnismenge. |
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 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 |
---|---|---|
badRequest (400) |
videoChartNotFound |
Das angeforderte Videodiagramm wird nicht unterstützt oder ist nicht verfügbar. |
forbidden (403) |
forbidden |
Die Anfrage ist nicht berechtigt, auf die Videodatei oder die Verarbeitungsinformationen zuzugreifen. Beachte, dass die Abschnitte fileDetails , processingDetails und suggestions nur dem Rechteinhaber des Videos zur Verfügung stehen. |
forbidden (403) |
forbidden |
Die Anfrage kann nicht auf Nutzerbewertungen zugreifen. Dieser Fehler kann auftreten, wenn die Anfrage zur Verwendung des Parameters myRating nicht ordnungsgemäß autorisiert ist. |
notFound (404) |
videoNotFound |
Das Video, das du abrufen möchtest, wurde nicht gefunden. Prüfen Sie, ob der Wert des id -Parameters korrekt ist. |
Testen!
Verwenden Sie APIs Explorer, um diese API aufzurufen und die API-Anfrage und -Antwort anzusehen.