Un résultat de recherche contient des informations sur une vidéo, une chaîne ou une playlist YouTube 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, telle qu'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
etplaylist
correspondantes, mais vous pouvez également configurer des requêtes pour ne récupérer qu'un type de ressource spécifique. Essayer maintenant
Représentation des ressources
La structure JSON suivante indique 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 d'API. La valeur est 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 la ressource 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 utilisé par YouTube pour identifier de façon 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é sera présente et sa valeur contiendra l'ID utilisé par YouTube pour identifier de façon 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 utilisé par YouTube pour identifier de façon 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, telles que son titre ou sa description. Par exemple, si le résultat de la recherche est une vidéo, le titre correspondra au titre de la vidéo et la description à la 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 façon unique la chaîne ayant 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 de vignettes associées au résultat de recherche. Pour chaque objet de la carte, la clé est le nom de la vignette et la valeur est un objet contenant d'autres informations sur la vignette. |
snippet.thumbnails.(key) |
object Les clés-valeurs valides sont les suivantes:
|
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 ayant publié la ressource identifiée par le résultat de recherche. |
snippet.liveBroadcastContent |
string Indique si une ressource video ou channel comporte du contenu diffusé en direct. Les valeurs de propriété valides sont upcoming , live et none .Pour une ressource video , la valeur upcoming indique que la vidéo est une diffusion en direct qui n'a pas encore commencé, tandis que la valeur live indique qu'il s'agit d'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 qu'une valeur de live indique que la chaîne dispose d'une diffusion en direct active. |