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

    CMS /Playback API: 비디오 검색 v1

    이 항목에서는 다음을 사용하여 계정에서 동영상을 검색하는 방법에 대해 알아 봅니다. CMS API. 그만큼 CMS API 귀하의 동영상을 검색 할 수있는 프로그램 방식을 제공합니다. Video Cloud 도서관. 이 항목에서는 검색 구문에 대한 세부 정보를 제공합니다. 참고 : 이것은 원래 검색 구문입니다. 더 간단한 방법을 사용하는 것이 좋습니다. 비디오 검색 구문 v2.

    소개

    이 항목에서는 다음 작업을 수행하는 방법에 대해 설명합니다.

    • 다음을 사용하여 기본 검색을 만들고 제한하십시오. q 매개 변수
    • 검색 결과 정렬
    • 필수 및 제외 용어를 사용하여 검색
    • 따옴표로 묶인 검색을 사용하여 정확한 용어 및 여러 단어 일치
    • 사용자 정의 필드에서 검색
    • 특정 날짜 및 범위가있는 날짜 필드 검색
    • 검색 기준 결합

    API 사용

    검색 기능은 CMS API 또는 Playback API.

    CMS API

    검색을 CMS API, 다음이 적용됩니다 :

    • 모든 요청 (검색 포함)에는 액세스 토큰을 포함하는 인증 헤더가 필요합니다. 클라이언트 자격 증명을 얻고 액세스 토큰을 검색하는 데 사용하는 방법에 대한 자세한 내용은 Brightcove OAuth 개요.
    • 검색에서 반환되는 동영상의 최대 개수에는 제한이 없지만 속도 제한이 적용됩니다.
    • 검색 결과에는 계정의 모든 동영상, 재생 가능 여부 및 / 또는 지역 제한이 포함됩니다.

    API 요청 / 응답 세부 정보는 비디오 가져 오기 의 섹션 CMS API 참고.

    Playback API

    검색을 Playback API, 다음이 적용됩니다 :

    • 검색 요청은 Playback API 정책 키가 필요하다. 검색 가능.
    • 이있다 제한 검색에서 반환 된 최대 동영상 수
    • 검색 결과는 재생할 수있는 동영상 만 반환합니다 ( state:inactive 무시됩니다).
    • 검색은 결과에서 지역 제한 동영상을 생략하는 것과 같은 재생 정책 제한을 적용합니다.
    • 결과 캐싱은 더 높은 요청 속도와 더 빠른 응답을 제공하며 속도 제한은 없습니다.

    API 요청 / 응답 세부 정보는 비디오 가져 오기 의 섹션 Playback API 참고.

    미디어 라이브러리의 용어 검색을 수행하려면 q 매개 변수입니다.

          q={search terms}

    지정한 검색 용어는 공백으로 구분 된 용어로 인코딩 된 URL 목록이어야합니다.

    검색 지원 형태소. 줄기는 단어를 단어 root에 매핑하고 다른 단어는 같은 루트에서 나온 단어를 매핑합니다. 예를 들어 '실행'에 대한 검색은 지정된 입력란에서 '실행 중'또는 '실행 중'인 동영상과 일치해야합니다. 그것은 것 지원 "rune"은 루트로 "실행"하지 않기 때문에 "rune"과 일치합니다.

    검색어와 같은 한정어를 입력하지 않은 경우 q=bird요청은 다음 필드에서 해당 값을 검색합니다.

    • id [1-1]
    • name
    • description
    • long_description
    • text (실제 메타 데이터 필드는 아니지만 해당 필드를 검색하는 데 사용할 수있는 의사 필드 name, descriptionlong_description - 예. q=text:bird)
    • tags
    • reference_id
    • custom_fields (모든 사용자 정의 필드 검색)
    • custom_field_name (특정 이름이 지정된 사용자 정의 필드를 검색)[1-2]

    노트

    [1-1] 참고 : ID로 검색하는 것은 일관성을 위해 포함되지만 검색은 q=id:12345 요청과 정확히 같은 결과를 반환합니다. https://cms.api.brightcove.com/v1/accounts/{account_id}/videos/12345
    [1-2] 목록 유형의 맞춤 입력란이 있고 여러 값 중 하나가 포함 된 동영상을 반환하려면 다음과 같이하면됩니다.

    당신이 전화 한 필드가 있다고 가정 해 봅시다. color 그 값을 취할 수 있습니다 : red, green, yellowblue. 해당 필드가 값으로 설정된 동영상을 찾고 싶습니다. green or blue:

          q=color:green%20color:blue

    예 :이 요청은 다음 값을 갖는 동영상을 반환합니다. bird 위에 나열된 필드 중 하나 이상에서

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=bird 

    특정 속성으로 검색 제한

    검색어와 같은 한정어를 제공하면 q=name:bird요청이 동영상을 검색합니다. name ~의 값을위한 필드 bird.

    예 :이 요청은 다음 값을 갖는 동영상을 반환합니다. wildlife 에서 name 입력란입니다.

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=name:wildlife

    지원되는 검색 필드는 다음과 같습니다.

    지원되는 검색 필드
    분야 법적 가치
    name 문자열 또는 따옴표 붙은 문자열
    본문 문자열 또는 따옴표 붙은 문자열 ( name, descriptionlong_description)
    tags 문자열 또는 따옴표 붙은 문자열 (여러 태그는 쉼표로 구분해야 함)
    custom_fields 문자열 또는 따옴표 붙은 문자열 (모든 사용자 정의 필드 검색 - 특정 사용자 정의 필드 사용 가능 내부의 이름) [2-1]
    reference_id 문자열 또는 따옴표 붙은 문자열
    state ACTIVE, INACTIVE, PENDING, DELETED [2-3]
    updated_at 날짜 범위
    created_at 날짜 범위
    schedule.starts_at 날짜 범위
    schedule.ends_at 날짜 범위
    published_at 날짜 범위
    complete [2-2] true or false

    노트

    • [2-1] 그것은 지원 값이 없거나 값이없는 맞춤 입력란이있는 동영상을 검색 할 수 있습니다. null왜냐하면 필드에 값이 주어지지 않으면 비디오 메타 데이터에 전혀 포함되지 않기 때문입니다.
    • [2-2] 새 동영상을 만들 때 complete 속성이 자동으로 설정됩니다. false. 동영상에 대한 하나의 변환이 존재하면 즉시 complete 속성은 자동으로 true.
    • [2-3] 삭제 된 동영상 검색시 다음 제한 사항이 적용됩니다.
      • 삭제 된 비디오 검색 사용할 수있는 CMS API; Playback API 의지 지원 삭제 된 동영상을 반환하십시오.
      • 이전 10 일 동안 삭제 된 동영상 (현재 시간 - 10 일)이 반환됩니다.

    검색 결과 정렬

    그리고, sort 매개 변수를 사용하면 동영상 가져 오기 요청의 결과를 정렬 할 수 있습니다. 다음을 기준으로 정렬 할 수 있습니다.

    • reference_id
    • name
    • created_at
    • published_at
    • updated_at
    • schedule.starts_at
    • schedule.ends_at
    • state
    • plays_total
    • plays_trailing_week

    사용을 통해 결과를 명시 적으로 정렬하지 않을 때 sort, 결과는 용어 빈도 / 역 문서 빈도로 알려진 알고리즘에 따라 정렬됩니다. TF-IDF. 참조 여기를 클릭해 주세요 문의주시기 바랍니다.

    예를 들어 검색어를 검색한다고 가정 해 보겠습니다. coastal,city 귀하의 계정에 동영상 메타 데이터 어딘가에 해당 용어가있는 120 비디오가 있습니다 ( name, description, tags, 등), 결과의 정렬 기준과도 일치합니다 (예 : 모두 같은 값을 가짐). schedule_starts_at 날짜 시간). 비디오가 나타나는 결과의 높이는 메타 데이터에 하나 또는 두 개의 용어가 나타나는 빈도에 의해 결정되며 비디오 라이브러리 전체에서 가장 자주 나타나는 용어에 더 큰 가중치가 부여됩니다.

    필수 / 제외 용어

    필요에 따라 검색어를 표시 할 수 있습니다 (반환 된 동영상은 일치해야 함) 또는 제외되었습니다 (반환 된 동영상은 일치하지 않아야 함). 이것은 URI 인코딩으로 제어됩니다. + (%2B) or - 그 직전에 서명하십시오.

    반드시 인코딩해야합니다. + as %2B 필요한 용어를 나타내는 데 사용할 때.

    필수 / 제외 어
    URL 인코딩 됨 의미
    +foo %2Bfoo 동영상에는 용어가 포함되어야합니다 foo 에서 name, description, long_description, tags, reference_id or custom_fields
    +custom_fields:foo %2Bcustom_fields:foo 동영상은 반드시 값을 포함해야합니다. foo 일부 사용자 정의 필드 용
    +foo -bar %2Bfoo%20-bar 동영상에는 용어가 포함되어야합니다 foo 그러나 기간을 포함하면 안된다. bar 에서 name, description, long_description, tags, reference_id or custom_fields
    +name:foo -name:bar %2Bname:foo%20-name:bar 동영상에는 용어가 포함되어야합니다 foo 그러나 기간을 포함하면 안된다. bar 에서 name

    예 :이 요청은 값이있는 동영상을 반환합니다. sea 그러나 가치가 없다. lake 에서 tags 입력란입니다.

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=%2Btags:sea%20-tags:lake

    만나다 검색 기준 결합 아래에서 여러 검색어에 AND 로직을 적용하기 위해 필수 / 제외 구문을 사용하는 방법을 살펴보십시오.

    다른 매개 변수와 결합

    검색 ( q 매개 변수)를 다른 매개 변수와 결합 할 수 있습니다. sort, limitoffset. 모든 URL 매개 변수는 &. 매개 변수 순서는 중요하지 않습니다.

    예 :이 요청은 값이 있어야하는 동영상을 반환합니다. bar 에서 tag 입력란에 name 함유 가치 foo

          .../videos?q=name:foo%20%2Btags:bar&sort=updated_at

    예 :이 요청은 위와 동일한 동영상을 반환하지만 추가로 필드별로 결과를 정렬합니다. updated_at 그 결과를 단지 10 비디오로 제한합니다.

          .../videos?sort=updated_at&q=name:foo%20%2Btags:bar&limit=10

    인용 된 검색어

    기본적으로 검색은 유사한 단어를 검색어와 일치시킵니다. 여러 단어를 일치 시키려면 용어를 따옴표로 묶으십시오.

    대부분의 브라우저와 다른 에이전트는 문자 그대로 따옴표를 사용합니다 ("...") 올바르게 입력 할 수 있지만 인용 된 검색어가 올바른 결과를 반환하지 않는 것으로 보이는 경우에는 따옴표를 %22 (%22...%22)

                
                  q="foo" or q=%22foo%22
                  q="foo%20bar" or q=%22foo%20bar%22
                
              

    특정 필드를 검색 할 때도 작동합니다.

                
                  q=name:"home"
                  q=name:"home%20run"
                
              

    여러 단어

    예 :이 요청은 다음 중 하나의 값을 갖는 동영상을 반환합니다. sea or mammal 에서 tags 입력란입니다.

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=tags:sea,mammal

    그러나 다음 요청은 태그가있는 동영상 만 반환합니다. sea,mammal.

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=tags:"sea,mammal"

    사용자 정의 필드

    비디오에 대해 정의한 사용자 정의 필드를 검색 할 수 있습니다.

          q=my_field:foo
          q=my_field:"foo"

    참고 : 모든 사용자 정의 필드 값은 문자열로 처리됩니다. 예를 들어 값을 사용할 수있는 목록 유형 사용자 정의 필드가있는 경우 true or false검색은 부울 값이 아닌 해당 문자열을 검색합니다 (많은 프로그래밍 언어에서, 10 서로 바꾸어 쓸 수있다. truefalse 부울 값으로 사용하지만 검색은 q=my_boolean_field:1 가지고있는 동영상을 반환하지 않습니다. my_boolean_field 로 설정 true).

    예 :이 요청은 다음 값을 갖는 동영상을 반환합니다. 동물 에서 subject 사용자 정의 필드.

          https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=subject:animal

    기간

    날짜 필드에서 검색하는 경우 시작 날짜와 종료 날짜를 구분하는 데 두 개의 마침표를 사용하여 특정 날짜 또는 날짜 범위를 지정할 수 있습니다 (q=updated_at:2018-01-01..2018-02-01).

    이렇게하면 동영상이있는 모든 동영상을 검색합니다. updated_at 8 월 1, 2012 및 10 월 8, 2012 사이의 값입니다. 여기서 우리는 UTC 형식으로 각 날짜를 지정합니다.

          q=updated_at:2012-08-01T00:00:00Z..2012-10-08T23:59:59Z

    시간 구성 요소를 삭제하여이 검색을 단순화 할 수 있습니다. 다음은 위의 검색과 동일합니다.

          q=updated_at:2012-08-01..2012-10-08

    지원되는 날짜 형식

    지원되는 날짜 형식에는 UTC 및 상대 날짜가 포함됩니다.

    날짜 형식 예제
    형식 (URI 인코딩 형식) 의미
    2015-08-01T06:15:00Z 이것은 UTC로 표시된 시간을 나타냅니다.
    2012-08-01 이것은 UTC로 표시 한 자정을 나타냅니다. 이 예제는 2012-08-01T00와 같습니다. 00 : 00Z
    -1d 현재 시간에서 1 일을 뺀 값입니다. (만나다 이하)

    상대 날짜

    상대 날짜의 경우 방향을 지원합니다 ( + or -) 뒤에 숫자가오고 지속 시간이옵니다. 상대 날짜는 항상 현재 시간부터 측정됩니다. 법률 기간은 분, 시간, 일입니다.

    예 :

    상대 날짜 샘플
    날짜에 대한 매개 변수 의미
    q = updated_at : -1day..NOW 1 일 전날 현재 날짜로 업데이트 된 동영상
    q = created_at : -2days 2 일 전 비디오 추가됨
    q = updated_at : -4hours..NOW 4 시간 전부터 현재 시간까지 업데이트 된 동영상
    q = created_at : -60minutes .. 60 분 전부터 현재 시간까지 추가 된 동영상
    q = created_at : 2016-01-01 ..- 1d 1 월 1, 2015에서 1 일 전으로 생성 된 동영상
    q = updated_at : -14d..NOW 지난 2 주간의 동영상

    개방형 범위

    주어진 시간까지 모든 날짜를 일치 시키거나 주어진 시간 이후의 모든 날짜와 일치 시키려면 범위의 한쪽 끝을 비워 둡니다.

    예 : 지난 2 일 동안 수정 된 모든 동영상 검색

          q=updated_at:-2days..
          
          

    예 : 8 월 이후 또는 8 월 이후에 수정 된 모든 동영상 검색 11, 2013 :

          q=updated_at:2013-08-11T00:00:00Z..
          
          

    NOW 일정 날짜에 대한 연산자

    schedule.starts_atschedule.ends_at, 당신이 사용할 수있는 NOW 날짜 값으로. 이 연산자는 현재 날짜 - 시간을 기반으로 동적 쿼리를 설정할 수있는 편리한 연산자입니다. 몇 가지 예 :

    일정 데이터 예제
    출발 / 도착 매개 변수 URI로 인코딩 된 의미
    ? q = schedule.starts_at : .. 지금 ? q = schedule.starts_at : .. 지금 starts_at는 처음부터이 순간까지입니다.
    ? q = schedule.starts_at : 지금 ? q = schedule.starts_at : 지금 starts_at은이 순간부터입니다.
    ? q = schedule.ends_at : 지금 .. ? q = schedule.ends_at : 지금 .. ends_at은이 순간부터 끝까지입니다.
    ? q = + schedule.starts_at : .. NOW + schedule.ends_at : NOW .. ? q = % 2Bschedule.starts_at : .. NOW % 20 % 2Bschedule.ends_at : NOW .. 이 순간 이전에 starts_at이고이 순간 이후에 ends_at가됩니다 (동영상이 이번 일정에 있음).

    검색 기준 결합

    복잡한 검색을위한 기준을 결합 할 수 있습니다.

    예 :이 요청은 name 의 가치 잡담8 월 1, 2010 및 10 월 8, 2010 사이에서 업데이트되었습니다. 그런 다음 응답 데이터를 updated_at 날짜가 내림차순으로 표시됩니다.

          q=%2Bname:gossip%20%2Bupdated_at:2010-08-01..2010-10-08&sort=-updated_at

    용어 결합

    사용 필수 / 제외 구문 가지고있는 동영상을 반환하는 모든 지정된 용어의.

    예를 들어 다음을 검색 할 경우 :

          q=name:foo +tags:bar (URI-encoded: q=name:foo%20%2Btags:bar)

    응답에는 'bar'태그가있는 동영상이 포함되며 foo 이름으로. 가지고있는 동영상 만 반환하려면 foo 이름과 태그 'bar'에 다음을 검색해야합니다.

          (unencoded) q=+name:foo +tags:bar (URI-encoded) q=%2Bname:foo%20%2Btags:bar

    마찬가지로, 귀하가 가지고있는 비디오 만 반환하려는 경우 foo 이름으로,하지만 할 지원 태그 'bar'가 있으면 다음과 같이 검색합니다.

          (unencoded) q=+name:foo -tags:bar (encoded) q=%2Bname:foo%20-tags:bar

    샘플 : 용어 결합
    인코딩되지 않은 검색 문자열 URI로 인코딩 된 검색 문자열 의미
    q=foo bar q=foo%20bar 반환 된 항목에는 "foo"또는 "bar"가 있습니다.
    q=foo +bar q=foo%20%2Bbar 반환 된 항목에는 "bar"가 있어야하고 "foo"가 있어야합니다.
    q=+foo bar q =%2Bfoo%20bar 반환 된 항목에는 "foo"가 있어야하고, "bar"
    q=+foo +bar q=%2Bfoo%20%2Bbar 반환 된 항목에는 "foo"및 "bar"가 있어야합니다.
    q=-foo +bar q=-foo%20%2Bbar 반환 된 항목에는 "bar"가 있어야하고 "foo"가 없어야합니다.
    여러 태그 검색
    q=tags:bee,bop q=tags:bee,bop 태그 "bee"OR "bop"이있는 동영상을 반환합니다.
    q=tags:bee tags:bop q=tags:bee%20tags:bop 태그 "bee"OR "bop"이있는 동영상을 반환합니다.
    q=+tags:bee tags:bop q=%2Btags:bee%20tags:bop 반환 된 모든 동영상에는 태그 "bee"가 있어야합니다. 그들은 "bop"태그도 가질 수 있습니다.
    q=+tags:bee +tags:bop q=%2Btags:bee%20%2Btags:bop 반환 된 모든 동영상에는 태그 "꿀벌"이 있고 태그에는 "밥"

    특정 동영상 검색

    특정 동영상 세트로 검색을 제한하려면 검색을 수행 할 수 있습니다. id:

    예 :이 요청은 ID가있는 동영상을 반환합니다. 123456789, 98765432148376387

          q=id:123456789%20id:987654321%20id:48376387

    주별 검색

    다음 매개 변수를 사용하여 동영상 상태별로 검색을 수행하거나 필터링 할 수 있습니다.

          q=state:ACTIVE( | INACTIVE | PENDING | DELETED)[3]

    노트

    • [3] 삭제 된 동영상 검색은 지난 10 일 (현재 시간에서 10 일) 동안 삭제 된 동영상과 CMS API ( Playback API).

    줄기

    줄기 제거가 지원되지만 지원 부분 단어 검색. 예를 들어, q=name:ban 이름이 'Parking Ban Announced"나"Parking to be Banned"나"City Banning Parking" 하지만 "Bank Holiday"나"Bandit Captured".

    공백 / 특수 문자

    그리고, CMS API 일반적으로 몇 가지 예외를 제외하고 검색 문자열에서 특수 문자를 처리합니다.

    • 공백은 허용되지 않으며 다음과 같이 인코딩되어야합니다. %20. (인코딩되지 않음 + 표지판은 공백을 대체 할 수도 있지만 검색어가 혼란 스러울 수 있습니다. + 용어가 필요하다는 것을 나타낼 수도 있습니다. 만나다 필수 / 제외 구문)

      예를 들어 이름에서 '내 좋아하는 동영상'을 검색하려면 다음을 입력하십시오.

      q=name:"my%20favorite%20video"

    • 리터럴을 검색하려면 + 서명하거나 + 반환 된 동영상이 절대로 필요한 것 용어를 포함 시키려면 + as %2B:

      포함해야하는 동영상 검색 "two+two" 이름 필드에

      q=name:two%2Btwo

      포함해야하는 동영상 검색 "heron" 이름 필드에

      q=%2Bname:heron

    • 일부 에이전트는 리터럴 따옴표를 올바르게 처리하지 못할 수 있으므로 인코딩하는 것이 더 안전합니다. "foo" as %22foo%22

    일회성 요청의 경우 Brightcove Learning의 문자열 인코더 검색 문자열을 인코딩 할 수 있습니다. 앱의 경우 사용하는 언어로 URI 인코딩 기능을 찾아야합니다.

    검색어 검색

    클립은 다른 비디오 섹션에서 만들어진 비디오입니다. 클립은 다음에 의해 생성 될 수 있습니다. Brightcove 소셜앞으로는 다른 방법을 사용할 수있게 될 것입니다. 계정에서 생성 된 클립을 찾는 데 사용할 수있는 몇 가지 특별한 검색어가 있습니다.

    • q=%2Bis_clip:true - 클립 만 반환합니다.
    • q=%2Bis_clip:false - 비 클립 만 반환합니다.
    • q=%2Bclip_source_video_id:video_id - 지정된 비디오에서 생성 된 클립을 반환합니다.

    무시 된 단어

    특정 단어는 검색 문자열에서 무시되므로 너무 많이 사용되어 실제로 검색 한 것과 관련이없는 많은 결과를 반환 할 수 있습니다. 다음은 검색으로 무시되는 단어의 목록입니다.

    "있는", "있는", "있는", "있는", "있는", "있는", "있는", "있는", "있는", "안에있는" 에 ","그 ","그 ","그 ","그들의 ","그때 " "거기", "이", "그들", "이", "~에", "있었다", "의지", "함께"

    알려진 문제

    • 중복 결과 : 경우에 따라 검색 결과의 일부 항목이 두 번 이상 나타날 수 있습니다.

      해결 방법 : 중복 검색 결과를 방지하려면 항상 sort 매개 변수를 검색 요청에 추가하십시오.


    페이지 마지막 업데이트 : 24 Oct 2020