CMS 應用程式介面:播放清單搜尋

在本主題中,您將學習如何在 Video Cloud 帳戶中搜尋播放清單。這CMS API提供一種編程方式來搜索您的視頻雲庫中的播放列表。在這裡,我們將看看搜索語法。

簡介

可以通過提供一個帳戶來搜索播放列表q上述調用的參數類似於提供的視頻搜索功能。但是請注意,可以搜索的字段數量要少得多,並且僅搜索播放列表屬性,而不搜索播放列表中包含的視頻的屬性。

任何不合格/默認術語將搜索播放列表的名稱、reference_id 或 id 字段中的任何文本匹配項,例如搜索?q=news+2016將匹配以下任何一項(如果存在):

  • 名稱為的播放列表Exciting 2016 News
  • ID為2016的播放列表
  • 一個播放列表reference_idnews 2016

正如上面所暗示的,提供的多個條款是OR ' 在一起,將返回包含一個或多個提供的術語的字符串。提供的值是詞幹 , 因此單詞的變體將被匹配。前綴匹配是不是目前支持。例如搜索p*不會返回以“p”開頭的結果,也不會搜索play*返回包含“播放列表”的結果。

忽略的單字

某些字在搜尋字串中會被忽略,因為它們非常常普遍,因此可能會傳回許多與您實際搜尋內容無關的結果。以下是搜尋所忽略的單字清單:

「a」,「a」,「和」,「是」,「作為」,「在」,「是」,「但」,「通過」,「對」,「如果」,「進」,「進」,「是」,「它」,「不」,「不」,「不」,「的」,「開」,「」或「」,「」,「他們的」,「然後」,「那裡」,「這些」,「他們」,「這」,「到」,「是」,「將」,「與」

此外,非字母數字字符,例如連字符、下劃線、換行符、“$”、“& "、"*" 等被視為單詞分隔符。例如,像這樣的搜索字符串small-town將被視為small town .

欄位

可以使用查詢特定字段{field:}{value}語法如?q=news+2016+type:EXPLICIT .以這種方式提供的字段必須完全匹配。像其他條款一樣,這些將是OR '編輯。

當前支持以下字段:

  • 類型
  • 名稱
  • 描述
  • 參照 _ 識別碼

必填條款

您可以通過使用 URI 編碼作為前綴來要求術語+符號 (%2B) - 示例:q=name:%2Bnews+%2B2016(這將只返回名稱包括“新聞”和“2016”的播放列表)。

排除條款

帶有 URI 編碼的前綴術語-符號以排除具有該術語的播放列表。例如:q=name:%2Bnews+%2D2016將返回名稱中包含“新聞”但不是包含“2016”。

詞幹

詞幹提取指存儲和搜索詞根。這意味著術語“play”、“playing”、“plays”、“played”...都將存儲為“play”,並且當對這些術語中的任何一個進行搜索時,搜索將相應地被翻譯搜索“播放”。詞幹僅適用於單詞的詞根,不適用於以單詞開頭或一部分的字符串。因此,搜索name:play將返回名稱包含“play”、“played”、“playing”和“playable”的視頻,但不會返回名稱包含“display”或“playlist”的視頻。

與/或

您可以將搜索條件與ANDOR邏輯運算符。為了避免歧義(是AND運算符或搜索字符串的一部分?),您需要將邏輯運算符之前的術語放在括號中,如下所示:

q=(Really Short Videos) AND type:EXPLICIT

編碼後,此搜索請求將如下所示:

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

完整的例子

按類型搜索

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

按名稱搜索排除

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