getMediaByParamを利用することで、EQでトランスコードされた全ての動画ファイルから、指定した項目のメタ情報を取得します。
■設定情報
■JavaScriptによるAPI呼び出し関数書式
・param ：各パラメータをオブジェクト型で生成
・callback : 戻りjsonp名
■API呼び出しURL
http(s)://api01-platform.stream.co.jp/apiservice/getMediaByParam/?token=xxxx&各パラメータ
■制限事項
推奨するリクエストはGETメソッドになります。
POSTメソッドでのリクエストは推奨外となり、正常動作しない場合がございますので、ご理解ください。
■引数
・パラメータ
| 項目名 | 必須 | 種別 | 説明 | フォーマット | デフォルト値 |
| token | ○ | URL | ユーザー毎に発行されたトークン | 文字列 | 無し |
| pageSize | --- | 共通 | 取得する動画件数 | 半角数字 （上限1000） |
10 |
| pageNumber | --- | 共通 | 取得を開始するページ番号 | 半角数字 | 1 |
| mid | --- | 共通 |
取得する動画のID |
半角数字 | 無し |
| optional_id | --- | 共通 |
メタデータ編集で登録した任意ID |
半角英数, -, _ |
無し |
| active_flg | --- | 共通 | 公開可否 2,公開&公開期限内/1,公開/0,非公開/なし,公開&非公開すべて |
半角数字 | 無し |
| api_keywords | --- | 共通 | APIリファレンスコード メタ情報のキーワード項目を検索する文字列を指定 指定した文字列による完全一致検索 複数文字列によるAND検索(;で区切る)と OR検索（|で区切る）が可能 |
文字列 | 無し |
| type | --- | URL | 返却形式のタイプを指定 「jsonp」「json」が指定可能 |
文字列 | jsonp |
| callback | --- | URL | JSONPコールバック関数名 ※jsonp時のみ有効 |
文字列 | searchResultEq |
・パラメータ：日付関連※1
| 項目名 | 必須 | 種別 | 説明 | フォーマット | デフォルト値 |
| insert_date_to, insert_date_from |
--- | 共通 | 登録日 fromとtoにYYYYMMDDhhmm形式にて期間指定※ |
半角数字 | 無し |
| update_date_to, update_date_from |
--- | 共通 | 変更日 fromとtoにYYYYMMDDhhmm形式にて期間指定※ |
半角数字 | 無し |
| publication_date_to, publication_date_from |
--- | 共通 | 公開開始日 fromとtoにYYYYMMDDhhmm形式にて期間指定※ |
半角数字 | 無し |
| expiration_date_to, expiration_date_from |
--- | 共通 | 公開終了日 fromとtoにYYYYMMDDhhmm形式にて期間指定※ |
半角数字 | 無し |
※toのみ、fromのみなど、省略が可能
・パラメータ：ソート関連※1
| 項目名 | 必須 | 種別 | 説明 | フォーマット | デフォルト値 |
|
sort1_order |
--- | 共通 | ソートキーの指定※2 publication_date, insert_date, update_date, day_count, week_count, month_count, custom_metadata1～5 |
半角数字 | publication_date |
|
sort1_by |
--- | 共通 | ソート順の指定 asc(昇順)/desc(降順) |
半角数字 | desc |
|
sort2_order |
--- | 共通 | ソートキーの指定※2 publication_date, insert_date, update_date, day_count, week_count, month_count, custom_metadata1～5 |
半角数字 | insert_date |
|
sort2_by |
--- | 共通 | ソート順の指定 asc(昇順)/desc(降順) |
半角数字 | desc |
※1. 日付関連、ソート関連のパラメータは指定方法が異なります。
指定方法は、「■複数情報取得例」のサンプルコードをご参照ください。
※2. 公開日が空のものは、公開日が最も新しいものとして扱います。
■戻り値（JSON/抽出した動画数分の配列）
「APIサーバーからのレスポンス取得」を参照
■複数情報取得例
JavaScriptでReadAPIの各引数を利用した場合の取得例を説明します。
例）トランスコードされた動画ファイル全体(20件)を3件づつに分け、その内の4ページ目の動画ファイルのメタ情報を指定した公開開始日範囲内かつ、最新の公開順(降順)で取得する場合
・loadEqMeta関数のpageSizeに”3”、pageNumberに”4”、 sortのorderに” publication_date”、byに”desc”、publication_dateのfromに“2016年01月01日00時00分”、toに“2020年01月01日00時00分”を指定し、公開日の降順にした動画ファイルのメタ情報を3件ずつに分け、その内の4ページ目のデータを取得します。
|
loadEqMeta(param,callback) Param = { "pageSize":"3", "pageNumber":"4", "publication_date":{ "from":"201601010000", "to":"202001010000“ },”sort”:[{ “order”: “publication_date”, “by”: “desc” },{ “order”: null, “by”: null }] } |
※最大値以上のpageSize 、pageNumberが指定された場合、
pageSizeは1000、pageNumberは最後のページ数を出力します。
■動画ID取得例
例）動画ID(mid)10002 を持つ動画ファイルのメタ情報を取得する場合
・ loadEqMeta関数のmidに配列[10001,10002,10003]を指定する事で、指定のmidを持つ動画
ファイルのメタ情報を取得します。
|
loadEqMeta(param,callback) Param = { "mid":['10001', '10002', '10003'], } |
■ソート取得例(OR検索)
例）APIリファレンスコードに “自然” または“動物”を持つ動画ファイルのメタ情報を取得する場合
・下記吹き出し内が動画の持つリファレンスコードとします。
・loadEqMeta関数のapi_keywordsに “自然 | 動物”を指定する事で、“自然” または”動物”の文字列
をAPIリファレンスコードとして持つ動画ファイルのメタ情報を取得します。
|
loadEqMeta(param,callback) Param = { "api_keywords":"自然 | 動物", "pageSize":"2", "pageNumber":"2", } |
■ソート取得例(AND検索)
例）APIリファレンスコードに “自然” かつ“文化”を持つ動画ファイルのメタ情報を取得する場合
・下記吹き出し内が動画の持つリファレンスコードとします。
・loadEqMeta関数のapi_keywordsに “自然;文化” を指定する事で、自然と文化の両方をAPIリファ
レンスコードとして持つ動画ファイルのメタ情報を取得します。
|
loadEqMeta(param,callback) Param = { "api_keywords":"自然 ; 動物", "pageSize":"2", "pageNumber":"2", } |