assistance Contacter le support | Étatétat du système du système
Contenu de la page

    API CMS : Recherche vidéo v2

    Cette rubrique explique la syntaxe d'utilisation de la version 2 de la recherche vidéo, prise en charge par l'API CMS.

    Introduction

    La version 2 de la recherche vidéo utilisée par le CMS API simplifie la syntaxe et la rend plus simple à utiliser.

    Choisir 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 (énumérés ci-dessous) seront recherchés.

    Par exemple :

    Recherche basique
    Chaîne de recherche Ce qui sera retourné
    bird Vidéos que le mot "bird" dans les champs répertoriés ci-dessous
    name:bird Les vidéos qui ont le motbird" " dans le name(titre) seront retournées.

    Lorsque vous ne fournissez aucun nom de champ à rechercher, la demande recherche 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 name , description , et long_description - par exemple text:bird)
    • tags
    • reference_id
    • custom_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 les suivants :

    Champs de recherche supportés
    Champ Valeurs juridiques
    name chaînes de caractères entre guillemets ou non
    texte chaînes ou chaînes guillemets (recherche dans le name, description, et long_description)
    tags chaînes ou 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 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 ou false

    Dans les deux exemples ci-dessus, les vidéos qui n'ont pas le mot "bird" dans un champ pertinent peuvent toujours être retournées. La section suivante explique comment limiter les résultats de recherche aux seules vidéos ayant les termes spécifiés.

    Certains modificateurs vous aident à limiter les résultats de recherche aux vidéos que vous souhaitez.

    Rechercher des modificateurs
    Modificatif 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é
    • +bird ( renvoie uniquement les vidéos avec "bird " dans les champs listés ci-dessus)
    • +tags:bird ( renvoie uniquement les vidéos avec "bird " dans le tags)
    - ou NOT Préfixer un terme de recherche avec le signe moins (-) ou NOT signifie que les vidéos retournées ne doivent pas avoir le terme spécifié
    • -birds ou NOT birds (renvoie uniquement les vidéos qui n'ont pas "bird " dans les champs listés ci-dessus)
    • -name:birds ou NOT name:birds (renvoie uniquement les vidéos qui n'ont pas "bird " dans le name)
    (term) AND (term)
    ou
    (term) OR (term)    		 Le logique AND et OR les opérateurs vous permettent de combiner plusieurs termes de recherche pour des requêtes complexes
    • (+name:heron) AND (+tags:bird)(renverrait des vidéos qui ont tous les deux "heron " dans le name et "bird " dans le tags)
    • (+name:heron) OR (+tags:bird) ( renverrait les vidéos qui ont soit "heron " dans le name et ""bird "dans le tags)
    • ((+name:heron) AND (+tags:bird)) AND (NOT tags:internal)(renverrait des vidéos qui ont tous les deux "heron " dans le name et "bird " dans le tags , mais ne pas le tag "internal")

    Recherche de phrases

    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 à l'aide de :

    [{start} TO {end}]

    Pour effectuer une recherche sur une seule date/heure, définissez la valeur start et end sur 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 en utilisant le format ISO 8601 :

    Formats de date/heure
    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) *
    • 2019-09-30T14:24:33.512Z TO *
    • * TO 2019-09-30T14:24:33.512-4:00Z

    Voici quelques exemples de chaînes de recherche date/heure.

    Exemples de recherches de données/temporelles
    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 30 Sep 2019 et 7 Oct 2019
    +created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] Vidéos ajoutées le 30 Sep 2019
    +created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] Vidéos ajoutées entre 2:00 PM et 4:30 PM (UTC) le 30 Sep 2019
    +created_at:[* TO 2019-09-30T00:00:00.000Z] Vidéos ajoutées avant le 30 Sep 2019