Search

Ein search-Ergebnis enthält Informationen zu einem YouTube-Video, -Kanal oder einer -Playlist, die mit den in einer API-Anfrage angegebenen Suchparametern übereinstimmen. Ein Suchergebnis verweist zwar 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 mit den in der API-Anfrage angegebenen Suchparametern übereinstimmen. Standardmäßig werden in einem Suchergebnissatz übereinstimmende video-, channel- und playlist-Ressourcen ermittelt. Sie können Abfragen aber auch so konfigurieren, dass nur ein bestimmter Ressourcentyp abgerufen wird. Jetzt testen

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 sind die Properties aufgeführt, 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 id-Objekt enthält Informationen, mit denen sich die Ressource eindeutig identifizieren lässt, die mit der Suchanfrage übereinstimmt.
id.kind string
Der Typ der API-Ressource.
id.videoId string
Wenn der Wert der Property id.type youtube#video ist, 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 Property id.type youtube#channel ist, 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 Property id.type youtube#playlist ist, ist diese Property vorhanden und ihr Wert enthält die ID, mit der YouTube eine Playlist eindeutig identifiziert, die mit der Suchanfrage übereinstimmt.
snippet object
Das snippet-Objekt enthält grundlegende Details zu einem Suchergebnis, z. B. den Titel oder die Beschreibung. Wenn das Suchergebnis beispielsweise ein Video ist, ist der Titel der Titel des Videos und die Beschreibung die Beschreibung des Videos.
snippet.publishedAt datetime
Das Datum und die Uhrzeit der Erstellung der Ressource, die im Suchergebnis angegeben ist. Der Wert wird im ISO 8601-Format angegeben.
snippet.channelId string
Der Wert, mit dem YouTube den Kanal eindeutig identifiziert, auf dem die im Suchergebnis angegebene Ressource veröffentlicht wurde.
snippet.title string
Der Titel des Suchergebnisses.
snippet.description string
Eine Beschreibung des Suchergebnisses.
snippet.thumbnails object
Eine Karte mit Miniaturansichten, die mit dem Suchergebnis verknüpft sind. Für jedes Objekt in der Karte ist der Schlüssel der Name des Thumbnail-Bilds und der Wert ist ein Objekt, das weitere Informationen zum Thumbnail enthält.
snippet.thumbnails.(key) object
Gültige Schlüsselwerte:
  • default: Das Standard-Thumbnail-Bild. Die Standardminiaturansicht für ein Video oder eine Ressource, die sich auf ein Video bezieht, z. B. ein Playlist-Element oder ein Suchergebnis, ist 120 Pixel breit und 90 Pixel hoch. Das Standard-Thumbnail für einen Kanal ist 88 Pixel breit und 88 Pixel hoch.
  • medium – Eine Version des Thumbnails mit höherer Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Bei einem Kanal ist dieses Bild 240 Pixel breit und 240 Pixel hoch.
  • high – eine hochauflösende Version des Thumbnail-Bilds. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Bei einem Kanal ist dieses Bild 800 Pixel breit und 800 Pixel hoch.
  • standard: Eine Version des Thumbnails mit noch höherer Auflösung als das Bild mit high Pixeln. Dieses Bild ist für einige Videos und andere Ressourcen verfügbar, die sich auf Videos beziehen, z. B. Playlist-Elemente oder Suchergebnisse. Dieses Bild ist 640 Pixel breit und 480 Pixel hoch.
  • maxres – Die Version des Thumbnail-Bilds mit der höchsten Auflösung. Diese Bildgröße ist für einige Videos und andere Ressourcen verfügbar, die sich auf Videos beziehen, z. B. Playlist-Elemente oder Suchergebnisse. Dieses Bild ist 1.280 Pixel breit und 720 Pixel hoch.
snippet.thumbnails.(key).url string
Die URL des Bildes.
snippet.thumbnails.(key).width unsigned integer
Die Breite des Bilds.
snippet.thumbnails.(key).height unsigned integer
Die Höhe des Bilds.
snippet.channelTitle string
Der Titel des Kanals, auf dem die im Suchergebnis angegebene Ressource veröffentlicht wurde.
snippet.liveBroadcastContent string
Gibt an, ob eine video- oder channel-Ressource Livestreaminhalte enthält. Gültige Werte für die Property sind upcoming, live und none.

Bei einer video-Ressource gibt ein Wert von upcoming an, dass es sich bei dem Video um eine noch nicht gestartete Live-Übertragung handelt. Ein Wert von live bedeutet, dass es sich um eine aktive Live-Übertragung handelt. Bei einer channel-Ressource bedeutet der Wert „upcoming“, dass für den Kanal eine geplante Übertragung geplant ist, die noch nicht gestartet wurde. Der Wert „live“ gibt an, dass für den Kanal eine aktive Livestream-Übertragung läuft.