Woopie開発者向けAPI
Woopie 動画検索 API 仕様書 ver 3.0
リクエストURL
http://services.woopie.jp/api/searchリクエストの構築
URLの構築APIリクエストにはGETを使用します。
「リクエストURL」のあとに "?" と続きます。
http://services.woopie.jp/api/search
このあとには、実際のクエリーパラメータが続きます。パラメータは「引数=値」の形式をとります。
引数と値はURLエンコードします。
複数のパラメータは "&" で区切ります。
リクエストパラメータ
| パラメータ | 値 | 説明 |
|---|---|---|
| src（必須） | string | 検索ソースの種類です。 現在は "video" のみサポートします。 |
| stype（必須） | string | 検索の種類です。video検索ではcontentのみサポートします。
|
| clientid（必須） | string | クライアントID。詳細はこちらをご覧下さい |
| kw（必須） | string | （エンコードされた）検索クエリー条件式です。（注１） |
| start | integer（デフォルト：0） | 返却結果の先頭位置です。最終位置（start + count）は900を超えられません。 |
| count | integer（デフォルト：10） | 返却結果の数です。 |
| ics | string（デフォルト：utf-8） | kwの文字コードです。 |
| ocs | string（デフォルト：utf-8） | 返却結果の文字コードです。 |
| ofmt | string (デフォルト：dump) | 返却結果の形式です。
|
| mul | integer（デフォルト：0） | このパラメータは廃止されました
|
| num | integer（デフォルト：0） | このパラメータは廃止されました。 複数の検索クエリーを処理する場合の、クエリーの数 |
| filter | string | 検索結果のフィルター条件式です（注2）。urlエンコードする必要があります。 |
| sort | string | 検索結果のソート条件式です（注3）。urlエンコードする必要があります。 |
| timeout | integer | 検索エンジンへのクエリーをタイムアウトする時間です。（デフォルトは15秒) |
| zone | string | 検索グループ（デフォルトは全てのグループ） |
| param | string | 検索パラメータ |
検索クエリー条件式
フィールドと条件式の間、複数のフィールドと条件式の間は "|" で区切ります。- allinfo
- 全てのフィールド
例：allinfo|お台場| - content
- 説明文
例：content|お台場| - title
- タイトル
例：title|お台場| - tag
- タグ
例：tag|お台場| - titcon
- タイトルと説明文
例：titcon|お台場| - tittag
- タイトルとタグ
例：tittag|お台場| - tagcon
- タグと説明文
例：titcon|お台場| - tittagcon
- タイトル、タグ、説明文
例：tittagcon|お台場|
注：
フィールドを指定しない場合はallinfoになります。ただし、この動作は将来のバージョンでは変更されるかもしれません。通常は、allinfo:を付加してリクエストしてください。
フィルタ条件式（注2）
フィルタ条件式はURLエンコードする必要があります。
filter=[field]:[operator][keyword];
field: pdate, vlength, siteurl, adultlevel, status
operator: = ! < > - & |
keyword: string, integer, timestamp
例：
- filter=pdate: < 1196913721;
- filter=vlength: < 120:
- filter=siteurl: = "http://jp.youtube.com";
- filter=adultlevel: = 0;
- filter=status: = 0 | = 2 | = 4 | = 6;
ソート条件式（注3）
フィルタ条件式はURLエンコードする必要があります。
条件式のフォーマット
sort=field1[=asc|desc],field2[=asc|desc],field3[=asc|desc][,]
asc(昇順)、desc(降順)のどちらかを指定します。指定しない場合はdescになります。最後の ","は省略することができ、その場合は内部のrankを使用します。例：
- sort=pdate
- sort=pdate=desc
- sort=pdate=asc
- sort=vlength
- sort=vlength=desc,
- sort=vlength=asc
レスポンス
レスポンスフィールド
| フィールド | 説明 | ||||
|---|---|---|---|---|---|
| response | Root node | ||||
| stat | |||||
| total_num | 結果の中のクエリーの数 | ||||
| have_cache | キャッシュにヒットしたかはどうか | ||||
| cache_num | キャッシュにヒットしたクエリーの数 | ||||
| query | 検索結果 | ||||
| info | 検索結果情報 | ||||
| charset | 返却された結果の文字コードです | ||||
| start | 返却された結果の開始位置です | ||||
| count | 返却された結果の数です | ||||
| total | データ内のマッチした結果の総数です | ||||
| errno | 0: No error | ||||
| dspcnt | 取得可能なレコードの件数(詳細) | ||||
| consume | クエリー時間（単位：ms） | ||||
| result | 検索結果レコードリスト | ||||
| item | |||||
| uid | 動画のユニークID | ||||
| pdate | 動画の投稿日 | ||||
| vnum | 再生回数 | ||||
| vlength | 動画の再生時間 | ||||
| adultlevel | アダルトレベル（>0はアダルト情報） | ||||
| status | 状態（詳細） | ||||
| title | 動画のタイトル | ||||
| content | 動画の説明 | ||||
| tag | 動画のタグ | ||||
| domain | ページのドメイン | ||||
| surl | 動画ページのURL | ||||
| purl | 動画のサムネイルのURL | ||||
| authorurl | 動画の作成者のURL | ||||
| siteurl | オリジナルサイトのURL | ||||
| sitename | オリジナルサイトの名前 | ||||
| author | 動画の作成者の名前 | ||||
| imgid | 画像のID | ||||
| imgurl | サムネイルのURL | ||||
| wurl | Woopie動画の動画情報ページのURLです | ||||
取得可能なレコードの件数について
検索エンジンがインデックスしているデータのうち、クエリにマッチした件数は total フィールドで返却されます。
マッチしたレコードのうち、dspcnt フィールドの件数まで、Woopie 動画検索 APIを利用して取得することが出来ます。
ステータス
動画の状態を表すフィールドです。
二進数表記の各ビットはそれぞれ別の意味を持っています。現在は下位の1ビット目のみ使用しています。
各ビットの意味
| ビット | 説明 |
|---|---|
| 1 | 削除された動画(Dead Link)を表します。 |
statusのフィルタ
削除された動画を除外するには以下のフィルタを使用してください。削除された動画を完全に除外することを保障するものではありませんが、再生できない動画が検索結果に現れる可能性が少なくなります。
filter=status: = 0 | = 2 | = 4 | = 6;
制限事項
- 午前４時～７時の間に検索エンジンのメンテナンスを行う場合があります。メンテナンス中は通常より検索結果が少なくなることがあります。
