サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    ラベルの操作

    このトピックでは、CMS API を使用してラベルを作成、管理、および使用する方法について説明します。

    はじめに

    ラベルはタグに似ています。それらをビデオに追加してから、それらを使用してビデオのグループを検索することができますが、いくつかの明確な利点があります。

    • ラベルはアカウントレベルで作成され、動画に適用されます。

      これは、ビデオライブラリを整理することが目的である場合は特に重要です。たとえば、タグを使用してビデオを整理しようとしている場合は、次のようなタグを作成できます。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更新要求と同じエンドポイントに送信された要求。そのサブラベルで終わるパス（および追加のサブラベルを持つパス）のみが削除され、上位レベルのラベルは保持されます。

    たとえば、次の3つのラベルパスがあるとします。

    
      /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上記の最初のパスは削除されますが、3番目のパスには影響しません。

    ビデオへのラベルの追加と更新

    フルラベルパスの配列としてビデオにラベルを追加します。

    [
      "/nature/wildlife/avian/coastal_birds",
      "/nature/wildlife/avian/coastal_birds/sandpipers"
]

    ラベル配列はに含めることができますビデオの作成（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

    制約事項

    • アカウントには最大10,000個のラベルを追加できます
    • ラベルによる検索は現在、 v1検索構文のみ
    • ラベルはないを使用してアフィリエイトに共有されるビデオメタデータに含まれていますメディア共有。