Ein Suchergebnis enthält Informationen zu einem YouTube-Video, einem Kanal oder einer Playlist, die mit den Suchparametern der API-Anfrage übereinstimmen. Ein Suchergebnis verweist auf eine eindeutig identifizierbare Ressource wie ein Video, hat aber keine eigenen persistenten Daten.
Methoden
Die API unterstützt die folgenden Suchmethoden:
- list
- Gibt eine Sammlung von Suchergebnissen zurück, die den in der API-Anfrage angegebenen Suchparametern entsprechen. Standardmäßig werden in den Suchergebnissen übereinstimmende Ressourcen vom Typ
video
,channel
undplaylist
identifiziert. Sie können Abfragen aber auch so konfigurieren, dass nur ein bestimmter Ressourcentyp abgerufen wird. Jetzt ausprobieren.
Ressourcendarstellung
Die folgende JSON-Struktur zeigt das Format eines Suchergebnisses:
{ "kind": "youtube#searchResult", "etag": etag, "id": { "kind": string, "videoId": string, "channelId": string, "playlistId": string }, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "liveBroadcastContent": string } }
Attribute
In der folgenden Tabelle werden die Attribute definiert, die in einem Suchergebnis angezeigt werden:
Attribute | |
---|---|
kind |
string Identifiziert den Typ der API-Ressource. Der Wert ist youtube#searchResult . |
etag |
etag Das ETag dieser Ressource. |
id |
object Das Objekt id enthält Informationen, mit denen die Ressource, die der Suchanfrage entspricht, eindeutig identifiziert werden kann. |
id.kind |
string Der Typ der API-Ressource. |
id.videoId |
string Wenn der Wert der id.type -Property youtube#video lautet, ist diese Property vorhanden und ihr Wert enthält die ID, mit der YouTube ein Video eindeutig identifiziert, das mit der Suchanfrage übereinstimmt. |
id.channelId |
string Wenn der Wert der id.type -Property youtube#channel lautet, ist diese Property vorhanden und ihr Wert enthält die ID, mit der YouTube einen Kanal eindeutig identifiziert, der mit der Suchanfrage übereinstimmt. |
id.playlistId |
string Wenn der Wert der id.type -Property youtube#playlist lautet, ist diese Property vorhanden und ihr Wert enthält die ID, mit der YouTube eine Playlist, die mit der Suchanfrage übereinstimmt, eindeutig identifiziert. |
snippet |
object Das snippet -Objekt enthält grundlegende Details zu einem Suchergebnis, z. B. Titel oder Beschreibung. Wenn das Suchergebnis beispielsweise ein Video ist, entspricht der Titel dem Titel des Videos und der Beschreibung der Beschreibung des Videos. |
snippet.publishedAt |
datetime Das Datum und die Uhrzeit der Ressource, die im Suchergebnis angegeben ist. Der Wert wird im ISO 8601-Format angegeben. |
snippet.channelId |
string Der Wert, den YouTube verwendet, um den Kanal, der die Ressource, die das Suchergebnis identifiziert, veröffentlicht hat, eindeutig zu identifizieren. |
snippet.title |
string Der Titel des Suchergebnisses. |
snippet.description |
string Eine Beschreibung des Suchergebnisses. |
snippet.thumbnails |
object Eine Karte mit Miniaturansichten, die dem Suchergebnis zugeordnet sind. Für jedes Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht und der Wert ein Objekt, das weitere Informationen zur Miniaturansicht enthält. |
snippet.thumbnails.(key) |
object Gültige Schlüssel/Wert-Paare sind:
|
snippet.thumbnails.(key).url |
string Die Bild-URL. |
snippet.thumbnails.(key).width |
unsigned integer Die Breite des Bildes. |
snippet.thumbnails.(key).height |
unsigned integer Die Höhe des Bildes. |
snippet.channelTitle |
string Der Titel des Kanals, der die Ressource veröffentlicht hat, die das Suchergebnis identifiziert. |
snippet.liveBroadcastContent |
string Gibt an, ob eine video - oder channel -Ressource Liveübertragungen hat. Gültige Attributwerte sind upcoming , live und none .Bei einer Ressource vom Typ video gibt der Wert upcoming an, dass das Video eine noch nicht gestartete Liveübertragung ist. Der Wert live gibt an, dass das Video eine aktive Liveübertragung ist. Bei einer channel -Ressource bedeutet der Wert upcoming , dass der Kanal eine geplante Übertragung hat, die noch nicht gestartet wurde. Der Wert live gibt an, dass der Kanal eine aktive Liveübertragung hat. |