ニコニコ動画コンテンツ検索APIのLaravel用パッケージを作った話

  • 6
    いいね
  • 0
    コメント

概要

少し必要になったので、ニコニコ動画コンテンツ検索APIのLaravel用パッケージを作成しました。

導入方法

最初に、Composerでパッケージを追加します。

$ composer require shimomo/laravel-nicovideo

次に、プロバイダーをconfig/app.confに追加します。

'providers' => [
    // ...
    Shimomo\Nicovideo\ApiServiceProvider::class,
],

最後に、エイリアスをconfig/app.confに追加します。

'aliases' => [
    // ...
    'Nicovideo' => Shimomo\Nicovideo\ApiFacade::class,
],

使用方法

標準検索

$searchResult = Nicovideo::search([
    'service'                   => 'video',
    'q'                         => '初音ミク',
    'targets'                   => 'title',
    'fields'                    => 'contentId,title,viewCounter',
    'filters[viewCounter][gte]' => '10000',
    '_sort'                     => '-viewCounter',
    '_offset'                   => 0,
    '_limit'                    => 3,
    '_context'                  => 'apiguide',
]);

各種パラメータについては公式ドキュメントを参照してください。


単純検索

$simpleSearchResult = Nicovideo::simpleSearch('video', '初音ミク');
引数 説明 記述内容 標準値
1つ目 検索対象サービス video, live, illust, manga, book, channel, channelarticle, news なし
2つ目 検索ワード 自由記述 なし

動画検索

$videoSearchResult = Nicovideo::videoSearch('初音ミク', 'keywords', 'desc', 'view');
引数 説明 記述内容 標準値
1つ目 検索ワード 自由記述 なし
2つ目 検索ターゲット keywords, tags keywords
3つ目 ソート順序 desc, asc desc
4つ目 ソート対象 view, mylist, comment, start view

生放送検索

$liveSearchResult = Nicovideo::liveSearch('初音ミク', 'keywords', 'desc', 'view');
引数 説明 記述内容 標準値
1つ目 検索ワード 自由記述 なし
2つ目 検索ターゲット keywords, tags keywords
3つ目 ソート順序 desc, asc desc
4つ目 ソート対象 view, comment, start, score view

静画検索

$illustSearchResult = Nicovideo::illustSearch('初音ミク', 'keywords', 'desc', 'view');
引数 説明 記述内容 標準値
1つ目 検索ワード 自由記述 なし
2つ目 検索ターゲット keywords, tags keywords
3つ目 ソート順序 desc, asc desc
4つ目 ソート対象 view, mylist, comment, start view

参考資料

ニコニコ動画 コンテンツ検索APIガイド
http://search.nicovideo.jp/docs/api/search.html

GitHub
https://github.com/shimomo/laravel-nicovideo