Guide pour la création d'une recherche personnalisée

Vous pouvez créer une requête de recherche entièrement personnalisée en utilisant le champ de saisie de la recherche personnalisée et les paramètres indiqués ci-dessous.

Comment formater une recherche personnalisée
Pour chaque paramètre que vous ajoutez, commencez par une esperluette "&" puis la clé du paramètre (ex : "order") puis un signe égal "=" puis une valeur acceptée (ex : "date"). N'ajoutez pas d'encodage d'URL car le plugin encodera correctement la requête de recherche finale.

Exemples
&q=Funny Cat Videos&order=viewCount
&channelId=UClwg08ECyHnm_RzY1wnZC1A&publishedAfter=2019-06-30T00:00:00Z&publishedBefore=2020-01-30T00:00:00Z
&q=Gooseberry Falls&videoDuration=short

Clé de paramétrage Valeurs acceptées
relatedToVideoId string
Les relatedToVideoId permet d'obtenir une liste de vidéos liées à la vidéo identifiée par la valeur du paramètre. La valeur du paramètre doit correspondre à un identifiant de vidéo YouTube.

Remarque : Si le paramètre relatedToVideoId est défini, les seuls autres paramètres pris en charge sont les suivants regionCode, relevanceLanguage, safeSearchet fields.

channelId string
Les channelId indique que la réponse de l'API ne doit contenir que les ressources créées par le canal.
eventType string
Les eventType limite la recherche aux événements diffusés.
Les valeurs acceptables sont les suivantes :

  • completed - N'inclure que les diffusions achevées.
  • live - N'inclure que les diffusions actives.
  • upcoming - N'inclure que les diffusions à venir.
location string
Les location en conjonction avec le paramètre locationRadius définit une zone géographique circulaire et limite la recherche aux vidéos qui précisent, dans leurs métadonnées, un emplacement géographique situé dans cette zone. La valeur du paramètre est une chaîne qui spécifie les coordonnées de latitude/longitude, par exemple (37.42307,-122.08427).

  • Les location identifie le point au centre de la zone.
  • Les locationRadius spécifie la distance maximale entre l'emplacement associé à une vidéo et ce point pour que la vidéo soit toujours incluse dans les résultats de la recherche.

L'API renvoie une erreur si votre demande spécifie une valeur pour le paramètre location mais ne spécifie pas de valeur pour le paramètre locationRadius paramètre.

locationRadius string
Les locationRadius en conjonction avec le paramètre location définit une zone géographique circulaire.

La valeur du paramètre doit être un nombre à virgule flottante suivi d'une unité de mesure. Les unités de mesure valides sont m, km, ftet mi. Par exemple, les valeurs de paramètres valables sont les suivantes 1500m, 5km, 10000ftet 0.75mi. L'API ne prend pas en charge locationRadius des valeurs de paramètres supérieures à 1000 kilomètres.

Remarque : Voir la définition de la location pour plus d'informations.

order string
Les order spécifie la méthode qui sera utilisée pour ordonner les ressources dans la réponse de l'API. La valeur par défaut est relevance.

Les valeurs acceptables sont les suivantes :

  • date - Les ressources sont classées par ordre chronologique inverse, en fonction de leur date de création.
  • rating - Les ressources sont classées par ordre décroissant d'appréciation.
  • relevance - Les ressources sont triées en fonction de leur pertinence par rapport à la requête de recherche. Il s'agit de la valeur par défaut de ce paramètre.
  • title - Les ressources sont classées par ordre alphabétique de titre.
  • viewCount - Les ressources sont classées du plus grand au plus petit nombre de vues. Pour les diffusions en direct, les vidéos sont classées en fonction du nombre de spectateurs simultanés pendant la durée de la diffusion.
publishedAfter datetime
Les publishedAfter indique que la réponse de l'API ne doit contenir que les ressources créées à partir de la date spécifiée. La valeur est une date-heure formatée selon la norme RFC 3339 (1970-01-01T00:00:00Z).
publishedBefore datetime
Les publishedBefore indique que la réponse de l'API ne doit contenir que les ressources créées avant ou au moment spécifié. La valeur est une date-heure formatée selon la norme RFC 3339 (1970-01-01T00:00:00Z).
q string
Les q spécifie le terme de la requête à rechercher.

