CMS 應用程式介面：視頻搜索 v2

本主題說明使用 CMS API 支援的視訊搜尋版本 2 的語法。

簡介

視頻搜索的第 2 版CMS API簡化語法並使其更易於使用。

選擇要使用的語法是選擇適當的URL參數的簡單問題：

  • 要使用新的v2搜索，請執行以下操作： 
        .../videos?query={search_string}
  • 要使用原始搜索： 
        .../videos?q={search_string}

基本概念

搜索字符串的基本元素是搜索詞，可以以字段名稱為前綴。如果包括字段名稱，則僅搜索該元數據字段。否則，將搜索幾個字段（下面列出）。

例如：

基本搜尋
搜索字符串 將退還什麼
bird 帶有“bird在下面列出的字段中
name:bird 帶有“字樣”的視頻bird“ 在裡面name（標題）將被退回。

當您不提供要搜索的字段名稱時，請求將在以下字段中搜索該值：

  • id
  • name
  • description
  • long_description
  • text（不是真正的元數據字段，而是可用於搜索的偽字段name , description， 和long_description - 例如text:bird )
  • tags
  • reference_id
  • custom_fields（搜索所有自定義字段）
  • custom_field_name（搜索特定命名的自定義字段）

支持的搜索字段包括：

支援的搜尋欄位
欄位 合法價值
name 字串或以括弧括住的字串
文字 字符串或帶引號的字符串（搜索name , description， 和long_description )
tags 字符串或引號字符串（多個標籤應以逗號分隔）
custom_fields 字符串或帶引號的字符串（搜索所有自定義字段 - 您也可以使用特定的自定義字段內部的姓名）
reference_id 字串或引號字串
state ACTIVE , INACTIVE , PENDING , DELETED（只退還最近 10 天內刪除的視頻）
updated_at 日期時間或範圍（詳細信息如下）
created_at 日期時間或範圍（詳細信息如下）
schedule.starts_at 日期時間或範圍（詳細信息如下）
schedule.ends_at 日期時間或範圍（詳細信息如下）
published_at 日期時間或範圍（詳細信息如下）
complete true或者false

在上面顯示的兩個示例中，未包含“bird”仍可能會返回。下一節將說明如何將搜索結果限制為僅包含指定條款的視頻。

忽略的單字

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

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

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

什麼是詞幹？

支援具有共同搜尋字詞詞詞詞詞詞幹的字詞的視訊欄位。另外，詞幹僅支持輸入整個單詞，而不是部分單詞：

  • 範例 1：正在搜索running將返回包含以下內容的結果：running , run , runs
  • 範例 2：正在搜索vid不會返回包含以下內容的結果：video

詞幹搜索適用於以下領域：

  • custom_fields
  • description
  • name
  • long_description
  • tags
  • labels
  • variants

有一些修飾符可幫助您將搜索結果限制為所需的視頻。

搜索修飾符
修飾符 描述 範例
+ 在搜索詞前加上加號 (+) 表示返回的視頻必須有指定期限
  • +bird（返回僅有的帶有“的視頻bird“在上面列出的字段中）
  • +tags:bird（返回僅有的帶有“的視頻bird“ 在裡面tags )
-或者NOT 在搜索詞前加上減號 (-) 或NOT表示返回的視頻一定不有指定期限
  • -birds或者NOT birds（僅返回視頻不是有 ”bird“在上面列出的字段中）
  • -name:birds或者NOT name:birds（僅返回視頻不是有 ”bird“ 在裡面name )
(term) AND (term)
或者
(term) OR (term)		 合乎邏輯的AND和OR運算符允許您組合多個搜索詞以進行複雜查詢
  • (+name:heron) AND (+tags:bird)（會返回具有兩個都“heron“ 在裡面name和 ”bird“ 在裡面tags )
  • (+name:heron) OR (+tags:bird)（會返回具有任何一個“heron“ 在裡面name和 ”bird“ 在裡面tags )
  • ((+name:heron) AND (+tags:bird)) AND (NOT tags:internal)（會返回具有兩個都“heron“ 在裡面name和 ”bird“ 在裡面tags， 但不是標籤“internal ")

詞組搜索

您可以通過用引號將短語（而不是單個單詞）搜索：

  • "blue heron"
  • name:"blue heron"

日期/時間

您可以使用以下方法在日期時間間隔上進行搜索：

[{start} TO {end}]

要搜索單個日期/時間，請設置start和end相同的值：

[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]

日期時間值使用ISO 8601格式指定：

日期/時間格式
日期-時間 格式 範例
日期-時間 yyyy-MM-ddThh:mm:ss.sssZ 2019-09-30T14:24:33.512Z
通配符（可用於開始或結束日期/時間） *
  • 2019-09-30T14:24:33.512Z TO *
  • * TO 2019-09-30T14:24:33.512-4:00Z

以下是一些示例日期/時間搜索字符串。

樣本數據/時間搜索
搜尋字串 描述
+updated_at:[2019-09-30T00:00:00.000Z TO 2019-10-07T00:00:00.000Z] 2019年9月30日至2019年10月7日期間更新的視頻
+created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] 2019 年 9 月 30 日添加的視頻
+created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] 2019 年 9 月 30 日下午 2:00 至下午 4:30（UTC）添加的視頻
+created_at:[* TO 2019-09-30T00:00:00.000Z] 2019 年 9 月 30 日之前添加的視頻

已知問題

  • 重複結果：在某些情況下，搜索結果中的某些項目可能會出現不止一次。

    解決方法：為防止重複搜索結果，請始終使用sort搜索請求中的參數。