Search

Ein Suchergebnis enthält Informationen zu einem YouTube-Video, einem YouTube-Kanal oder einer YouTube-Playlist, die mit den in einer API-Anfrage angegebenen Suchparametern übereinstimmen. Ein Suchergebnis verweist zwar auf eine eindeutig identifizierbare Ressource wie ein Video, verfügt jedoch nicht über eigene persistente 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 identifiziert ein Suchergebnissatz übereinstimmende video-, channel- und playlist-Ressourcen. Sie können jedoch Abfragen 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 Eigenschaften 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 id-Objekt enthält Informationen, mit denen die Ressource, die mit der Suchanfrage übereinstimmt, eindeutig identifiziert werden kann.
id.kind string
Der Typ der API-Ressource.
id.videoId string
Wenn der Wert der id.type-Property youtube#video ist, ist diese Property vorhanden und ihr Wert enthält die ID, die YouTube verwendet, um ein Video, das der Suchanfrage entspricht, eindeutig zu identifizieren.
id.channelId string
Wenn der Wert der id.type-Property 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 id.type-Property youtube#playlist ist, ist diese Property vorhanden und ihr Wert enthält die ID, die YouTube verwendet, um eine Playlist, die mit der Suchanfrage übereinstimmt, eindeutig zu identifizieren.
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 Videotitel und die Beschreibung ist die Videobeschreibung.
snippet.publishedAt datetime
Das Erstellungsdatum und die Erstellungsdatum der Ressource, die durch das Suchergebnis identifiziert wird. Der Wert wird im ISO 8601-Format angegeben.
snippet.channelId string
Der Wert, der von YouTube verwendet wird, um den Kanal eindeutig zu identifizieren, über den 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 dem Suchergebnis zugeordnet sind. Bei jedem Objekt auf der Karte ist der Schlüssel der Name der Miniaturansicht. Der Wert ist ein Objekt, das weitere Informationen zur Miniaturansicht enthält.
snippet.thumbnails.(key) object
Gültige Schlüssel/Wert-Paare sind:
  • default: Das Standard-Thumbnail. Das Standard-Thumbnail für ein Video – oder eine Ressource, die auf ein Video verweist, 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. Dieses Bild eines Kanals ist 240 Pixel breit und 240 Pixel hoch.
  • high: Eine Version des Thumbnails mit hoher Auflösung. Bei einem Video (oder einer Ressource, die sich auf ein Video bezieht) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Dieses Bild eines Kanals ist 800 Pixel breit und 800 Pixel hoch.
  • standard: Das Thumbnail-Bild hat eine höhere Auflösung als das Bild mit einer Auflösung von high. 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: Das Thumbnail-Bild mit der höchsten Auflösung. Diese Bildgröße ist für einige Videos und andere Ressourcen verfügbar, die sich auf Videos beziehen, wie 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 Bildes.
snippet.thumbnails.(key).height unsigned integer
Die Höhe des Bildes.
snippet.channelTitle string
Der Titel des Kanals, über den die im Suchergebnis angegebene Ressource veröffentlicht wurde.
snippet.liveBroadcastContent string
Gibt an, ob für eine Ressource vom Typ video oder channel Liveübertragungen verfügbar sind. Gültige Attributwerte sind upcoming, live und none.

Bei einer video-Ressource gibt der Wert upcoming an, dass das Video eine Liveübertragung ist, die noch nicht gestartet wurde. Der Wert live gibt an, dass das Video eine aktive Liveübertragung ist. Bei einer channel-Ressource gibt der Wert upcoming an, dass auf dem Kanal eine geplante Übertragung noch nicht begonnen hat. Der Wert live gibt an, dass auf dem Kanal eine aktive Liveübertragung läuft.