入門
で使用されるビデオ検索のバージョン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
「関連するフィールドでは、引き続き返される可能性があります。次のセクションでは、検索結果を指定された用語を持つ動画のみに制限する方法について説明します。
高度な検索
検索結果を必要な動画に限定するのに役立つ修飾子がいくつかあります。
修飾子 | 説明 | 例 |
---|---|---|
+ |
検索語の前にプラス(+)記号を付けると、返された動画がしなければならない指定された用語を持っている |
|
- またはNOT |
検索語の前にマイナス(-)記号またはNOT 返されたビデオを意味しますしてはいけません指定された用語を持っている |
|
(term) AND (term) または (term) OR (term) |
論理的AND そしてOR 演算子を使用すると、複雑なクエリに対して複数の検索用語を組み合わせることができます |
|
フレーズ検索
引用符で囲むことにより、(単一の単語ではなく)フレーズを検索できます。
"blue heron"
name:"blue heron"
日付/時刻
以下を使用して、日時間隔で検索できます。
[{start} TO {end}]
単一の日時で検索するには、start
そしてend
同じ値に:
[2019-09-30T00:00:00.000Z TO 2019-09-30T00:00:00.000Z]
日時値は、ISO8601形式を使用して指定されます。
日付/時刻 | [ 形式] | 例 |
---|---|---|
日付/時刻 | yyyy-MM-ddThh:mm:ss.sssZ |
2019-09-30T14:24:33.512Z |
ワイルドカード(開始または終了の日付/時刻に使用できます) | * |
|
以下は、いくつかのサンプルの日付/時刻検索文字列です。
検索文字列 | 説明 |
---|---|
+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時から午後4時30分(UTC)の間に追加された動画 |
+created_at:[* TO 2019-09-30T00:00:00.000Z] |
2019年9月30日より前に追加された動画 |