Introduction
La version 2 de la recherche vidéo utilisée par le CMS API simplifie la syntaxe et la rend plus simple à utiliser.
Le choix de la syntaxe à utiliser consiste simplement à choisir le paramètre d'URL approprié :
- Pour utiliser la nouvelle recherche v2 :
.../videos?query={search_string}
- Pour utiliser la recherche d'origine :
.../videos?q={search_string}
Notions de base
L'élément de base d'une chaîne de recherche est un terme de recherche, qui peut être préfixé par un nom de champ. Si le nom du champ est inclus, seul ce champ de métadonnées sera recherché. Sinon, plusieurs champs (listés ci-dessous) seront recherchés.
Par exemple :
Chaîne de recherche | Ce qui sera retourné |
---|---|
bird |
Des vidéos que le mot "bird " dans les champs ci-dessous |
name:bird |
Vidéos qui ont le mot "bird " dans le name (titre) sera retourné. |
Lorsque vous ne fournissez aucun nom de champ à rechercher, la demande recherchera cette valeur dans les champs suivants :
id
name
description
long_description
text
(pas un vrai champ de métadonnées, mais un pseudo-champ que vous pouvez utiliser pour rechercher lename
,description
, etlong_description
- par exempletext:bird
)tags
reference_id
custom_fields
(recherche dans tous les champs personnalisés)custom_field_name
(recherche un champ personnalisé nommé spécifique)
Les champs pris en charge pour la recherche sont :
Champ | Valeurs légales |
---|---|
name |
chaînes ou chaînes entre guillemets |
texte | chaînes ou chaînes entre guillemets (recherche name , description , et long_description ) |
tags |
chaînes ou chaînes entre guillemets (plusieurs balises doivent être délimitées par des virgules) |
custom_fields |
chaînes ou chaînes guillemets (recherche tous les champs personnalisés - vous pouvez également utiliser un nom interne de champ personnalisé spécifique) |
reference_id |
chaîne ou chaîne entre guillemets |
state |
ACTIVE , INACTIVE , PENDING , DELETED (seules les vidéos supprimées au cours des 10 derniers jours seront retournées) |
updated_at |
dateheure ou plage (détails ci-dessous) |
created_at |
dateheure ou plage (détails ci-dessous) |
schedule.starts_at |
dateheure ou plage (détails ci-dessous) |
schedule.ends_at |
dateheure ou plage (détails ci-dessous) |
published_at |
dateheure ou plage (détails ci-dessous) |
complete |
true ou false |
Dans les deux exemples ci-dessus, les vidéos qui n'ont pas le mot "bird
" dans n'importe quel champ pertinent peut toujours être renvoyé. La section suivante explique comment limiter les résultats de recherche aux seules vidéos contenant les termes spécifiés.
Mots ignorés
Certains mots sont ignorés dans les chaînes de recherche car ils sont si courants qu'ils sont susceptibles de renvoyer de nombreux résultats sans rapport avec ce que vous recherchez réellement. Vous trouverez ci-dessous une liste de mots ignorés par la recherche :
"un", "un", "et", "sont", "comme", "à", "être", "mais", "par", "pour", "si", "dans", "dans ", "est", "il", "non", "pas", "de", "sur", "ou", "tel", "que", "le", "leur", "alors", "là", "ces", "ils", "ceci", "à", "était", "sera", "avec"
En outre, les caractères non alphanumériques tels que les traits d'union, les traits de soulignement, les sauts de ligne, "$", "&", "*", etc. sont traités comme des délimiteurs de mots. Par exemple, une chaîne de recherche telle small-town
que small town
.
Présentation d'une recherche par thème linguistique
Les champs vidéo qui reconnaissent les thèmes linguistiques renvoient des mots qui ont le même thème que le mot recherché. De plus, le stemming permet de saisir uniquement des mots entiers, et non des mots partiels :
- Exemple 1 : La recherche sur
running
renvoie les résultats contenant :running
,run
,runs
- Exemple 2 : La recherche sur
vid
ne renvoie pas de résultats contenant :video
Recherche avec des travaux de stemming dans les domaines suivants :
custom_fields
description
name
long_description
tags
labels
variants
Recherche Avancée
Certains modificateurs vous aident à limiter les résultats de la recherche aux vidéos que vous souhaitez exactement.
Modificateur | Description | Exemples |
---|---|---|
+ |
Préfixer un terme de recherche avec le signe plus (+) signifie que les vidéos renvoyées doit avoir le terme spécifié |
|
- ou NOT |
Préfixer un terme de recherche avec le signe moins (-) ou NOT signifie que les vidéos retournées ne doit pas avoir le terme spécifié |
|
(term) AND (term) ou (term) OR (term) |
La logique AND et OR les opérateurs vous permettent de combiner plusieurs termes de recherche pour des requêtes complexes |
|
Recherche d'expression
Vous pouvez rechercher une phrase (plutôt qu'un seul mot) en plaçant entre guillemets :
"blue heron"
name:"blue heron"
Date/Heures
Vous pouvez effectuer une recherche sur un intervalle date-heure en utilisant :
[{start} TO {end}]
Pour rechercher sur une seule date/heure, réglez le start
et end
à la même valeur :
[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]
Les valeurs date-heure sont spécifiées au format ISO 8601 :
Date-Heure | Format | Exemple |
---|---|---|
Date-Heure | yyyy-MM-ddThh:mm:ss.sssZ |
2019-09-30T14:24:33.512Z |
Caractère générique (peut être utilisé pour la date/heure de début ou de fin) | * |
|
Vous trouverez ci-dessous quelques exemples de chaînes de recherche de date/heure.
Chaîne de recherche | Description |
---|---|
+updated_at:[2019-09-30T00:00:00.000Z TO 2019-10-07T00:00:00.000Z] |
Vidéos mises à jour entre le 30 sept. 2019 et le 7 oct. 2019 |
+created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] |
Vidéos ajoutées le 30 sept. 2019 |
+created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] |
Vidéos ajoutées entre 14h00 et 16h30 (UTC) le 30 sept. 2019 |
+created_at:[* TO 2019-09-30T00:00:00.000Z] |
Vidéos ajoutées avant le 30 sept. 2019 |
Problèmes connus
- Résultats en double : dans certains cas, certains éléments des résultats de la recherche peuvent apparaître plusieurs fois.
Solution de contournement: pour éviter les résultats de recherche en double, utilisez toujours un
sort
paramètre dans vos requêtes de recherche.