賃貸システムの概要
ラベルはタグに似ています。 それらをビデオに追加し、それらを使用してビデオのグループを検索することができますが、いくつかの明確な利点があります。
-
ラベルはアカウントレベルで作成され、動画に適用されます。
これは、ビデオライブラリの整理を目的とする場合に特に重要です。たとえば、タグを使用して動画を整理しようとしている場合は、次のようなタグを作成できます。
birds
,fish
&insects
。 次に、すべての鳥のビデオを簡単に検索して見つけ、それらのスマートプレイリストを作成します。 しかし、ユーザーが新しいビデオを誤って追加した場合、bird
birds
、あなたは今新しいタグを持っており、ビデオはあなたに属していませんbirds
コレクション。というラベルを作成した場合
birds
代わりに、そのラベルのみを動画に追加できます。 誤って存在しないラベルを追加することはできませんbirds
を代わりにお使いください。 -
ラベルは、次のような階層パスとして作成されます
/nature/birds/shore_birds
.つまり、部分パスまたは完全パスを検索(またはそれに基づいてプレイリストを作成)できます。
q=labels:/nature
-ラベルが付いているすべての動画を返しますnature
q=labels:/nature/birds
-を返しますbirds
のサブグループnature
ビデオq=labels:/nature/birds/shore_birds
-を返しますshore_birds
のサブグループ/nature/birds
ビデオ
ラベルの作成と管理
アカウントのラベルは、 CMS API /v1/accounts/{account_id}/labels
エンドポイント
以下に示すすべてのAPIエンドポイントがCMSベースURLに追加されることに注意してください。
https://cms.api.brightcove.com
ラベルを作成する
新しいラベルを作成するには、フルパスを POST
リクエスト:
サンプルリクエストエンドポイント
/v1/accounts/1234567890/labels
サンプルリクエストボディ
{
"path": "/nature/birds/shore_birds/"
}
注意してください を パスに存在しないラベルが作成されます。 別のグループを追加したい場合 forest_birds
、あなたは送るでしょう:
{
"path": "/nature/birds/forest_birds/"
}
今回は、 forest_birds
サブラベルが作成されます。 nature
および birds
すでに存在しています。
同様に、新しいサブグループを追加したい場合 sandpipers
〜へ shore_birds
、あなたは送るでしょう:
{
"path": "/nature/birds/shore_birds/sandpipers"
}
サンプルレスポンス
{
"path": "/nature/birds/shore_birds/sandpipers/"
}
ラベルを取得する
アカウントのすべてのラベルを取得するには、 GET
リクエスト:
サンプルリクエストエンドポイント
/v1/accounts/1234567890/labels
サンプルレスポンス
{
"account_id": "57838016001",
"labels": [
"/nature/birds/",
"/nature/birds/shore_birds/",
"/nature/birds/forest_birds/",
"/nature/mammals/seamammals/"
],
"version": 4
}
ラベルを更新する
ラベルを更新するには、 PATCH
リクエストを実行してあなたのアカウント内のプレイリストの数を取得することもできます:
/v1/accounts/{account_id}/labels/by_path/{path}
サンプルリクエストエンドポイント
/v1/accounts/1234567890/labels/by_path//nature/birds/shore_birds
サンプルリクエストボディ
{
"new_label": "coastal_birds"
}
なお、 new_label
値は、 {path}
リクエストに含まれています。 だから代わりにあなたが交換したかったら /birds
/avian
、リクエストと本文は次のようになります。
エンドポイント
/v1/accounts/1234567890/labels/by_path//nature/birds/
ボディをリクエストする
{
"new_label": "avian"
}
このリクエストの後、 coastal_birds
パスがなる /nature/wildlife/avian/coastal_birds
。 階層内の追加のサブラベルのパスは変わるため、 /nature/birds/forest_birds
になる /nature/wildlife/avian/forest_birds
応答には、更新されたラベルの数が含まれます。
サンプルレスポンス
{
"path": "/nature/avian",
"labels_updated": "2"
}
ラベルを削除する
ラベルを削除するには、 DELETE
更新リクエストと同じエンドポイントに送信されたリクエスト。 そのサブラベルで終わるパス(および追加のサブラベルを持つパス)のみが削除され、上位レベルのラベルは保持されます。
たとえば、次のXNUMXつのラベルパスがあるとします。
/nature/wildlife/avian/coastal_birds
/nature/wildlife/avian/coastal_birds/sandpipers
/nature/wildlife/avian/forest_birds
を送信しています DELETE
要求する /v1/accounts/1234567890/labels/by_path//nature/wildlife/avian/coastal_birds
上記の最初のパスは削除されますが、XNUMX番目のパスには影響しません。
ビデオへのラベルの追加と更新
ラベルをフルラベルパスの配列として動画に追加します。
[
"/nature/wildlife/avian/coastal_birds",
"/nature/wildlife/avian/coastal_birds/sandpipers"
]
labels配列は、 ビデオの作成(POST)リクエスト または ビデオの更新(PATCH)リクエスト.
動画ラベルを更新するには、更新された完全な動画配列を ビデオの更新(PATCH)リクエスト。 したがって、たとえば、 /nature/wildlife/avian/forest_birds
、あなたは配列を送るでしょう:
[
"/nature/wildlife/avian/coastal_birds",
"/nature/wildlife/avian/coastal_birds/sandpipers",
"/nature/wildlife/avian/forest_birds"
]
ラベルによる動画の検索
あなたはビデオを検索することができます labels
検索でサポートされている他のフィールドと同じように。 概要で述べたように、検索パスにサブラベルを追加すると、検索結果がフィルタリングされます。
サンプル検索 | それが返すもの |
---|---|
q=labels:/nature |
で始まるラベルパスを持つすべての動画 /nature |
q=labels:/nature/wildlife |
で始まるラベルパスを持つすべての動画 /nature/wildlife |
q=labels:/nature/wildlife/avian |
で始まるラベルパスを持つすべての動画 /nature/wildlife/avian |