JavaScriptラッパークラス
JavaScriptラッパークラスは、ビデオリスト取得API(JSON形式)で取得できるデータをクラス化することにより簡便に利用できるようにしたものです。あなたのホームページやブログにJavaScriptのコードを貼り付けることで自分だけのビデオ共有サイトを作ることができます。以下でJavaScriptラッパークラス(NVideo)の使い方を手順を追って詳しくご説明します。
ステップ1) NVideoクラスの読み込み
- 上記のscriptタグで必ずJavaScriptのラッパークラスを読み込んで利用します。
ステップ2) NVideoクラスの初期設定
ビデオの検索条件を設定してから、データを取得するメソッドを呼んでください。
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| NVideo.uid | ユーザーID | ユーザーのID ※ユーザーIDの確認方法についてはこちらをご覧ください。 |
- | 文字列 | - |
| NVideo.sid | サイトID | サイトのID ※サイトIDの発行については、こちらをご覧下さい。 |
- | 文字列 | - |
| NVideo.srt | ソート順 | 以下のソート順を選択できます。 新着順:new 再生回数順:access 評価順:evaluation ランダム:random ※タグ検索の場合、「new」のみ有効となります。 |
- | 文字列 | new |
| NVideo.pgcnf | 最大取得件数 | 以下の最大取得件数の中から選択できます。 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 30, 40, 50, 60, 70, 80, 90, 100 |
- | 数値 | 100 |
| NVideo.ccl | CCライセンス | 以下のCCライセンスの中から選択できます。 表示(by):6 表示−継承(by-sa):5 表示−改変禁止(by-nd):4 表示−非営利(by-nc):3 表示−非営利−継承(by-nc-sa):2 表示−非営利−改変禁止(by-nc-nd):1 |
- | 数値 | - |
| NVideo.s1 | キーワード検索文字列 | タイトル、もしくは説明コメントに含まれる文字列を指定してください。 例:NVideo.s1="ねこ"; |
- | 文字列 | - |
| NVideo.tags | タグ検索文字列 | タグ名を指定してください。 例:NVideo.tags=["ねこ","いぬ"]; |
- | 文字列 | - |
| メソッド名(パラメータ) | 説明 | 返却値 |
|---|---|---|
| NVideo.getData() | ビデオリスト取得API(JSON形式)よりデータを取得します。 | なし |
STEP3.NVideoクラスのAPIでページを作る
データ取得後には、NVideoクラスで以下のデータとAPIを利用することができます。
いろいろとカスタマイズしてみてくださいね。
| プロパティ名 | 説明 | 返却値 |
|---|---|---|
| NVideo.videoList | ビデオオブジェクトのリスト | リスト |
| NVideo.videoList[i].id | ビデオのID | 文字列 |
| NVideo.videoList[i].title | ビデオのタイトル | 文字列 |
| NVideo.videoList[i].user_id | ユーザーID | 文字列 |
| NVideo.videoList[i].user_name | ユーザー名 | 文字列 |
| NVideo.videoList[i].site_id | サイトID | 文字列 |
| NVideo.videoList[i].upload_time | 公開日時 | 日時 |
| NVideo.videoList[i].duration | 再生時間(秒) | 数値 |
| NVideo.videoList[i].view_count | 再生回数 | 数値 |
| NVideo.videoList[i].rating_avg | 評価平均点 | 数値 |
| NVideo.videoList[i].rating_sum | 評価合計 | 数値 |
| NVideo.videoList[i].rating_count | 評価回数 | 数値 |
| NVideo.videoList[i].description | 説明コメント | 文字列 |
| NVideo.videoList[i].credit | クレジット | 文字列 |
| NVideo.videoList[i].license | CCライセンス名 | 文字列 |
| NVideo.videoList[i].download_url | ダウンロードURL | URL |
| NVideo.videoList[i].category_id | カテゴリID | 数値 |
| NVideo.videoList[i].category_name | カテゴリ名 | 文字列 |
| NVideo.videoList[i].iroha_genre_id | イロハジャンルID | 数値 |
| NVideo.videoList[i].iroha_genre_name | イロハジャンル名 | 文字列 |
| NVideo.videoList[i].recommend | おすすめフラグ | 真偽値 |
| NVideo.videoList[i].thumbnail_url_medium | サムネイル画像(中)のURL 160 × 120 ピクセル |
URL |
| NVideo.videoList[i].thumbnail_url_small | サムネイル画像(小)のURL 80 × 60 ピクセル |
URL |
| NVideo.videoList[i].thumbnail_url_large | サムネイル画像(大)のURL 480 × 360 ピクセル |
URL |
| NVideo.videoList[i].url | @niftyビデオ共有のビデオURL | URL |
| NVideo.videoList[i].p_url | プレーヤーのみの画面のURL | URL |
| NVideo.videoList[i].tags | タグオブジェクトのリスト | リスト |
| NVideo.videoList[i].tags[j].name | タグ名 | 文字列 |
| NVideo.videoList[i].tags[j].url | タグURL | URL |
| メソッド名 | 説明 | 返却値 | 例外 |
|---|---|---|---|
| NVideo.getMoreViewLink() | 最大取得件数以上を「もっとみる」ためのURLを返却します。 | URL | - |
| NVideo.getUploadLink() | ビデオ投稿を行うためのURLを返却します。 | URL | - |
| NVideo.getPlayerTag( user_id , id ) | 指定したユーザーIDとビデオIDの再生プレーヤー貼り付けタグを返却します。 | 文字列 | invalid user_id or id 不正なユーザーID、あるいはビデオIDが指定されています。 |
| NVideo.getUserLink( user_id ) | 指定したユーザーIDのユーザーページのURLを返却します。 | URL | invalid user_id 不正なユーザーIDが指定されています。 |
| NVideo.getFormatMMSS(duration) | 再生時間(秒)をmm:ss形式に変換します。 | 文字列 | invalid duration 不正な再生期間が指定されています。 |
| NVideo. getFormatYYYYMMDD(upload_time) |
公開日時をYYYY/MM/DD形式に変換します。 | 文字列 | invalid upload_time 不正な公開日時が指定されています。 |
| NVideo.trimString(str,n) | 文字列(str>の文字数が指定された数値(n)以上の場合、「...」を末尾に付加します。 | 文字列 | invalid String or Number 不正な文字、あるいは数値が指定されています。 |
サンプルHTML-自分の投稿したビデオだけを取得したい
「uid=0000001774」で投稿されたビデオリストをランダム「srt=random」に3件「pgcnf=3」取得するページを作るためのHTMLは以下の通りです。
サンプルHTMLを貼り付けてみると・・・
あくまでも一例ですが、上記のコードをブログなどに貼り付けると即席の小さなビデオ共有コーナーが出来上がります。カスタマイズしてホームページやブログのアクセントにしてみてはいかがですか?
- powered by video.nifty.com
