Search

Un résultat search contient des informations sur une vidéo YouTube, une chaîne ou une playlist qui correspondent aux paramètres de recherche spécifiés dans une requête API. Bien qu'un résultat de recherche pointe vers une ressource identifiable de manière unique, comme une vidéo, il ne possède pas ses propres données persistantes.

Méthodes

L'API est compatible avec les méthodes de recherche suivantes :

liste
Renvoie une collection de résultats de recherche correspondant aux paramètres de requête spécifiés dans la requête API. Par défaut, un ensemble de résultats de recherche identifie les ressources video, channel et playlist correspondantes, mais vous pouvez également configurer des requêtes pour n'extraire qu'un type de ressource spécifique. Essayez-le maintenant.

Représentation de la ressource

La structure JSON suivante montre le format d'un résultat de recherche :

{
  "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
  }
}

Propriétés

Le tableau suivant définit les propriétés qui apparaissent dans un résultat de recherche :

Propriétés
kind string
Identifie le type de ressource de l'API. La valeur sera youtube#searchResult.
etag etag
Etag de cette ressource.
id object
L'objet id contient des informations permettant d'identifier de manière unique la ressource correspondant à la requête de recherche.
id.kind string
Type de ressource d'API.
id.videoId string
If the id.type property's value is youtube#video, then this property will be present and its value will contain the ID that YouTube uses to uniquely identify a video that matches the search query.
id.channelId string
Si la valeur de la propriété id.type est youtube#channel, cette propriété sera présente et sa valeur contiendra l'ID que YouTube utilise pour identifier de manière unique une chaîne correspondant à la requête de recherche.
id.playlistId string
Si la valeur de la propriété id.type est youtube#playlist, cette propriété sera présente et sa valeur contiendra l'ID que YouTube utilise pour identifier de manière unique une playlist correspondant à la requête de recherche.
snippet object
L'objet snippet contient des informations de base sur un résultat de recherche, comme son titre ou sa description. Par exemple, si le résultat de recherche est une vidéo, le titre sera celui de la vidéo et la description sera celle de la vidéo.
snippet.publishedAt datetime
Date et heure de création de la ressource identifiée par le résultat de recherche. La valeur est spécifiée au format ISO 8601.
snippet.channelId string
Valeur utilisée par YouTube pour identifier de manière unique la chaîne qui a publié la ressource identifiée par le résultat de recherche.
snippet.title string
Titre du résultat de recherche.
snippet.description string
Description du résultat de recherche.
snippet.thumbnails object
Carte des miniatures associées au résultat de recherche. Pour chaque objet de la carte, la clé correspond au nom de la miniature et la valeur est un objet contenant d'autres informations sur la miniature.
snippet.thumbnails.(key) object
Les valeurs de clé valides sont les suivantes :
  • default : image miniature par défaut. La vignette par défaut d'une vidéo (ou d'une ressource qui fait référence à une vidéo, comme un élément de playlist ou un résultat de recherche) mesure 120 pixels de large et 90 pixels de haut. La miniature par défaut d'une chaîne mesure 88 px de large et 88 px de haut.
  • medium : version haute résolution de la vignette. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 320 px de large et 180 px de haut. Pour une chaîne, cette image doit mesurer 240 x 240 pixels.
  • high : version haute résolution de la miniature. Pour une vidéo (ou une ressource qui fait référence à une vidéo), cette image mesure 480 px de large et 360 px de haut. Pour une chaîne, cette image doit avoir une largeur et une hauteur de 800 px.
  • standard : version de la vignette avec une résolution encore plus élevée que celle de l'image high. Cette image est disponible pour certaines vidéos et d'autres ressources qui font référence à des vidéos, comme les éléments de playlist ou les résultats de recherche. Cette image mesure 640 pixels de large et 480 pixels de haut.
  • maxres : version de la vignette avec la résolution la plus élevée. Cette taille d'image est disponible pour certaines vidéos et d'autres ressources qui font référence à des vidéos, comme les éléments de playlist ou les résultats de recherche. Cette image mesure 1 280 px de large et 720 px de haut.

Remarque : Les miniatures 1080p+ (fhd, qhd et uhd) ne sont pas compatibles avec les résultats de recherche. Pour récupérer des miniatures en haute résolution, appelez le point de terminaison spécifique à la ressource (par exemple, videos.list) à l'aide de l'ID de la ressource.
snippet.thumbnails.(key).url string
URL de l'image.
snippet.thumbnails.(key).width unsigned integer
Largeur de l'image.
snippet.thumbnails.(key).height unsigned integer
Hauteur de l'image.
snippet.channelTitle string
Titre de la chaîne qui a publié la ressource identifiée par le résultat de recherche.
snippet.liveBroadcastContent string
Indique si une ressource video ou channel contient du contenu de diffusion en direct. Les valeurs de propriété valides sont upcoming, live et none.

 Pour une ressource video, une valeur de upcoming indique que la vidéo est une diffusion en direct qui n'a pas encore commencé, tandis qu'une valeur de live indique que la vidéo est une diffusion en direct active. Pour une ressource channel, la valeur upcoming indique que la chaîne a une diffusion programmée qui n'a pas encore commencé, tandis que la valeur live indique que la chaîne a une diffusion en direct active.