Votre demande peut également utiliser la méthode booléenne NOT (-) et OR (|) pour exclure des vidéos ou pour trouver des vidéos associées à un ou plusieurs termes de recherche. Par exemple, pour rechercher des vidéos correspondant à "bateau" ou "voile", définissez l'opérateur q à la valeur du paramètre boating|sailing. De même, pour rechercher les vidéos correspondant à "boating" ou "sailing" mais pas à "fishing", définissez le paramètre q à la valeur du paramètre boating|sailing -fishing.

regionCode string
Les regionCode indique à l'API de renvoyer des résultats de recherche pour les vidéos qui peuvent être visionnées dans le pays spécifié. La valeur du paramètre est un ISO 3166-1 alpha-2 code du pays.
relevanceLanguage string
Les relevanceLanguage indique à l'API de renvoyer les résultats de recherche les plus pertinents pour la langue spécifiée. La valeur du paramètre est généralement un Code linguistique à deux lettres ISO 639-1. Toutefois, il convient d'utiliser les valeurs zh-Hans pour le chinois simplifié et zh-Hant pour le chinois traditionnel. Veuillez noter que les résultats dans d'autres langues seront toujours renvoyés s'ils sont très pertinents par rapport au terme de la requête de recherche.
safeSearch string
Les safeSearch indique si les résultats de la recherche doivent inclure le contenu restreint ainsi que le contenu standard.

Les valeurs acceptables sont les suivantes :

  • moderate - YouTube filtrera certains contenus des résultats de recherche et, au minimum, les contenus dont l'accès est restreint dans votre région. En fonction de leur contenu, les résultats de recherche peuvent être supprimés des résultats de recherche ou rétrogradés dans les résultats de recherche. Il s'agit de la valeur par défaut du paramètre.
  • none - YouTube ne filtre pas les résultats de la recherche.
  • strict - YouTube tentera d'exclure tous les contenus soumis à des restrictions de l'ensemble des résultats de recherche. En fonction de leur contenu, les résultats de recherche pourraient être supprimés des résultats de recherche ou rétrogradés dans les résultats de recherche.
topicId string
Les topicId indique que la réponse de l'API ne doit contenir que les ressources associées au thème spécifié. La valeur identifie un identifiant de sujet Freebase.

Important : En raison de la dépréciation de Freebase et de l'API Freebase, l'option topicId fonctionne différemment depuis le 27 février 2017. À cette date, YouTube a commencé à prendre en charge un petit ensemble d'identifiants de sujets traités, et vous ne pouvez utiliser que cet ensemble réduit d'identifiants comme valeurs pour ce paramètre.

Thèmes
Thèmes musicaux
/m/04rlf Musique (thème parent)
/m/02mscn Musique chrétienne
/m/0ggq0m Musique classique
/m/01lyv Pays
/m/02lkt Musique électronique
/m/0glt670 Musique hip hop
/m/05rwpb Musique indépendante
/m/03_d0 Le jazz
/m/028sqc Musique d'Asie
/m/0g293 Musique d'Amérique latine
/m/064t9 Musique pop
/m/06cqb Reggae
/m/06j6l Rythme et blues
/m/06by7 Musique rock
/m/0gywn Musique soul
Thèmes des jeux
/m/0bzvm2 Jeux (sujet parent)
/m/025zzc Jeu d'action
/m/02ntfj Jeu d'action-aventure
/m/0b1vjn Jeu décontracté
/m/02hygl Jeu vidéo musical
/m/04q1x3q Jeu vidéo de puzzle
/m/01sjng Jeu vidéo de course
/m/0403l3g Jeu vidéo de rôle
/m/021bp2 Jeu vidéo de simulation
/m/022dc6 Jeu sportif
/m/03hf_rm Jeu vidéo de stratégie
Thèmes sportifs
/m/06ntj Sports (thème parent)
/m/0jm_ Football américain
/m/018jz Baseball
/m/018w8 Basket-ball
/m/01cgz Boxe
/m/09xp_ Cricket
/m/02vx4 Football
/m/037hz Golf
/m/03tmr Hockey sur glace
/m/01h7lh Arts martiaux mixtes
/m/0410tth Sport automobile
/m/07bs0 Tennis
/m/07_53 Volley-ball
Thèmes de divertissement
/m/02jjt Divertissement (sujet parent)
/m/09kqc Humour
/m/02vxn Cinéma
/m/05qjc Arts du spectacle
/m/066wd Lutte professionnelle
/m/0f2f9 Émissions de télévision
Thèmes liés au mode de vie
/m/019_rr Mode de vie (thème parent)
/m/032tl La mode
/m/027x7n Fitness
/m/02wbm Alimentation
/m/03glg Hobby
/m/068hy Animaux de compagnie
/m/041xxh Attrait physique [Beauté]
/m/07c1v Technologie
/m/07bxq Tourisme
/m/07yv9 Véhicules
Thèmes de société
/m/098wr Société (thème parent)
/m/09s1f Entreprises
/m/0kt51 Santé
/m/01h6rj Militaire
/m/05qt0 Politique
/m/06bvp Religion
Autres thèmes
/m/01k8wb Connaissances

 

