지원 지원 문의 | 시스템 상태 시스템 상태
페이지 내용

    라벨 작업

    이 주제에서는 다음을 사용하여 레이블을 작성, 관리 및 사용하는 방법을 학습합니다. CMS API.

    소개

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

    • 라벨은 계정 수준에서 생성되어 비디오에 적용됩니다.

      특히 비디오 라이브러리를 구성하려는 경우에 중요합니다. 예를 들어 태그를 사용하여 비디오를 구성하려는 경우 다음과 같은 태그를 만들 수 있습니다. birds, fishinsects. 그런 다음 모든 새 비디오를 쉽게 검색하고 찾아서 스마트 재생 목록을 만들 수 있습니다. 하지만 새 동영상을 추가 한 사용자가 실수로 입력하면 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/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 검색을 위해 지원되는 다른 필드와 마찬가지로. 소개에서 언급했듯이 검색 경로에 하위 레이블을 추가하면 검색 결과가 필터링됩니다.

    라벨 예로 검색
    샘플 검색 그것이 돌려주는 것
    q=labels:/nature 라벨 경로가 시작하는 모든 동영상 /nature
    q=labels:/nature/wildlife 라벨 경로가 시작하는 모든 동영상 /nature/wildlife
    q=labels:/nature/wildlife/avian 라벨 경로가 시작하는 모든 동영상 /nature/wildlife/avian

    제한 사항

    • 계정에 최대 10,000 개의 라벨을 추가 할 수 있습니다
    • 라벨로 검색하는 것은 현재 v1 검색 구문 만
    • 라벨은 지원 를 사용하여 제휴사와 공유하는 동영상 메타 데이터에 포함 미디어 공유.

    페이지 최종 업데이트 28 Sep 2020