지원 지원 문의 | 시스템 상태 시스템 상태

개요 : 치수, 필드 및 매개 변수

측정 기준은 다음에 대한 주요 데이터 카테고리입니다. Analytics API 데이터 보고서. 이 주제에서는 차원에 대해 대화식으로 안내하고 리턴 할 수있는 필드를 제공합니다. 또한 보고서에 결합 할 수있는 차원과 다양한 조합에 사용할 수있는 필드를 보여줍니다.

치수 및 필드

측정 기준은 분석을위한 주요 데이터 버킷입니다. 개별 치수에 대한 전체 가이드를 보려면 아래 목록에서 치수 이름을 클릭하십시오.

아래에서 치수를 선택하면 반환 할 수있는 입력란을 볼 수 있습니다. 또한 요청을하다 버튼을 클릭하여 샘플 요청을하고 결과를 확인하십시오. 호환되지 않는 여러 치수를 선택하면 해당 효과에 대한 메시지가 표시됩니다.

입력

보고 할 차원을 선택하십시오.

반환 할 필드 :

(샘플 Brightcove 계정 사용)

산출

가장 일찍 from 이 측정 기준 조합의 날짜 :  

샘플 API 요청 :

응답 데이터

  Response will appear here...

노트

  1. 기본적으로, video_view 반환되는 유일한 필드입니다. 다른 필드는 값이 지정된 경우에만 반환됩니다. fields 매개 변수입니다.
  2. 측정 기준 또는 측정 기준 조합에 대해 지원되지 않는 반환 할 입력란을 지정하면 UNSUPPORTED_FIELD_COMBINATION_ERROR 오류가 반환됩니다.
  3. 그리고, bytes_delivered 필드는에서 제공 한 모든 데이터를 포함합니다 Video Cloud 비디오 데이터, 이미지, 텍스트 트랙 및 기타 자산을 비롯하여 고객에게 player 코드 자체. 이 데이터 중 일부는 CDN에서 가져 오며 최대 3 일 동안 사용하지 못할 수 있습니다.
  4. 표시된 필드 이외에 video 측정 기준으로 돌아올 수도 있습니다. video.custom_fields.{field_name}

요청 예

여러 측정 기준에 대한 보고서를 가져 오는 일반적인 사용 사례 : 데스크톱과 휴대 기기 간 동영상보기를 분석하고 iOS 기기와 Android 기기간에 모바일 기기 조회수가 얼마나되는지, 얼마나 많은 데스크톱이 있는지 알고 싶습니다. Windows 컴퓨터 대 맥에서보기가있었습니다. 현재 Studio Analytics Module에는이 정보를 제공하는 표준 보고서가 없지만이 정보를 통해 얻을 수 있습니다. Analytics API 요구:

  https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

(이 경우 1 월 1에서 1의 4 월 2014까지의 기간 동안 동영상 조회수를 요청하고 있습니다.)

cURL을 사용한 예

다음을 사용하여 API를 시험해보고 싶다면 여기에 몇 가지 메모가 있습니다.

견본

다음은 샘플 cURL 명령입니다.

  curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
  "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

대체하는 경우 $ACCESS_TOKEN 유효한 액세스 토큰으로 $ACCOUNT_ID 계정 ID로이 요청이 작동해야합니다. 당신이 사용할 수 있습니다 이 샘플 앱 액세스 토큰을 생성합니다.

지원되는 치수 조합

빠른 참조를 위해 아래 표는 지원되거나 지원되지 않는 치수 조합을 보여줍니다. 두 개 이상의 차원을 사용할 수있는 경우가 있습니다. 당신은 이것을 사용하여 치수 및 필드 위의 도구.