videoCaption string
Les videoCaption indique si l'API doit filtrer les résultats de la recherche vidéo en fonction de la présence ou non de sous-titres.

Les valeurs acceptables sont les suivantes :

  • any - Ne pas filtrer les résultats en fonction de la disponibilité des légendes.
  • closedCaption - N'incluez que les vidéos sous-titrées.
  • none - N'incluez que les vidéos qui ne sont pas sous-titrées.
videoCategoryId string
Les videoCategoryId Ce paramètre permet de filtrer les résultats de la recherche vidéo en fonction de leur catégorie.
videoDefinition string
Les videoDefinition vous permet de limiter une recherche aux vidéos en haute définition (HD) ou en définition standard (SD). Les vidéos HD peuvent être lues en 720p au minimum, mais des résolutions plus élevées, comme 1080p, peuvent également être disponibles.

Les valeurs acceptables sont les suivantes :

  • any - Renvoyer toutes les vidéos, quelle que soit leur résolution.
  • high - Récupérer uniquement des vidéos HD.
  • standard - Ne récupérer que des vidéos en définition standard.
videoDimension string
Les videoDimension vous permet de limiter la recherche à des vidéos 2D ou 3D.

Les valeurs acceptables sont les suivantes :

  • 2d - Restreindre les résultats de la recherche pour exclure les vidéos 3D.
  • 3d - Limiter les résultats de la recherche aux vidéos 3D.
  • any - Inclure les vidéos 3D et non 3D dans les résultats renvoyés. Il s'agit de la valeur par défaut.
videoDuration string
Les videoDuration permet de filtrer les résultats de la recherche vidéo en fonction de leur durée.

Les valeurs acceptables sont les suivantes :

  • any - Ne pas filtrer les résultats de la recherche vidéo en fonction de leur durée. Il s'agit de la valeur par défaut.
  • long - N'incluez que des vidéos de plus de 20 minutes.
  • medium - N'incluez que des vidéos d'une durée comprise entre 4 et 20 minutes (incluses).
  • short - N'incluez que des vidéos de moins de quatre minutes.
videoEmbeddable string
Les videoEmbeddable vous permet de limiter la recherche aux vidéos pouvant être intégrées dans une page web.

Les valeurs acceptables sont les suivantes :

  • any - Renvoyer toutes les vidéos, qu'elles soient incorporables ou non.
  • true - Récupérer uniquement les vidéos intégrables.
videoLicense string
Les videoLicense permet de filtrer les résultats de la recherche de manière à n'inclure que les vidéos dotées d'une licence particulière. YouTube permet aux téléchargeurs de vidéos de choisir de joindre la licence Creative Commons ou la licence YouTube standard à chacune de leurs vidéos.

Les valeurs acceptables sont les suivantes :

  • any - Renvoie toutes les vidéos, quelle que soit la licence dont elles disposent, qui correspondent aux paramètres de la requête.
  • creativeCommon - Ne renvoyer que les vidéos sous licence Creative Commons. Les utilisateurs peuvent réutiliser les vidéos avec cette licence dans d'autres vidéos qu'ils créent. En savoir plus.
  • youtube - Ne renvoie que les vidéos qui ont la licence standard de YouTube.
videoSyndicated string
Les videoSyndicated vous permet de restreindre une recherche aux seules vidéos qui peuvent être lues en dehors de youtube.com.

Les valeurs acceptables sont les suivantes :

  • any - Renvoyer toutes les vidéos, syndiquées ou non.
  • true - Récupérer uniquement les vidéos syndiquées.
videoType string
Les videoType vous permet de limiter la recherche à un type particulier de vidéos.

Les valeurs acceptables sont les suivantes :

  • any - Retourner toutes les vidéos.
  • episode - Récupérer uniquement les épisodes des émissions.
  • movie - Ne récupérer que des films.