使用標示

在本主題中,您將學習如何使用 CMS API 建立、管理和使用標籤。

簡介

標籤類似於標籤。您可以將它們添加到視頻中,然後使用它們搜索一組視頻,或者它們具有一些明顯的優勢:

  • 標籤是在帳戶一級創建的,並應用於視頻。

    這一點很重要,特別是在您要組織視頻庫的情況下。例如,如果您嘗試使用標籤來組織視頻,則可以創建諸如birdsfishinsects。然後,很容易搜索並找到您所有的鳥類視頻,並為其創建一個智能播放列表。但是,如果用戶添加新視頻時不小心輸入了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子標籤將被創建,因為naturebirds已經存在。

同樣,如果您想添加一個新的子組sandpipersshore_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/avian/coastal_birds。對於層次結構中的任何其他子標籤,路徑都會更改,因此/nature/birds/forest_birds會成為/nature/avian/forest_birds

響應將包括已更新的標籤數。

範例回應
{
  "path": "/nature/avian",
  "labels_updated": "2"
}

刪除標籤

刪除標籤使用DELETE請求發送到與更新請求相同的端點。僅刪除以該子標籤結尾的路徑(以及具有其他子標籤的路徑),而保留較高級別的標籤。

例如,假設您具有以下三個標籤路徑:


      /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會刪除上面的第一個路徑,但不會影響第三個路徑。

向視頻添加和更新標籤

將標籤添加為視頻的完整標籤路徑數組:

[
      "/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個標籤
  • 標籤只能使用 API 進行管理。UI中目前沒有選項
  • 標籤目前支持按標籤搜索僅v1搜索語法
  • 標籤是包含在視頻元數據中,並使用媒體分享