지원되는 차원 조합
account browser_type city country date date_hour destination_domain destination_path device_os device_manufacturer device_type live_stream player referrer_domain region search_terms social_platform source_type video
account N / A 예 예 예 예 예 예 예 예 예 예 예 예 예 예 예 예
browser_type 예 N / A 예 예
city 예 N / A 예 예 예 예
country 예 예 N / A 예 예 예 예 예 예
date N / A
date_hour N / A
destination_domain 예 예 예 N / A 예 예
destination_path 예 예 예 N / A
device_os 예 예 예 예 N / A 예 예 예
device_manufacturer 예 예 예 N / A
device_type 예 예 예 예 N / A 예 예 예
live_stream 예 예 N / A
player 예 예 예 예 예 예 예 N / A 예 예 예
referrer_domain 예 예 예 예 N / A 예 예 예
region 예 예 예 예 예 예 예 N / A
search_terms 예 예 예 예 N / A 예
social_platform 예 예 N / A 예
source_type 예 예 예 예 예 예 N / A 예
video 예 예 예 예 예 예 예 예 예 예 예 N / A

매개 변수

다음은 사용 가능한 매개 변수를 요약 한 표입니다. Analytics API. 매개 변수의 사용은 다음 절에서보다 자세히 설명합니다.

매개 변수 필수 설명 마케팅은: 태만

계정

그리고, Video Cloud 보고서를 사용하려는 계정은 accounts 매개 변수. 예 :

  https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

필터 위치

필터의 일반적인 구문은 다음과 같습니다.

where=dimension1==value1;dimension2==value2

예 :

https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

쉼표는 논리적 OR로 처리되고 세미콜론은 논리적 AND로 처리됩니다. 예를 들어, where=video==1234,5678;player==9876 "비디오 = 1234 OR 5678 player = 9876 "

공백 및 특수 문자

문자열 값은 인코딩 된 URI 여야합니다. ""를 사용하여 특수 문자를 이스케이프 할 수도 있습니다.

where=search_terms==boston,%20ma

모든 측정 기준을 필터로 사용할 수 있습니다. 비자 면제 프로그램에 해당하는 국가의 시민권을 가지고 있지만 해당 측정 기준이 dimensions 당신은 요청하고 있습니다.

비디오 속성 별 필터링

스페셜 사용하기 where=video.q=={property}:{value} 필터를 사용하면 다음과 같은 다양한 속성을 기반으로 특정 동영상 집합으로 보고서를 제한 할 수 있습니다.

  • 태그
  • reference_id
  • custom_fields [1]
  • {a_specific_custom_field}
  • created_at

노트

[1] 기본 구문은 다음과 같습니다. where=video.q==custom_fields:value (모든 사용자 정의 필드의 값과 일치) 또는 where=video.q==myfield:value (특정 사용자 정의 필드의 값과 일치 함 myfield). 특정 사용자 정의 필드를 검색하는 경우에는 해당 필드를 검색해야합니다. 내부 이름, 표시 이름이 아님 :

내부 이름과 표시 이름
내부 이름과 표시 이름

올바른 이름을 사용하고 있는지 한 번 확인하십시오 : 내부 이름이 표시됩니다. 모두 소문자이고 공백을 포함하지 않습니다..

몇 가지 예가 있습니다. where 태그 및 맞춤 입력란에서 검색하기위한 필터 :

단일 태그
where=video.q==tags:foo
여러 개의 태그 :
where=video.q==tags:foo,bar
사용자 정의 필드
where=video.q==custom_fields:foo
태그 및 사용자 정의 필드
where=video.q==tags:foo,bar+custom_fields:fish

이 쿼리 구문에 대한 자세한 내용은 다음을 참조하십시오. 를 사용하여 CMS API: 비디오 검색.

필터 및 허용 값 요약

다음 표에서는 필터로 사용되는 각 측정 기준에 허용되는 값을 보여줍니다.

차원 필터 허용되는 값

기간

날짜 범위 : fromto 모든 유형의 보고서에 대한 매개 변수는 다른 형식으로 표시 할 수 있습니다.

  • 텍스트 값 :
    • from=alltime
    • to=now (모든 요청에 ​​대해 사용 가능하고 기본값)
  • 에포크 시간 값 (밀리 초 단위) 1377047323000
  • ISO 8601 표준 국제 날짜 형식으로 표현 된 날짜 : YYYY-MM-DD형식 2013-09-12. 이 형식으로 표시된 날짜의 경우 :
    • 지정된 모든 날짜 범위가 해석됩니다. 계정에 설정된 시간대
    • 날짜 부여 시간은 자정으로 해석됩니다 ( 00:00:00) 지정된 날짜에 계정에 설정된 시간대
  • 상대 날짜 : 귀하는 tofrom 값은 d (일) 또는 h (시간) 중 다른 것에 상대적입니다. 예 :
    • from=2015-01-01&to=31d
    • from=-48h&to=now
    • from=-2d&to=now (이전 예제와 동일한 결과를 제공합니다)
    • from=-365d&to=2014-12-31

    음수 (-2d)는 "이전"(다른 값)으로 해석되고 양수 (48h)는 "시작"(다른 값)으로 처리됩니다.

