AmebaVision APIドキュメント -14ページ目

3-5.キーワード検索

AmebaVisionに投稿された動画のうち、キーワード検索の結果を最大20件動画情報を検索して返却するAPIです。検索結果の並び順はそれぞれ以下の通りです。

  • 新着順
  • 視聴回数順
  • ユーザ評価(good)数順
  • ユーザ評価(bad)数順
  • コメント数順
  • お気に入り数順

URL

  • 新着順
    http://vision.ameba.jp/api/get/search/keyword/new.do?keyword=[検索キーワード]
  • 視聴回数順
    http://vision.ameba.jp/api/get/search/keyword/popular.do?keyword=[検索キーワード]
  • ユーザ評価(good)数順
    http://vision.ameba.jp/api/get/search/keyword/rating.do?rating=good&keyword=[検索キーワード]
  • ユーザ評価(bad)数順
    http://vision.ameba.jp/api/get/search/keyword/rating.do?rating=bad&keyword=[検索キーワード]
  • コメント数順
    http://vision.ameba.jp/api/get/search/keyword/comment.do?keyword=[検索キーワード]
  • お気に入り数順
    http://vision.ameba.jp/api/get/search/keyword/favorite.do?keyword=[検索キーワード]

リクエストパラメータ

keyword

検索キーワード
日本語などダブルバイト文字列を付加したい場合は、UTF-8の文字列をURLエンコーディングした値を渡すようにしてください。


例:アメーバビジョン
⇒ %E3%82%A2%E3%83%A1%E3%83%BC%E3%83%90%E3%83%93%E3%82%B8%E3%83%A7%E3%83%B3

検索キーワードが渡されていない場合は、エラーが返却されます。

 

offset:

データの取得開始位置を指定できます。offset指定が「0」もしくは未指定の場合は、先頭からデータを返します。

例えば「offset=1」を指定した場合、開始位置は1番目のデータの次=先頭から2件目 となります。

 

length:

データの取得件数を指定できます。lengthが未指定の場合は、それぞれのAPIのデフォルトの件数が返却されます。

各APIの一リクエストあたりに返却可能な件数を超過した値を指定した場合についても、デフォルトの件数が返却されます。

 

 

format: 

返却するデータフォーマットの種類。xmlとjsonpの2種類を指定可能です。未指定の場合はxml形式でデータが返却されます。


callback: 

format=jsonp の時のみ有効。jsonpのコールバック関数の名前が指定できます。JavaScriptの構文に使用できない文字列などが含まれている場合、未指定の場合はデフォルトのコールバック関数の名前(handler)になります。

要素名と内容

title API の名称
link API に関連するサイトのURL
totalCount 現在までの総動画投稿数
※削除された動画の数はカウントされません。
description 動画の解説文
item 動画情報
title 動画のタイトル
link 動画閲覧画面のページURL
tagId 動画を一意であらわすID
description 動画の解説文
amebaId 動画投稿者のアメーバID
ratingGood Goodの評価数
Good/Bad評価を許可していない動画の場合は0が入ります。
ratingBad Badの評価数
Good/Bad評価を許可していない動画の場合は0が入ります。
favoriteCount お気に入り数
playTimeSecond 動画の再生時間
MM:ss の形式になります。
viewCount 動画の視聴回数
commentCount コメントの投稿数
imageUrlLarge 動画のサムネイル画像(大)
imageUrlMedium 動画のサムネイル画像(中)
imageUrlSmall 動画のサムネイル画像(小)
registDatetime 動画の投稿日時
RFC822 で定めるフォーマットになります。
elapsedTime 動画が投稿されてから経過した日時
59分以内の場合はxx分前、23時間59分以内の場合はxx時間前、それ以降はxx日前と表示されます。
player 動画のプレイヤーを表示するためのHTMLタグ
貼り付けが許可されている/許可されていないに関わらず、playerタグは常に空要素になります。