サポート サポート問い合わせ先 | システムステータス システムステータス

CMS API :動画検索v2

このトピックでは、CMS API でサポートされている動画検索のバージョン2を使用するための構文について説明します。

概要

CMS API で使用される動画検索のバージョン2は、構文を簡素化し、使用を簡単にします。

使用する構文の選択は、適切な URL パラメータを選択するだけの簡単なことです。

  • 新しいv2検索を使用するには:
        .../videos?query={search_string}
  • 元の検索を使用するには:
        .../videos?q={search_string}

基本原則

検索文字列の基本要素は検索用語で、フィールド名の前に付けることができます。フィールド名が含まれている場合、そのメタデータフィールドのみが検索されます。それ以外の場合、いくつかのフィールド(以下にリスト)が検索されます。

例として:

基本的な検索
検索文字列 返される結果
bird 以下のフィールドにあるbirdという単語を含む動画
name:bird name (タイトル)に「bird」という単語が含まれる動画が返されます。

検索するフィールド名を指定しない場合、リクエストは次のフィールドでその値を検索します。

  • 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 or false

上記の両方の例で、次の単語を含まない動画は「bird」、任意の関連フィールドでまだ返される可能性があります。次のセクションでは、指定した用語が含まれる動画のみに検索結果を制限する方法について説明します。

検索結果を必要な動画だけに制限するための修飾子がいくつかあります。

検索修飾子
変更 説明
+ 検索語の前にプラス(+)記号を付けると、返された動画に指定された語が必要である ことを示します
  • +bird (「bird」と上記のフィールドにある動画)のみを返します
  • +tags:birdtagsの中に「bird 」がある動画のみを返します)
- or NOT 検索語の前にマイナス(-)記号または NOT を付けると、返された動画に指定した単語が含まれていてはならないことを示します
  • -birds または NOT birds (上記のフィールドに 「bird 」がない動画のみ返します)
  • -name:birds または NOT name:birdsnameの中に「bird」が入っていない動画のみ返します)
(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}]

単一の日付/時刻で検索するには、 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] 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時2019分(UTC)の間に追加された動画
+created_at:[* TO 2019-09-30T00:00:00.000Z] 30年2019月XNUMX日より前に追加された動画

ページの最終更新日:24年2020月XNUMX日