Bookmark

Requirement (v1.0)

データ同期:
- オフライン状態で作成されたブックマーク/続きを見る情報は、次回オンライン状態で送信して同期が必要です。
続き再生情報の送信:
- 続きを見る情報は、アプリ終了時に送信します。
- PC再生中に終了する場合、JavaScriptで終了確認メッセージを表示し、終了時に一度だけ続き再生情報を送信すればよいです。
- Flashの場合、一定の間隔で情報を送信します。
SDK機能のリクエスト:
- SDKで累積されたブックマークおよび続きを見る情報リストを取得し、これをクリアする機能が必要です。
- この機能はSDKアップグレードのスケジュールに反映して提供される予定です。
処理コールバック:
- SDKのブックマークおよびn-screen情報送信に関する処理コールバックを提供します。
- この機能もSDKアップグレードのスケジュールに反映して提供される予定です。
時間情報の追加:
- ブックマークと続き再生各項目に時間情報を追加します。
- 時間情報はユーザー端末のローカル時間であり、時間同期の問題が発生する可能性があるため、データ使用時には注意が必要です。

1. Kollus設定

ブックマーク・続き再生(N-screen)連係はサービスアカウント全体に一つのURLのみ指定できます。他のCallbackのようなチャンネル別設定ができません。

Kollusシステム側での設定が必要なため、使用する際には担当者にお問い合わせください。

2. Bookmark API

ブックマークデータを使用するKollus Playerと顧客DBのブックマーク情報を連係する際に使用します。

API Params

Name

Type

Note

3. ブックマークリスト獲得 Api (List Url)

ブックマークリストを獲得するために呼出すURLとなります。ブックマークデータはJSON形態のUTF-8でリターンしてください。

Request

インデックスブックマーク
- method : GET
- params:
  - (string) upload_file_key
  - (string) media_content_key : 存在しない場合もあり
インデックス+ユーザーブックマーク
- method : GET
- params :
  - (string) media_content_key
  - (string) client_user_id
ブックマークURLの因子に{USERVALUE0~9}項目がある場合にはuservalue0(~9)で置換してリクエストします。
- 例示) ブックマークURLがhttp://abc.com/bookmark/read?LC={USERVALUE0}&device={USERVALUE9}で登録されていて、uservalue0がLC001でuservalue9がmobileだとhttp://abc.com/bookmark/read?LC=LC001&device=mobile の形でリクエストする。

Response

error : 正常の場合0 (必ず0でなければなりません。)
bookmark_labels : リスト項目に表示するリストタイトル
- kind 0 : Bookmark
- kind 1 : Index
result : 全ての結果はresult項目の下位に表示させます。
- bookmark_positions : ブックマークデータリスト
  - poistion : ブックマーク位置
  - value : ブックマークタイトル
  - kind
    0 : ユーザブックマーク
    1 : インデックスブックマーク
  - label : インデックスブックマークタイトル (ユーザブックマークはこの値を無視)
  - localtime : ブックマーク生成リクエスト時刻 (ユーザ localtime - 参考データに使用 unixtimestamp 形式)

Sample data

{
    "error" : 0,
    "result" : {
   		“bookmark_labels” : [
            "Bookmark",
            “Index”
        ],
        "bookmark_positions" : [
            {
                "position" : 3,
                "value" : "",
                "kind" : 0,
                "label" : "",
                "localtime" : 1417568260 },
            {
                "position" : 5,
                "value" : "開始",
                "kind" : 0,
                "label" : "",
                "localtime": 1417568265 },
            {
                "position": 7,
                "value" : "",
                "kind" : 1,
                "label" : "管理者Aブックマーク",
                "localtime" : 1417538260 },
            {
                "position" : 12,
                "value" : "",
                "localtime" : 1417568270 },
            {
                "position" : 13,
                "value" : "",
                "kind" : 1,
                "label" : "管理者Bブックマーク",
                "localtime" : 1417538260 }
      	  ]
    }
}

ブックマークデータ一括編集 Api (Update Url)

複数のブックマークを一括で処理するためのURLとなります。actionはregister, removeとなり、それぞれがregister, removeの機能を順番通りに処理します。順番通りに処理します。

Update URLが呼出される場合、Register/Remove URLは呼出されません。

Request

method : POST
params:
- (string) bookmarks : {action block}がarrayで構成されたJSONフォーマットの文字列
{action block}
- action : ‘register’ or ‘remove’
- インデックスブックマーク
  - (string) upload_file_key
  - (integer) position
  - (string) label
  - (string) value : removeには含まれない
  - (integer) localtime
- ユーザブックマーク
  - (string) media_content_key
  - (string) client_user_id
  - (integer) position
  - (string) value : removeには含まれない
  - (integer) localtime
- user_value
  - ブックマークURLの因子に{USERVALUE0~9}項目がある場合にはuservalue0(~9)で置換してリクエストします。
bookmarksの例示)
- http://abc.com/bookmark/update?LC={USERVALUE0}&device={USERVALUE9}で登録されていて、user_value0が LC001でuser_value9がmobileの場合

[
    {
        "action" : "register"
        , "media_content_key" : "x53gaH3a"
        , "client_user_id" : "test_user_id"
        , "position" : 45
        , "localtime" : 1414538260
        , "LC" : “LC001”
        , "device" : “mobile”
     },
     {
        "action" : "remove"
        , "media_content_key" : "x53gaH3a"
        , "client_user_id" : "test_user_id"
        , "position" : 67
        , "localtime" : 1417538260
        , "LC" : “LC001”
        , "device" : “mobile”
    }
]

PreviousKollus CMS API NextScheme Option

Last updated 3 months ago