레이블 작업

서문

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

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

  이는 비디오 라이브러리를 구성하는 것이 목적인 경우 특히 중요합니다. 예를 들어 태그를 사용하여 동영상을 정리하려는 경우birdsfish , 및 같은 태그를 만들 수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/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마찬가지로 동영상을 검색할 수 있습니다. 소개에서 언급했듯이 검색 경로에 하위 레이블을 추가하면 검색 결과가 필터링됩니다.

제한 사항

• 계정에 최대 10,000 개의 레이블을 추가 할 수 있습니다.
• 레이블은 API를 통해서만 관리할 수 있습니다. 현재 UI에 옵션이 없습니다.
• 레이블별 검색은 현재 v1 검색 구문에서만 지원됩니다.
• 라벨은 ~ 아니다다음을 사용하여 제휴사에 공유되는 동영상 메타데이터에 포함됩니다. 미디어 공유 .