레이블 작업

서문

라벨은 태그와 유사합니다. 동영상에 추가 한 다음이를 사용하여 동영상 그룹을 검색하거나 몇 가지 뚜렷한 이점이 있습니다.

• 라벨은 계정 수준에서 생성되고 동영상에 적용됩니다.

  이는 특히 비디오 라이브러리를 구성하는 것이 목적인 경우에 중요합니다. 예를 들어 태그를 사용하여 비디오를 구성하려는 경우 다음과 같은 태그를 만들 수 있습니다. 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업데이트 요청과 동일한 엔드 포인트로 전송 된 요청입니다. 하위 레이블로 끝나는 경로 (및 추가 하위 레이블이있는 경로) 만 삭제되고 상위 수준 레이블은 유지됩니다.

예를 들어 다음 세 가지 레이블 경로가 있다고 가정합니다.

      /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검색이 지원되는 다른 필드와 마찬가지로. 소개에서 언급했듯이 검색 경로에 하위 레이블을 추가하면 검색 결과가 필터링됩니다.

제한 사항

• 계정에 최대 10,000 개의 레이블을 추가 할 수 있습니다.
• 레이블 검색은 현재 v1 검색 구문 만
• 라벨은아니다음을 사용하여 제휴사와 공유되는 비디오 메타 데이터에 포함됩니다. 미디어 공유 .