Search

Ein search-Ergebnis enthält Informationen zu einem YouTube-Video, ‑Kanal oder ‑Playlist, die den in einer API-Anfrage angegebenen Suchparametern entsprechen. 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 den in der API-Anfrage angegebenen Suchparametern entsprechen. Standardmäßig werden in einem Suchergebnissatz übereinstimmende video-, channel- und playlist-Ressourcen identifiziert. 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 werden die Attribute definiert, die in einem Suchergebnis angezeigt werden:

Attribute
kind string
Gibt den Typ der API-Ressource an. Der Wert ist youtube#searchResult.
etag etag
Das ETag dieser Ressource.
id object
Das id-Objekt enthält Informationen, die zur eindeutigen Identifizierung der Ressource verwendet werden können, die der Suchanfrage entspricht.
id.kind string
Der Typ der API-Ressource.
id.videoId string
Wenn der Wert der Eigenschaft id.type youtube#video ist, ist diese Eigenschaft 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 Eigenschaft id.type youtube#channel ist, ist diese Eigenschaft vorhanden und ihr Wert enthält die ID, die YouTube zur eindeutigen Identifizierung eines Kanals verwendet, der der Suchanfrage entspricht.
id.playlistId string
Wenn der Wert der Eigenschaft id.type youtube#playlist ist, ist diese Eigenschaft vorhanden und ihr Wert enthält die ID, die YouTube zur eindeutigen Identifizierung einer Playlist verwendet, die der Suchanfrage entspricht.
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 Erstellungsdatum und die Erstellungszeit 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 im Suchergebnis identifizierte Ressource 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 mit dem Suchergebnis verknüpft sind. Für jedes Objekt auf der Karte ist der Schlüssel der Name des Vorschaubilds und der Wert ein Objekt, das weitere Informationen zum Vorschaubild enthält.
snippet.thumbnails.(key) object
Gültige Schlüsselwerte sind:
  • default: Das Standard-Thumbnail-Bild. Die Standard-Miniaturansicht 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 Channel 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 auf ein Video verweist) ist dieses Bild 320 Pixel breit und 180 Pixel hoch. Für einen Channel ist dieses Bild 240 Pixel breit und 240 Pixel hoch.
  • high – Eine Version des Thumbnail-Bilds mit hoher Auflösung. Bei einem Video (oder einer Ressource, die auf ein Video verweist) ist dieses Bild 480 Pixel breit und 360 Pixel hoch. Für einen Kanal ist dieses Bild 800 Pixel breit und 800 Pixel hoch.
  • standard: Eine noch höhere Auflösung des Thumbnail-Bilds als bei der high-Auflösung. 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.

Hinweis:Die Thumbnail-Bilder mit einer Auflösung von 1080p oder höher (fhd, qhd und uhd) werden in Suchergebnissen nicht unterstützt. Wenn Sie Thumbnails mit höherer Auflösung abrufen möchten, rufen Sie den ressourcenspezifischen Endpunkt (z. B. videos.list) mit der ID der Ressource auf.
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, auf dem die Ressource veröffentlicht wurde, die im Suchergebnis angegeben ist.
snippet.liveBroadcastContent string
Gibt an, ob eine video- oder channel-Ressource Liveübertragungsinhalte hat. Gültige Werte für die Property sind upcoming, live und none.

 Für eine video-Ressource gibt der Wert upcoming an, dass das Video eine Liveübertragung ist, die noch nicht begonnen hat. 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 stattfindet, die noch nicht begonnen hat. Der Wert live gibt an, dass auf dem Kanal eine aktive Liveübertragung stattfindet.