하루 동안 '동영상'과 같은 일부 측정 기준에 대한 보고서를 생성하려면 시작일과 종료일을 해당 날짜로 설정하십시오.

...&dimensions=video&from=2013-11-01&to=2013-11-01

한도 및 오프셋

그리고, limit 반환 할 항목 수입니다 (기본값 : 10). 모든 항목을 반환하려면 다음을 사용하십시오. limit=all. offset 건너 뛸 항목 수입니다 (기본값 : 0). 당신이 사용할 수있는 limitoffset 함께 결과를 페이지로 표시하는 앱을 만듭니다.

조정 된 데이터

그리고, reconciled 매개 변수는 부울입니다. 설정되어있는 경우 true결과는 조정 된 데이터로 제한됩니다. 만약 false결과는 실시간 (시간당 미 조정) 데이터로 제한됩니다.

지리 보고서

지리학 적 분석을위한 차원

  • country - ISO-3611-1 국가 코드. 예 : 'US'
  • region - ISO-3611-2 지역 코드입니다. 예 : 'US-WA'
  • city - 도시 이름. 예 : 시애틀

참고 : 알 수없는 국가 또는 지역의 경우 API는 "ZZ"를 코드로 반환합니다 (ISO-3611-alpha2 기준).

필드 및 정렬

사용 fields 매개 변수를 사용하여 반환 할 필드를 지정하십시오. 기본적으로, video_view 보고 된 차원에 해당하는 필드가 반환됩니다 (예 : destination_domain)가 리턴됩니다. 만나다 치수 및 필드 자세한 내용은.

사용 sort 반환 된 항목을 정렬하는 데 사용되는 메트릭 필드를 지정하는 매개 변수. 예 : sort=video_view. 정렬 필드를 무효로하여 정렬 순서를 반대로 할 수 있습니다. sort= -video_view

계산 된 필드

다음 구문을 사용하여 계산 된 필드를 API 요청에 추가 할 수 있습니다.

fields=calulated_field_name:expression

계산 된 필드를 사용하여 기존 메트릭에서 고유 한 사용자 정의 필드를 만들거나 기존 필드의 이름을 바꿀 수 있습니다.

계산 된 필드의 이름은 모든 URI 호환 문자열 일 수 있습니다. 표현식에는 일반 필드 이름과 다음과 같은 산술 연산자가 포함될 수 있습니다.

  • + (부가)
  • - (빼기)
  • * (곱셈)
  • / (분할)
  • ^ (멱지수)
  • () (괄호)

fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name
fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name
fields=Video%20Views:video_view,video.name

샘플 요청

샘플 응답 (위 요청에 대한)

{
  "item_count": 110,
  "items": [
    {
      "avg_seconds_viewed": 2152.2519913106444,
      "video.name": "Flamingos",
      "video_seconds_viewed": 2972260,
      "video": "4825279519001",
      "video_view": 1381
    },
    {
      "avg_seconds_viewed": 14.016225448334756,
      "video.name": "Tiger",
      "video_seconds_viewed": 16413,
      "video": "4093643993001",
      "video_view": 1171
    },
    {
      "avg_seconds_viewed": 12.06,
      "video.name": "Zebra",
      "video_seconds_viewed": 9045,
      "video": "3851389913001",
      "video_view": 750
    },
    {
      "avg_seconds_viewed": 23.343065693430656,
      "video.name": "Sea-SeaTurtle",
      "video_seconds_viewed": 15990,
      "video": "1754276205001",
      "video_view": 685
    }
  ],
  "summary": {
    "avg_seconds_viewed": 274.27374399301004,
    "video_seconds_viewed": 3139063,
    "video_view": 11445
  }
}

12 년 2020 월 XNUMX 일에 마지막으로 업데이트 된 페이지