Contacter le support
L'état du systèmeIntroduction
Version 2 de la recherche vidéo utilisée par le CMS API simplifie la syntaxe et la rend plus simple à utiliser.
Pour choisir la syntaxe à utiliser, il suffit de 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 (répertoriés ci-dessous) seront recherchés.
Exemple :
| Chaîne de recherche | Ce qui sera retourné |
|---|---|
bird |
Vidéos que le mot "bird"dans les champs listés ci-dessous |
name:bird |
Vidéos contenant 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:
idnamedescriptionlong_descriptiontext(pas un vrai champ de métadonnées, mais un pseudo-champ que vous pouvez utiliser pour rechercher lename,descriptionlong_description- par exempletext:bird)tagsreference_idcustom_fields(recherche 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 de caractères |
| texte | chaînes ou chaînes entre guillemets (recherche dans name, description 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 guillemets (recherche tous les champs personnalisés - vous pouvez également utiliser un champ personnalisé spécifique interne prénom) |
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 |
datetime ou plage (détails ci-dessous) |
created_at |
datetime ou plage (détails ci-dessous) |
schedule.starts_at |
datetime ou plage (détails ci-dessous) |
schedule.ends_at |
datetime ou plage (détails ci-dessous) |
published_at |
datetime ou plage (détails ci-dessous) |
complete |
true or false |
Dans les deux exemples ci-dessus, les vidéos ne contenant pas le mot "bird"dans tout champ pertinent peut toujours être renvoyé. La section suivante explique comment limiter les résultats de la recherche aux seules vidéos ayant les termes spécifiés.
Recherche Avancée
Certains modificateurs vous aident à limiter les résultats de recherche aux vidéos que vous souhaitez.
| Modifier | Description | Exemples |
|---|---|---|
+ |
Préfixer un terme de recherche avec le signe plus (+) signifie que les vidéos retournées doivent avoir le terme spécifié |
|
- or 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)or (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 de phrases
Vous pouvez rechercher une phrase (plutôt qu'un seul mot) en plaçant des guillemets:
"blue heron"name:"blue heron"
Date / Heures
Vous pouvez rechercher sur un intervalle date-heure en utilisant:
[{start} TO {end}]
Pour rechercher sur une seule date / heure, définissez 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) | * |
|
Voici 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 septembre 2019 et le 7 octobre 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 2 h 00 et 4 h 30 (UTC) le 30 sept. 2019 |
+created_at:[* TO 2019-09-30T00:00:00.000Z] |
Vidéos ajoutées avant le 30 sept. 2019 |