ラベル

外部公開ターゲットにラベルを追加する際、どのビデオ、チャンネル、チャンネルセットを外部に公開するかを指定することができます。加えて、ビデオライブラリの整理、ビデオの検索、そして目的とする分析の取得にもラベルは役立ちます。

ラベルの作成

[POST] /v2/labels 
{ 
   properties
} 
   

ラベルのフルネームを使った複数のラベルの作成

ラベルのフルパスはCGIエスケープ(URLエンコード)された文字列で、”/”で始めなければいけません。パスのすべてのコンポーネントを作成します。

[POST] /v2/labels/by_full_path//full/path/label1,/full/path/label2,... 
   

ラベルの一覧表示

[GET] /v2/labels
   

ラベルに割り当てられたアセットの取得

[GET] /v2/labels/label_id/assets
   

ラベル情報の表示

[GET] /v2/labels/label_id
   

フルパス名でラベル情報を見る

ラベルのフルパスはCGIエスケープ (URLエンコード)された文字列にしてください。パスが存在しなければ、サービスは400を返します。レスポンス本体はパスのどのコンポーネントがすでに存在しているか、または喪失しているかを表します。

[GET] /v2/labels/by_full_path//full/path/label1,/full/path/label2
   

ラベルの削除

[DELETE] /v2/labels/label_id
   

ルート属性

次の表はルートに表示されるすべて属性を示しています。

ルート属性 説明
label_id

ラベルのID。ラベル一覧を取得するために、/v2/labelsルート対してGETを実行します

タイプ:文字列

デフォルト:なし

例:/labels/r28ertfe44ea4e648fd07d4509123254

プロパティ

次の表はラベルと関連付けることができるすべてのプロパティを示しています。

プロパティ 説明 必須?
asset_count

読み取り専用。ラベルを使用しているアセットの数を指定します。特定のラベルIDに対してGETリクエストを行ったときに返されます。

タイプ:整数

例:42

いいえ
full_name

ラベルへのフルパス。親も含む。

タイプ:文字列

例:"/Sports/Motorcycle Racing"

はい
id

読み取り専用。ラベルのID。

タイプ:文字列

例:"814efb109416490a98ee3f4fcd673244"

はい
items

ラベルを含む配列/v2/labelsへのGETリクエストにより返されます。

タイプ:配列

例: n/a

いいえ
name

ラベルの名前。非ラテン文字を使うには、UTF-8とかつURIエンコードされていることを確認してください。

タイプ:文字列

例:"Motorcycle Racing"

はい
parent_id

親ラベルのID。

タイプ:文字列

条件:子ラベルを親ラベルに追加する時に必要となります。

例:"Sports"

条件付き

これ例はトップレベルラベルを作成します。

 [POST] /v2/labels
	{
		"name":"Hobbies"
	}
    

Backlot は次のようなレスポンスを返します。

	{
  "name": "Hobbies",
  "id": "d5751b77a0c24972888bf906734d4522",
  "full_name": "/Hobbies",
  "parent_id": null
} 
    

Sorting 試行する

この例は子ラベルを親ラベルに追加します。

[POST] /v2/labels
{
  "name": "Hockey",
  "parent_id": "d5751b77a0c24972888bf906734d4522"
}
    

Backlot は次のようなレスポンスを返します。

{
  "name": "Hockey",
  "id": "85042f300fc143c093e8f4ee01894355",
  "full_name": "/Hobbies/Hockey",
  "parent_id": "d5751b77a0c24972888bf906734d4522"
}
    

Sorting 試行する

この例は1度のコールでフルパス名で指定される複数のラベルを作成します。
[POST] /v2/labels/by_full_path//sports/football/NFL,/animal videos/buffaloes
 

Sorting 試行する

この例はすべてのラベルを一覧表示します。

[GET] /v2/labels
    

Backlot は次のようなレスポンスを返します。

{
  "items": [
    {
      "name": "Sports",
      "id": "814efb109416490a98ee3f4fcd6784cf",
      "parent_id": null,
      "full_name": "/Sports"
    },
    {
      "name": "Motorcycle Racing",
      "id": "bace921fdea44cc18a5a273155514522",
      "parent_id": "814efb109416490a98ee3f4fcd673244",
      "full_name": "/Sports/Motorcycle Racing"
    },
    {
      "name": "Hockey",
      "id": "85042f300fc143c093e8f4ee01894355",
      "parent_id": "d5751b77a0c24972888bf906734d8c34",
      "full_name": "/Hobbies/Hockey"
    },
    {
      "name": "Hobbies",
      "id": "d5751b77a0c24972888bf906734d4522",
      "parent_id": null,
      "full_name": "/Hobbies"
    }
  ]
}
    

Sorting 試行する

この例はラベルを削除します。

[DELETE] /v2/labels/85042f300fc143c093e8f4ee01894355
    

Backlot は200のレスポンスを返します。

Sorting 試行する

この記事はお役にたちましたか?