Search

Un résultat search contient des informations sur une vidéo, une chaîne ou une playlist YouTube correspondant 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 prend en charge 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 ne récupérer qu'un type de ressource spécifique. Essayez 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 la 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
Le type de la ressource d'API.
id.videoId string
Si la valeur de la propriété id.type est youtube#video, cette propriété sera présente et sa valeur contiendra l'ID que YouTube utilise pour identifier de manière unique une vidéo correspondant à la requête de recherche.
id.channelId string
Si la valeur de la propriété id.type est youtube#channel, cette propriété est présente et sa valeur contient 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é est présente et sa valeur contient 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 correspond au titre de la vidéo et la description à sa description.
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 images miniatures associées au résultat de recherche. Pour chaque objet de la carte, la clé correspond au nom de l'image miniature, et la valeur à 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 y fait référence, comme un élément de playlist ou un résultat de recherche) mesure 120 x 90 pixels. La miniature par défaut d'une chaîne mesure 88 x 88 pixels.
  • medium : version de la vignette en haute résolution. Pour une vidéo (ou une ressource qui y fait référence), cette image mesure 320 x 180 px. Pour une chaîne, cette image mesure 240 x 240 pixels.
  • high : version haute résolution de l'image miniature. Pour une vidéo (ou une ressource qui y fait référence), cette image mesure 480 x 360 pixels. Pour une chaîne, cette image mesure 800 x 800 pixels.
  • standard : version de la vignette avec une résolution encore plus élevée que celle de l'image en résolution high. Cette image est disponible pour certaines vidéos et autres ressources qui y font référence, comme les éléments de playlist ou les résultats de recherche. Cette image mesure 640 x 480 pixels.
  • maxres : version de la vignette avec la résolution la plus élevée. Cette taille d'image est disponible pour certaines vidéos et 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 x 720 pixels.
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 upcoming indique que la vidéo est une diffusion en direct qui n'a pas encore commencé, tandis qu'une valeur live indique qu'elle est une diffusion en direct active. Pour une ressource channel, une valeur upcoming indique qu'une diffusion planifiée n'a pas encore commencé, tandis qu'une valeur live indique qu'une diffusion en direct est active.