lms-他システム連携/API

13-03-10.動画視聴履歴取得API

更新日:

API名 動画視聴履歴取得API
ID vd_movie_log_get_api

2.詳細解説

動画視聴情報の詳細を取得するAPI。動画配信型講義、スライド配信型講義の埋め込み動画、スライド動画配信型講義の視聴情報を、だれが、いつ、何時から何時まで再生したのかという非常に細かい統計情報を取得することができる。主に日付別の動画視聴統計を作成するためなどに取得する。
(動画視聴統計はバッチで集計されるため、実際に再生されてから当該履歴取得APIでログを取得するまでには半日〜1日程度のタイムラグがあるので、前日までの統計表示などにするなど工夫が必要です)

$cstream->call_vd_movie_log_get_api($input_array);

3.I/O情報

INPUT

No 項目名 項目ID 項目説明 必須
1   会社ID kaisha_id 会社を表すID
2   アクセスキー access_key APIを認証するためのアクセスキー
3   動画視聴アクション区分 movie_view_action_kbn 0:プレイヤーサイトアクセス 1:再生 2:関連リンククリック 3:SNS共有クリック
4   動画ID course_category_id 抽出に利用する動画ID(=検索)  
5   セクションID section_id マスタの所属または共有セクション(入力しないとRootセクションのIDになる)    
6   講座ID course_id 抽出に利用する講座ID(=検索)  
7   講義ID lecture_id 抽出に利用する講義ID(=検索)  
8   受講者ID user_id 抽出に利用する受講者ID(=検索)
9   視聴日時From play_date_from 抽出に利用する視聴日時From(YYYYMMDDHHIISS)
再生開始日時がFrom~Toの間の場合のみ抽出
 
10   視聴日時To play_date_to 抽出に利用する視聴日時To(YYYYMMDDHHIISS)  
11   並び順 sort_type 0:再生開始日時昇順 1:再生開始日時降順
12   取得履歴数 get_cnt 取得する履歴数。0の場合はすべて取得

OUTPUT

No 項目名 項目ID 項目説明
1   実行フラグ exec_flg 1:正常 9:エラー
2   エラータイプ error_type 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。
3   エラーメッセージ error_msg エラーごとに発生するメッセージ
4   視聴履歴リスト view_rireki_list 視聴履歴の一覧情報を取得
  4-1 動画ID movie_id  
  4-2 動画名 movie_id  
  4-3 講座ID course_id  
  4-4 講座名 course_name  
  4-5 講義ID lecture_id  
  4-6 講義名 lecture_name  
  4-7 講座分類ID course_category_id  
  4-8 講座小分類ID course_small_category_id  
  4-9 動画サムネイルURL movie_thumbnail_url 動画サムネイルのURL
  4-10 視聴端末区分 view_terminal_kbn 0:PC 1:スマホ・タブレット
  4-11 再生開始日時 play_start_date 動画の再生を開始した日時を挿入。(YYYYMMDDHHMMSS)
  4-12 再生終了日時 play_end_date 動画の再生を終了した日時を挿入。(YYYYMMDDHHMMSS)
  4-13 動画再生時間 play_time 動画の再生時間。(HHMMSS)

エラー

エラータイプ エラー概要 発生させるメッセージ 発生させるException
0 アクセスキー不適合エラー アクセスキーが適合しません。 AccessKeyException
1 ホスト許可エラー 対象のホストからのAPI実行を許可していません。 HostRestrictException
2 引数エラー 呼出パラメータが不足しているため実行できません。 CallParameterException
9 システムメンテナンスエラー 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 SystemMaintenanceException

4.実装例

-lms-他システム連携/API

Copyright© E-learning ASP V6 利用マニュアル , 2021 All Rights Reserved Powered by STINGER.