Bookmark

Requirement (v1.0)

• オフライン状態でのブックマーク・続き再生(N-screen)データはデバイスがオンライン状態になった際に転送してデータを同期化する必要があります。
• 続き再生(N-screen)はアプリ(Player)が終了する時点に転送されます。PCの場合、終了する際にjavascriptで終了確認が取れるメッセージを転送すると一回だけで続き再生情報を転送することで済みます。
  • Flash Playerの場合、一定の周期に転送します。
• SDKに累積されたブックマーク・続き再生(N-screen)データリストを獲得またはClearする機能について
  • SDK更新に合わせて適用される予定です。
• SDK - bookmark, n-screenデータ転送結果の処理callback
  • SDK更新に合わせて適用される予定です。
• ブックマーク・続き再生(N-screen)に時間情報追加
  • 時間情報は視聴者のデバイスのlocaltimeによる時間の同期化問題が出る可能性があるため、使用する際には注意してください。

Kollus 側の設定

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

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

Bookmark API

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

API Params

ブックマークリスト獲得 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”
    }
]