支持 聯繫支持 | 系統狀況 系統狀態

CMS API:視頻搜索v2

本主題說明了使用視頻搜索第2版的語法, CMS API.

簡介

版本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, descriptionlong_description -例如 text:bird)
  • tags
  • reference_id
  • custom_fields (搜索所有自定義字段)
  • custom_field_name (搜索特定的命名自定義字段)

支持的搜索字段包括:

支持的搜索字段
法律價值
name 字符串或帶引號的字符串
文本 字符串或帶引號的字符串(搜索 name, descriptionlong_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 or false

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

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

搜索修飾符
改變 產品描述 實例
+ 在搜索字詞前加上加號(+)表示返回的視頻 必須的, 有指定的期限
  • +bird (返回 只能 帶有“bird“在上面列出的字段中)
  • +tags:bird (返回 只能 帶有“bird“ 在裡面 tags)
- or NOT 在搜索詞前加上減號(-)或 NOT 表示返回的視頻 不得 有指定的期限
  • -birds or NOT birds (僅返回符合條件的視頻 有“bird“在上面列出的字段中)
  • -name:birds or NOT name:birds (僅返回符合條件的視頻 有“bird“ 在裡面 name)
(term) AND (term)
or
(term) OR (term)
邏輯上 ANDOR 運算符允許您組合多個搜索詞以進行複雜查詢
  • (+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}]

要搜索單個日期/時間,請設置 startend 值相同:

[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] 視頻更新時間為30年2019月7日至2019年XNUMX月XNUMX日
+created_at:[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z] 視頻添加於30年2019月XNUMX日
+created_at:[2019-09-30T14:00:00.000Z TO 2019-09-30T16:30:00.000Z] 在2年00月4日30:30 PM至2019:XNUMX PM(UTC)之間添加的視頻
+created_at:[* TO 2019-09-30T00:00:00.000Z] 在30年2019月XNUMX日之前添加的視頻

頁面最後更新於24年2020月XNUMX日