API CMS : Recherche de listes de lecture

Introduction

Les listes de lecture d'un compte peuvent être recherchées en fournissant un q paramètre à l'appel ci-dessus similaire à la fonctionnalité de recherche vidéo fournie. Sachez toutefois qu' un nombre beaucoup plus petit de champs peut être recherché et que seules les propriétés de la liste de lecture sont recherchées, pas les propriétés des vidéos contenues dans la liste de lecture.

Tous les termes non qualifiés/par défaut rechercheront toute correspondance de texte dans le champ nom, reference_id ou id d'une liste de lecture, par exemple une recherche correspondant à l'une des caractéristiques suivantes s'il existe : ?q=news+2016

• Une liste de lecture portant le nom Exciting 2016 News
• Une playlist avec un ID de 2016
• Une liste de lecture avec un reference_id de news 2016

Comme il est implicite ci-dessus, plusieurs termes fournis sont OR« assemblés, et les chaînes contenant une ou plusieurs des conditions fournies seront retournées. Les valeurs fournies sont dérivées, de sorte que les variations sur les mots seront appariées. La correspondance des préfixes n'est actuellement pas prise en charge. Ainsi, par exemple, une recherche ne p* renverra pas de résultats commençant par « p » ni une recherche play* de résultats contenant « playlist ».

Mots ignorés

Certains mots sont ignorés dans les chaînes de recherche car ils sont si communs qu'ils sont susceptibles de renvoyer de nombreux résultats sans rapport avec ce que vous recherchez réellement. Voici une liste de mots qui sont ignorés par la recherche :

« a », « an », « et », « sont », « comme », « à », « à », « être », « mais », « par », « pour », « si », « dans », « dans », « est », « il », « non », « de », « sur », « ou », « tel », « que », « le », « leur », « puis », « là », « ces », « ils », « ce », « à », « était », « volonté », « avec »

Champs

Des champs spécifiques peuvent être interrogés à l'aide de la {field:}{value} syntaxe telle que ?q=news+2016+type:EXPLICIT. Les champs fournis de cette façon doivent correspondre exactement. Comme d'autres termes, ils seront OR« ed ».

Les champs suivants sont actuellement pris en charge :

• type
• name
• description
• reference_id

Conditions requises

Vous pouvez exiger des termes en les préfixant avec un + signe encodé par URI (%2B) - exemple : q=name:%2Bnews+%2B2016 (qui renverrait uniquement les playlists avec des noms incluant à la fois « news » et « 2016 »).

Termes exclus

Préfixe les termes avec un - signe encodé par URI pour exclure les playlists avec ce terme. Par exemple : q=name:%2Bnews+%2D2016 renverra les vidéos qui ont des noms contenant « news » mais ne contenant pas « 2016 ».

Stronçage

Stemming se réfère au stockage et à la recherche des racines des mots. Cela signifie que les termes « jouer », « jouer », « jouer », « jouer », « jouer »... seront tous stockés comme « jouer » et lorsqu'une recherche est effectuée pour l'un de ces termes, la recherche sera donc traduite pour rechercher « jouer ». La tige ne s'applique qu'à la racine du mot, et non à une chaîne qui commence ou fait partie du mot. Par conséquent, une recherche sur name:play renvoie des vidéos avec des noms contenant « lecture », « lu », « lecture » et « jouable », mais ne retournera pas les vidéos avec des noms contenant « display » ou « playlist ».

ET/OU

Vous pouvez combiner les conditions de recherche avec AND et les opérateurs OR logiques. Pour éviter l'ambiguïté (est-ce AND qu'un opérateur ou une partie de la chaîne de recherche ?), vous devez mettre des termes qui précèdent les opérateurs logiques entre parenthèses comme ceci :

q=(Really Short Videos) AND type:EXPLICIT

Encodée, cette requête de recherche ressemblerait à ceci :

q=name:%28Really%20Short%20Videos%29%20type:EXPLICIT

Exemples complets

Recherche par type

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists?q=type:ACTIVATED_NEWEST_TO_OLDEST

Recherche par nom avec exclusions

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists?q=%2Bname=morningnews+%2Ddecription=weekend