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

차원 및 필드

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

반환 할 수있는 필드를 보려면 아래에서 차원을 선택하십시오. 요청만들기버튼을 클릭하여 샘플 요청을 작성하고 결과를 확인할 수도 있습니다. 호환되지 않는 치수를 여러 개 선택하면 해당 효과에 대한 메시지가 표시됩니다.

  Response will appear here...

참고

1. 기본적으로video_view반환되는 필드는 뿐입니다. 다른 필드는fields매개 변수의 값에 지정된 경우에만 반환됩니다.
2. 차원 또는 차원 조합에 지원되지 않는 반환할 필드를 지정하면UNSUPPORTED_FIELD_COMBINATION_ERROR오류가 반환됩니다.
3. 이bytes_delivered필드에는 비디오 데이터, 이미지, 텍스트 트랙 및 기타 자산과 플레이어 코드 자체를 포함하여 Video Cloud에서 클라이언트에 제공하는 모든 데이터가 포함됩니다. 이 데이터 중 일부는 CDN에서 얻었으며 최대 3 일 동안 사용하지 못할 수도 있습니다.
4. video측정기준에 표시된 필드 외에도 다음과 같이 반환할 수도 있습니다. video.custom_fields.{field_name}

예제 요청

다양한 차원에 대한 보고서를 받는 일반적인 사용 사례: 데스크톱과 모바일 장치 간의 동영상 조회수를 분석하여 iOS와 Android 장치의 모바일 장치 조회수, Mac과 Windows 시스템의 데스크톱 보기 수를 알고 싶습니다. 현재 Studio Analytics 모듈에는 이 정보를 제공하는 표준 보고서가 없지만 다음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

(이 경우 2014년 1월 1일부터 4월 1일까지의 동영상 조회수를 요청합니다.)

cURL 사용 예제

cURL을 사용하여 API를 시험해보고 싶다면 다음 몇 가지 참고 사항을 참고하세요.

• 먼저액세스 토큰을 받아야 합니다.
• 요청의 URL에는 항상 URL 매개 변수가포함되므로 따옴표 (한 개 또는 두 개) 로 묶어야 합니다.

샘플

다음은 샘플 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로 바꾸면 이 요청이 제대로 작동할 것입니다. 이 샘플 앱을 사용하여 액세스토큰을 생성할 수 있다는 점에 유의하세요.

지원되는 차원 조합

빠른 참조를 위해 아래 표에는 지원되는 치수 조합이 나와 있습니다. 두 개 이상의 차원을 사용할 수있는 몇 가지 경우가 있습니다. 위의차원 및 필드도구를 사용하여 이러한 사항을 파악할 수 있습니다.

URL 매개 변수

분석 API 보고서는 다음 URL 매개 변수를 지원합니다.

계정

보고서에 사용할 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 또는5678이고플레이어 = 9876"으로 해석됩니다.

공백 및 특수 문자

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

where=search_terms==boston,%20ma

원하는 차원을 필터로 사용할 수있지만 요청한 차원에도 해당 차원이 포함된경우에만 가능합니다. dimensions

비디오 속성으로 필터링

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

• 태그
• 참조 ID
• 사용자 지정_필드^[1]
• {a_specific_custom_field}
• 생성한_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

참고video.q검색 기능에는 다음이 포함됩니다. AND , OR그리고NOT다음과 같은 논리:

• 검색어 앞의 + (더하기) 기호는 결과에 이 용어가 포함 되어야 함을 의미합니다.
• 검색어 앞의 - (마이너스) 기호는 결과에 이 용어가 포함되지 않아야 함을 의미합니다.
• 더하기 또는 빼기 기호가 없으면 결과에 이 용어가 포함되거나 포함되지 않을 수 있습니다.

다음 예는 이 논리의 사용을 보여줍니다.

이 쿼리 구문에 대한 자세한 설명은 CMS API 사용을 참조하십시오. 동영상 검색 .

필터 및 허용 값 요약

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

기간

모든 유형의 보고서에 대해 지정된 날짜 범위from및to매개 변수는 다음과 같은 다양한 형식으로 표시될 수 있습니다.

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

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

하루 동안 '동영상'과 같은 일부 측정 기준에 대한 보고서를 생성하려면 to 및 from 값을 해당 날짜로 설정합니다.

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

제한 및 오프셋

limit는 반환할 항목 수입니다 (기본값: 10). 모든 품목을 반품하려면 를 사용하십시오limit=all . offset건너뛸 항목 수입니다 (기본값: 0). limit및 를offset함께 사용하여 결과를 단계별로 보여주는 앱을 만들 수 있습니다.

조정 된 데이터

reconciled파라미터는 불리언입니다. 로true설정하면 결과가 조정된 데이터로 제한됩니다. 경우false , 결과는 실시간 (조정되지 않은 시간별) 데이터로 제한됩니다.

지리적 보고서

지리적 분석을위한 차원

• country - ISO-3611-1 국가 코드를 참조하십시오. 예: '우리'
• 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
  }
}