APIサーバーからのレスポンス取得■レスポンスの取得方法
■APIサーバーからのレスポンス取得
コールバック関数を使用し、JSONからAPIサーバーが返す動画のメタ情報を受け取ります。
■コールバック関数書式
searchResultEq(result)
■引数
| 項目名 | 必須 | 説明 | フォーマット | デフォルト値 |
| result | ○ |
抽出したメタ情報のJSON文書 ※次項で説明 |
文字列 | 無し |
■レスポンス内容詳細
- 変数resultにJSON形式（パース済み）で格納されます。
値が存在しない要素はNULLで返却されます。
- MIMEタイプ
application/Javascript
- 文字コード
unicode（UTF-8）
- 動画コンテンツ関連のresultの要素
| 項目名 | JSON要素 | 説明 | 備考 | |
| 検索ヒット動画数 | moviesum | 検索にヒットした動画数 | jsonpへの出力動画数ではありません | |
| レスポンスステータス | response_status | APIレスポンスステータス | ||
| 動画情報 | meta | 動画情報 | ||
| 動画タイトル | meta | title | 動画のタイトル | |
| 動画ID | mid | 動画に付与される識別ID | ||
| 難読化動画ID | obfuscated_mid | 難読化された動画ID | ||
| 任意ID | optional_id | 指定した任意ID | ||
| 公開フラグ | active_flg | 動画の公開/非公開の区別 | 1:公開 0:非公開 |
|
| 公開開始日時 | publication_date | 公開期限がある場合、公開開始日 YYYY/MM/DD hh:mm:ss | ||
| 公開終了日時 | expiration_date | 公開期限がある場合、公開終了日 YYYY/MM/DD hh:mm:ss | ||
| 登録日時 | insert_date | メタ情報等の登録日時 YYYY/MM/DD hh:mm:ss | ||
| 更新日時 | update_date | メタ情報等の最終更新日時 YYYY/MM/DD hh:mm:ss | ||
| 動画長 | duration | 動画の長さ（時間） | 秒数 | |
| 動画URL | movie_permalink | 共通タグ画面で 取得できる動画URL | デフォルトプレイヤー設定にて指定したプレイヤーで生成したURL | |
| 動画の配信URL | movie_url | 動画の配信URL |
存在するもののみ返す |
|
| 画面サイズ | movie_definition | 動画の画面サイズ(横 : 縦) | 存在するもののみ返す lq／低画質 sq／標準画質 hq／高画質 hd／HD fh／フルHD mb_lq／HLS低画質 mb_sq／HLS標準画質 mb_hq／HLS高画質 mb_hd／HLS_HD mb_fh／HLS_フルHD mb_auto／HLS自動画質 auto_pc／PC向け自動画質 auto_sp／スマホ向け自動画質 ※HLS自動画質は0:0となる |
|
| 動画ファイルサイズ | movie_filesize | 動画のファイルサイズ(Byte) | 同上 ※HLSはレスポンスしない |
|
| ダウンロードURL | download_url | 一般公開サイト上のダウンロードリンク URL(redirectFileUrl) | ||
| ダウンロード URL(HTTPS用) | download_url_ssl | 一般公開サイト上のダウンロードリンク URL(redirectFileUrl) | ||
| サムネイルURL | thumbnail_url | 選択されたサムネイルのURL | ||
| 小サムネイルURL | small_thumbnail_url | 小サイズサムネイルのURL | ||
| サムネイルURL(SSL) | thumbnail_url_ssl | 選択されたサムネイルのURL(SSL用) | ||
| 小サムネイルURL(SSL) | small_thumbnail_url_ssl | 小サイズサムネイルのURL(SSL用) | ||
| 説明文 | long_description | 動画の説明文 | ||
| キーワード | keywords | キーワード | ||
| APIリファレンス コード |
api_keywords | APIリファレンスコード | 複数の場合は「;」区切りで出力 | |
| 権利者情報 | copyright | 動画の権利者情報 | ||
| 権利者情報の リンク |
copyright_url | 権利者情報に付与するリンクのURL | ||
| 外部リンク | exlink | 外部リンク | タイトルとリンクのペア３つまで ※順序あり | |
| カスタムメタ データ 1～5 |
custom_metadata | カスタムメタデータ | 顧客側でメタ毎に任意の項目名、 項目値を設定可能 項目名、項目値のペア5つまで 項目値がない場合(項目名だけ)は、 項目値を空で返却 |
|
| 当日再生数 | day_count | 当日（直近24時間）の 再生数 |
データが取得できない場合、0を設定 | |
| 当週再生数 | week_count | 当週（前日までの7日間）の再生数 | データが取得できない場合、0を設定 | |
| 当月再生数 | month_count | 当月（前日までの30日間）の再生数 | データが取得できない場合、0を設定 | |
| 累計再生数 | all_count | 前日までの累計再生数 | データが取得できない場合、0を 設定 | |
| 当日再生率 | day_average | 当日（直近24時間）の平均再生率 | データが取得できない場合、0を 設定 | |
| 当週再生率 | week_average | 当週（前日までの7日間）の平均再生率 | データが取得できない場合、0を 設定 | |
| 当月再生率 | month_average | 当月（前日までの30日間）の平均再生率 | データが取得できない場合、0を 設定 | |
| 累計再生率 | all_average | 前日までの平均再生率 | データが取得できない場合、0を 設定 | |
■JSONに格納されたデータの例
|
searchResultEq({ "moviesum":"100", "response_status":"2000" "meta":[{ "title":"\u30b5\u30f3\u30d7\u30eb\u52d5\u753b", "mid":"1083", "obfuscated_mid":"MTA4Mw==", "active_flg":"1", "insert_date":"2012/10/10 12:00:00", "update_date":"2012/10/10 12:00:00", "publication_date":"2012/10/10 12:00:00", "expiration_date":"2012/12/31 23:59:59", "duration":"214", "movie_permalink":"https:\/\/api01-platform.stream.co.jp\/apiservice\/plt3\/NDg1%5cMTY0Ng%3d%3d%5c280%5c168%5c0%5c23E6FE50%5c", "movie_url": {"lq":"rtmp:\/\/webcdn.stream.co.jp\/testcid\/sample1.mp4", "sq":"rtmp:\/\/webcdn.stream.co.jp\/testcid\/sample2.mp4", "hq":"rtmp:\/\/webcdn.stream.co.jp\/testcid\/sample3.mp4", "hd":"rtmp:\/\/webcdn.stream.co.jp\/testcid\/sample4.mp4", "mb_lq":"http:\/\/webcdn.stream.co.jp\/testcid\/sample5.m3u8", "mb_sq":"http:\/\/webcdn.stream.co.jp\/testcid\/sample6. m3u8"}, "movie_definition": {"lq":"428:240 ", "sq":"640:360", "hq":"854:480", "hd":"1280:720", "mb_lq"428:240 ", "mb_sq"640:360 ",}, "movie_filesize": {"lq":"489052 ", "sq":"1441996 ", "hq":"2710942", "hd":"4522837",}, "download_url":"http:\/\/api01-platform.stream.co.jp\/apiservice\/redirectFileUrl\/?cid=xxxx&smid=xxxx", "download_url_ssl":"https:\/\/api01-platform.stream.co.jp\/apiservice\/redirectFileUrl\/?cid=xxxx&smid=xxxx", "thumbnail_url":"http:\/\/webcdn.stream.co.jp\/testcid\/sample.jpg", "small_thumbnail_url":"http:\/\/webcdn.stream.co.jp\/testcid\/small.jpg", "thumbnail_url_ssl":"https:\/\/ssl.webcdn.stream.co.jp\/testcid\/sample.jpg", "small_thumbnail_url_ssl":"https:\/\/ssl.webcdn.stream.co.jp\/testcid\/small.jpg", "long_description":"\u3053\u308c\u306f\u30b5\u30f3\u30d7\u30eb\u3067\u3059\u3002", "keywords":"testkeyword", "api_keywords":"\u4e94\u8f2a;\u30e1\u30c0\u30eb", "copyright":"J\u30b9\u30c8\u30ea\u30fc\u30e0", "copyright _url":"http:\/\/webcdn.stream.co.jp\/testcid\/index.html", "exlink":[{"title":"Yahoo","url":"http:\/\/www.yahoo.co.jp\/"}, null, {"title":"Yahoo","url":"http:\/\/www.yahoo.co.jp\/"}], "custom_metadata":{"aaa":"1","ccc":"3","eeee":"55"}, "day_count":" 795", "week_count":" 7950", "month_count":" 20361", "all_count":" 810293", "day_average":" 67.1", "week_average"," 67.1", "month_average":" 65.2", "all_average":" 63.1"}, {"title":"\u30b5\u30f3\u30d7\u30eb\u52d5\u753b\uff12", "mid":"1084", ...省略... },] }); ※content-typeはJsonp出力時「application/Javascript」、Json出力時「application/json」とする。 ※json標準のunicodeによる出力となります |
■レスポンスステータス
| ステータスCD | 説明 | 備考 |
| 1001 | 必須パラメータが存在しない | |
| 1002 | tokenが不正(base64デコード出来ない、存在しないtoken) | 検索結果が0件だった場合にのみ、tokenのみの再検索クエリを発行して処理。パーマリンクのbase64パラメータに関しても適用 |
| 1003 | cidが不正(数値以外、存在しないcid) | 検索結果が0件だった場合にのみ、cid,midのみの再検索クエリを発行して処理 midよりエラー優先 |
| 1004 | midが不正(数値以外) ※半角数字以外 （英字、記号、全角文字、空文字など） |
検索結果が0件だった場合にのみ、 Midよりエラー優先 存在しないmidを指定した場合は「2000」が返却 |
| 1005 | pageNumber、pageSizeが不正(解釈出来ない、存在しないページを指定) | ただし、デフォルト値を使ってjson返却してしまう事とする。 |
| 1006 | sortOrderが不正(解釈出来ない) | ただし、デフォルト値を使ってjson返却してしまう事とする。 |
| 1007 | api_keywordsが不正(ANDとORが混在等) | |
| 1025 | active_flgが不正 | |
| 1026 | 日付指定が不正 | YYYYMMDDhhmm形式 |
| 2000 | 正常レスポンス | |
| 9001 | システムエラー（DB） | |
| 9999 | システムエラー（その他） |