개요
Kollus에서 제공하는 Callback 정보는 플랫폼에서 전달하는 내용과 플레이어에서 전달하는 내용으로 구분될 수 있습니다. 플레이어에서 전달하는 정보는 사용자가 컨텐츠를 이용한 정보를 활용할 수 있도록 관련 정보를 지정된 Url에 전달하는 기능입니다.
재생정보를 전송할때 응답을 확인하지 않습니다.
해당 기능을 사용하기 위해서는 Kollus Live에 접속하여 관련 정보를 설정하시면 Video-gateway를 통해 관련 내용이 전달되어 재생과 관련된 정보를 전달합니다.
Callback process
재생 정보를 전달 받는 흐름을 설명합니다.
- Kollus 설정에서 관련 정보 요청을 설정합니다.
- Kollus는 컨텐츠 배포 단위인 채널 마다 다양한 옵션을 지정할 수 있습니다.
- 배포하는 채널마다 지정된 데이터 수집이 가능합니다.
- 동영상 재생을 위해 Video-gateway를 호출하면 컨텐츠 재생을 위한 다양한 정보를 플레이어 전달하게 되며, 이때 재생과 관련된 정보를 전달할 설정을 함께 전달합니다.
- 재생 정보를 활용하기 위해 설정한 Url에 관련 정보를 전달합니다.
- Kollus는 컨텐츠 재생과 관련된 기본 정보를 수집하기 위해 관련 정보를 수집합니다.
- 사용자 정보를 일체 포함되지 않습니다.
- Mac Address, IP Address 개인의 위치 정보와 관련된 정보를 수집 되지 않습니다.
Customer Requirement
Kollus에서 전달하는 재생 관련 정보는 고객의 다양한 요청을 수렴하여 개발되었습니다.
...
概要
Kollusサービスで提供しているCallbackは、Platform CallbackとPlayer Callbackで分けていおり、ユーザーのコンテンツ利用情報を確認したい際にはPlayer Callbackが必要です。
Playerから取得された内容を指定したURLに転送する機能をLMS Callbackといいます。Playerは情報を一方転送するだけでレスポンスの受け取ることは出来ません。
この機能を使用する場合にはKollus Live管理画面から関連情報を設定する必要があります。LMS Callback URLの設定が終わりましたらVideo gatewayから再生関連情報が指定したURLに自動で転送されます。
Callback process
再生情報を受け取る流れを説明します。
- Kollus 側で情報リクエストを設定します。
- コンテンツ配信単位である"チャンネル"別に転送したい項目を指定することができます。
- Video-gatewayが呼出すとコンテンツ再生に必要な情報をPlayerに転送し、この段階で再生と関わる情報の転送設定(1で設定したCallback設定情報)を共に転送します。
- Playerは2.で指定された情報取得し、設定されたURL (顧客側) にを転送します。
- コンテンツ再生に関する情報を取得するため、関連情報を収集します。
- ユーザーの個人情報は収集されません。
- Mac Address, IP Address 位置情報に関する内容は収集されません。
Customer Requirement
Kollusから転送する再生関連情報は顧客の意見を反映して提供項目を決めています。
● 視聴開始時間
● 視聴時間 (累計)
● 実際視聴時間
● ユーザー情報
● コンテンツ情報
● デバイス情報
● 転送周期
Plugin option
- {CLIENT_USER_ID}
- 사용자의 User ID 입니다.
- MediaToken 생성시 파라미터로 입력한 사용자의 ID 정보입니다. 이때 입력된 사용자 ID는 Kollus 시스템에서 관리되지 않고 사용자를 구분하는 Unique 정보로만 사용됩니다.ユーザー(顧客サービス会員)のUser ID
- MediaTokenを生成する際にパラメータとして入力されたユーザID情報と同一です。入力されたユーザIDはKollus側に保存されません。ユーザのユニーク性を識別する用途で使用されます。
- {START_AT}
- Video-gateway를 호출한 시점의 Unixtimestamp 입니다.사용자의 컨텐츠 이용중 다수의 재생정보 전달이 발생할 수 있습니다. 동일한 요청에 같은 gatewayをリクエストした時点のUnixtimestamp
- コンテンツ再生中に複数の再生情報が転送される可能性があります。同一リクエストに同一{START_AT} 값을 갖게 되며, 같은 시간에 다수의 이용자가 발생할 경우 Unixtimestamp 이기 때문에 중복될 수 있습니다.다운로드 컨텐츠의 경우 start_at은 컨텐츠 재생시 단말의 unixtimestamp 입니다.値が付与されるため、同時間に多数の再生件数が発生する場合Unixtimestampが重複されることがあります。
- ダウンロードしたコンテンツの場合、start_atはコンテンツを再生したデバイスのunixtimestampが適用されます。
- {RUN_TIME}
- 전체 시청 시간 全体視聴時間 (단위単位: 초秒)
- 일시정지 된 시간도 누적됩니다一時停止中の時間も合算されます。
- {MEDIA_CONTENT_KEY}
- Kollus Live 미디어 컨텐츠 키メディアコンテンツキー
- {ENCODING_PROFILE_KEY}
- Kollus encoding profile keyエンコーディングプロファイルキー
- {HOST_NAME}
- 비디오 링크 요청 도메인명VG linkがリクエストされたドメイン名
- ex) catenoid.video.kr.kollus.com
- {PLAYER_ID}
- Kollus 플레이어의 고유 ID 입니다.플레이어 설치시 생성된 고유 ID 입니다.PlayerのユニークID
- Kollus Security Playerをインストールした際に生成されたID
- {PLAYLIST_STATUS}
- 전용 플레이어에서만 사용가능(공개 HTML5 사용안함Kollus Security Playerのみ対応 (HTML5 Player使用不可)
- play: 재생중再生中
- pause: 재생멈춤再生停止 (일시정지一時停止)
- stop: 플레이 창이 내려 갈 때Playerウィンドウが閉じられた際
- {DEVICE}
- 단말 모델명デバイスのモデル名
- {SHOW_TIME}
- 실제로 방송을 시청한 시간의 누적 값 (단위: 초実際に放送を視聴した時間の累計 (単位: 秒)
- 일시정지 된 시간을 제외한 시청시간입니다
- 모든 재생 시간을 포함한 시간입니다. 一時停止中の時間は合算されません。
- 全ての再生時間が含まれます。(Time-shift를 한 경우도 모두 포함됩니다.shiftを行った分も累積されます。)
- {USERVALUE0}~{USERVALUE9}
- Video-gateway호출에 추가된 추가 정보 입니다.gateway呼出に追加された情報
- ex) LCD={USERVALUE0}&UCD={USERVALUE4}
- 영문,숫자 이외의 한글등의 문자열을 전달할 경우 웹 브라우저들의 차이점이 있기 때문에 해당 변수 전달시 UTF-8로 전달해야 합니다. (전달되는 문자열은 웹의 특성상 UrlEncode해서 전달해야 합니다.ブラウザ別に仕様が異なるため、ローマ字・数字以外の文字列を転送する場合にはUTF-8で転送してください。(転送する文字列はUrlEncodeをしてください。)
- {JSON_DATA}
- 데이터 포멧データフォーマット: JSON모든
- 재생 정보를 포함한 데이터全ての再生情報が含まれたデータ
{JSON_DATA}
user_info
- content_provider_key : 고객사 顧客 key
- client_user_id : 사용자ユーザ(고객視聴者) ID
- player_id : 플레이어( player ) ID
- hardware_id : 플레이어( player ) hardware ID, 고객 확인용顧客確認用 (*Windowsのみ使用)
- host_name : 비디오 링크 요청 도메인명 VG linkがリクエストされたドメイン名
- device : 디바이스명デバイス名
content_info
- encoding_profile : 인코딩 프로파일エンコーディングプロファイル
- media_content_key : 미디어 컨텐츠 키メディアコンテンツキー
- channel_key : 채널키チャンネルキー
- start_at : Video-gateway를 호출한 시점의 Unixtimestamp 입니다. 다운로드 컨텐츠의 경우 start_at은 컨텐츠 재생시 단말의 unixtimestamp 입니다.gatewayをリクエストした時点のUnixtimestamp, ダウンロードしたコンテンツの場合、start_atはコンテンツを再生したデバイスのunixtimestampが適用されます。
- runtime : 현재시각 現時刻 - 방송시청 시작시각 放送視聴開始時刻 (단위単位:초)秒) ex) 19:00 - 15:00 = 04:00 ※Playerの実際稼働時間
- showtime : 실제 전체 시청 시간 (단위:초)
- 일시정지된 시간은 누적되지 않습니다
- 모든 재생 시간을 포함한 시간입니다. (*Time-shift기능을 사용해도 누적됩니다.)
- Playerが実際に再生動作を行った時間 (単位:秒)
- 一時停止中の時間は合算されません。
- 全ての再生時間が含まれます。(Time-shiftを行った分も累積されます。)
uservalues : ユーザー定義の追加条件、全ての条件の合計用量を1KB未満にしてください。
- uservalue0
- uservalue1
- ....
- uservalue9
Support options
플레이어별 지원 옵션을 확인할 수 있습니다. Player別の対応オプションを確認してください。{MAC}, {IP}의 경우 개인정보에 해당하는 요소로 필요한 경우 별도 협의해 주십시오.は個人情報になるため必要な場合別途ご相談ください。
Option | FlashPlayer | KollusPlayer(PC) | KollusPlayer(MonlieMoblie) |
---|---|---|---|
{CLIENT_USER_ID} | O | O | O |
{START_AT} | O | O | O |
{RUN_TIME} | O | O | O |
{MEDIA_CONTENT_KEY} | O | O | O |
{HOST_NAME} | O | O | O |
{PLAYER_ID} | X | O | O |
{PLAY_STATUS} | X | O | O |
{DEVICE} | X | O | O |
{SHOW_TIME} | X | O | O |
{JSON_DATA} | O | O | O |
Settings
Callback에 대한 설정은 채널에서 할 수 있습니다. Callback이 필요한 채널 마다 설정해야 합니다.Callback設定はチャンネル編集ページから行えます。Callbackが必要なチャンネル別に全て設定してください。
- Callback URLs: 캐리지 리턴으로 각각 치환자를 포함한 URL을 등록합니다.재생정보를 다수의 시스템에서 전달 받을 수 있도록 캐리지리턴 キャリッジリターン(\n)으로 구분된 다수의 callback_url 을 등록할 수 있습니다.Kollus 플랫폼의 필요에 따라 URL 설정 수를 제한할 수 있습니다.を使用してそれぞれの置換値を含むURLを登録します。
- 複数のシステムに再生情報を転送する場合はキャリッジリターンを使用して複数のcall_back_urlを登録することができます。
- Kollus側の状況によって設定できるURLの数が制限される可能性があります。
- Format: [peroid]:[callback_url]
- 구분자 区切り文字 : (콜론コロン)
- peroid
- 데이터 전송 주기
- Callback이 전송되는 주기로 지정된 period(단위:초) 마다 호출되고 프로그램(플레이어)이 종료될 때 추가로 호출 됩니다. 단, 플래시 플레이어의 경우는 플레이어 종료시 호출되지 않습니다.
- 플레이를 일시정시 또는 정지했을 때 추가로 호출 됩니다.
- 단위 :초データ(Callback)転送周期
- 指定されたperiod(単位:秒) 毎に呼び出されて最後にPlayerが終了する際にもう一度呼出されます。※Flash Playerは終了時には呼出されません。
- 再生を一時停止または中止した際にもう一度呼出されます。
- 単位: 秒
- callback_url
- Callback Url 입니다. 컨텐츠를 재생하는 사용자 환경에서 전송하기 때문에 방화벽 환경을 고려하여 http, 80포트 사용을 권장합니다.URL: コンテンツを再生する視聴者環境によってファイアウォールが適用されている条件を想定し、http, 80ポートを使用することを推奨します。
Callback URLs
Code Block | ||||
---|---|---|---|---|
| ||||
30:http://domain.com/check.asp?id={CLIENT_USER_ID}&start={START_AT}&lms={JSON_DATA} &uservalue0={USERVALUE0} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
● URL: http://lms.servicedomain.com/lms/register ● Method: POST ● Params: ● ID={CLIENT_USER_ID} ● LRN={USERVALUE0} ● LHF={USERVALUE1} ● LCD={USERVALUE2} ● TM={START_AT} ● RT={RUN_TIME} ● http://lms.servicedomain.com/lms/register?ID=pobi&LRN=123456789ABCDEF&LHF=1&LCD=L123&UCD=U123&TM=123456789&RT=123456789 |
Etc.
Callback
...
リクエスト周期 (Callback period)
- Callback은 시스템에 설정된 Callback Url 정보의 period 설정에 따라 호출됩니다.
- 플레이어가 일시정지, 정지를 하는 경우도 Callback이 호출됩니다.
- 주기적으로 호출되는 동일한 사용자의 정보는 Callbackはシステムから設定したCallback URL情報のperiod設定値の通りに呼出されます。
- Playerが一時停止・中止される場合にもCallbackが呼出されます。
- 周期的に呼出される同一ユーザの情報は{START_AT}, {CLIENT_USER_ID}값으로 구분하여 마지막 정보를 확인할 수 있습니다.値で区分して最新の情報が確認できます。
- HTML5 플레이어의 경우는 플레이어 종료시 호출되지 않습니다Playerの場合、Playerが終了される時点にCallbackが呼出されません。
- PC, 모바일 플레이어의 경우에도 강제종료시 호출되지 않습니다., Android, iOS Security playerの場合にも強制終了の際には呼出されません。
USERVALUE0 ~ USERVALUE9
...
- 특수문자(영문,숫자이외의 모든문자:한글,한자,일어등)는 반드시 UTF-8문자열을 UrlEncode된 상태로 전달되어야 합니다
데이터 보안
...
LMS callback 데이터를 변조 방지를 위해 POST로 전달되는 모든 정보에 대해 Hash 를 생성하여 전달되는 Hash값과 일치하는 지 확인합니다.
※ Hash 생성방식에 대해 노출 우려가 있는 Flash Player, HTML5 Single Player는 제외합니다.
...
使用する際に注意点
- 特殊文字 (ローマ字・数字以外の全ての文字一切)は必ずUTF-8文字列をUrlEncodeされた状態で転送しなければなりません。
データ保護
LMS callbackデータの変更・偽造防止のためPOSTで転送される全ての情報に対してHashを生成し、転送されたHash値と一致することを確認してください。
※ Hash 生成方式に漏洩の可能性があるFlash Player, HTML5 Playerは対象外Hash生成規則は以下の通りになります。
전송되는 Post 데이터 예시Code Block language js theme Midnight hash_1 = md5 ( post-data ) hash_2 = md5 ( hash_1 + service_account ) ← + 문자 포함文字含む hash_2값을 post data의 hash 파라메터의 값으로 전송합니다.
2値をpost dataのhashパラメータ値で転送します。
転送されるPostデータのサンプル
Code Block language js theme Midnight ID=pobi&MAC=123456789ABCDEF&LRN=123456789ABCDEF&LHF=1&IP=192.16 8.0.118&LCD=L123&UCD=U123&TM=123456789&PT=123456789&ET=123456789 &SKIP=0&B1=1&B2=1&B3=1&B4=1&B5=1&B6=1&B7=1&B8=1&B9=1&B10=1&T1= 123456789&T2=123456789&T3=123456789&T4=123456789&T5=123456789&T6=1 23456789&T7=123456789&T8=123456789&T9=123456789&T10=123456789&hash =7dec341ff384574f24c6c441b46bc9b1