Paper Contacter le support | état du système L'état du système
Contenu de la page

    CMS API: Recherche vidéo v2

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

    Introduction

    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 :

    Recherche de base
    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:

    • id
    • name
    • description
    • long_description
    • text (pas un vrai champ de métadonnées, mais un pseudo-champ que vous pouvez utiliser pour rechercher le name, description 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:

    Champs de recherche pris en charge
    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.

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

    Modificateurs de recherche
    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é
    • +bird (Retour uniquement. vidéos avec "bird"dans les champs énumérés ci-dessus)
    • +tags:bird (Retour uniquement. vidéos avec "bird"Dans le tags)
    - 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é
    • -birds or NOT birds (renvoie uniquement les vidéos n'est pas avoir "bird"dans les champs énumérés ci-dessus)
    • -name:birds or NOT name:birds (renvoie uniquement les vidéos n'est pas avoir "bird"Dans le name)
    (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
    • (+name:heron) AND (+tags:bird) (retournerait des vidéos qui ont tous les deux "heron"Dans le name et "bird"Dans le tags)
    • (+name:heron) OR (+tags:bird) (retournerait des vidéos qui ont non plus "heron"Dans le name et "bird"Dans le tags)
    • ((+name:heron) AND (+tags:bird)) AND (NOT tags:internal) (retournerait des vidéos qui ont tous les deux "heron"Dans le name et "bird"Dans le tags, mais n'est pas le tag "internal")

    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:

    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 de date / heure.

    Exemples de recherches de données / temps
    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

    Dernière mise à jour de la page le 15 sept.2020