SAGOOL 検索 AJAX API

SAGOOL 検索 AJAX APIを利用してアプリケーションを開発

SAGOOL 検索 AJAX APIは HTML文書にサグールの検索機能を追加するAPIです。

SAGOOL 検索 AJAX APIご利用の際には、次の点にご注意ください。

SAGOOL 検索 AJAX APIはベータバージョンです。利用状況により、サービスの仕様変更、あるいはサービスを停止する可能性があります。
SAGOOL 検索 AJAX APIの利用状況把握のため、クエリパラメータにSAGOOL 検索 AJAX API を利用するWEBアプリケーションのURLを指定してください。
SAGOOL 検索 AJAX APIを利用するアプリケーションは、見やすい位置に「SAGOOL」へのリンクとロゴを表示してください。詳細はこちらをご覧ください。
SAGOOL 検索 AJAX APIの利用はリクエスト元のIP毎に制限が設けられています。現状では 1IP あたり 24時間に 5千回が上限となっています。

利用のガイドライン

ガイドラインに同意いただけない場合は、SAGOOL 検索 AJAX APIを使用するライセンスは許諾されません。

API利用のガイドライン

簡単な使い方

以下のようにHTML文書を編集してください。

<head> の中に <script src="http://sagool.jp/img/sagoolSearchAjaxApi.js" type="text/javascript"></script> と書き込んでください。
クライアントURLを設定してください。
HTML文書中でSAGOOL検索機能を挿入したい部分に <div id="sagoolSearch"></div> と書き込んでください。

クライアントURLは他のAPIにおけるAPI-KEYのようなものとお考えください。弊社でAPIの利用状況を把握し、サービス改善の指針とするために使用します。API利用者が事前に申請する必要はありません。
利用状況によっては一部の形式のURLが利用できなくなる可能性があります。

以下はSAGOOL 検索 AJAX APIを利用したHTML文書の例です。

	<html>
		<head>
			<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
			<script src="http://sagool.jp/img/sagoolSearchAjaxApi.js" type="text/javascript">
			</script>
			<script type="text/javascript">
				//<!--
				//クライアントURLを指定します。
				//sagool.sagool.setClientUrl()関数の引数に
				//このAPIをご利用になるWebサービスやブログなどのURLを指定してください。
				sagool.sagool.setClientUrl("あなたのサイトのURL");
				-->
			</script>
		</head>
		<body>
			<div id="sagoolSearch">
				Loading...
			</div>
		</body>
	</html>

設定の変更

SAGOOL検索 AJAX API では次の項目の設定の変更が可能です。

検索窓の表示/非表示
検索結果一覧の表示/非表示
検索機能を挿入する要素のid
初期クエリ
APIのコールバック関数

設定の変更はSAGOOL検索 AJAX APIが用意した javascript関数を実行することで行われます。

検索窓の表示/非表示の切り替え

sagool.sagool.setForm() 関数により検索窓の「表示/非表示」の切り替えが可能です.
デフォルトでは「表示」に設定されています。

	sagool.sagool.setForm(0);

と実行することで「非表示」に切り替わります。
再度「表示」に切り替えたい場合は

	sagool.sagool.setForm(1);

と実行して下さい。

検索結果一覧の表示/非表示の切り替え

sagool.sagool.setResult() 関数により検索結果一覧の「表示/非表示」の切り替えが可能です.
デフォルトでは「表示」に設定されています。

	sagool.sagool.setResult(0);

と実行することで「非表示」に切り替わります。
再度「表示」に切り替えたい場合は

	sagool.sagool.setResult(1);

と実行して下さい。

検索機能挿入要素のidの変更

sagool.sagool.setTarget() 関数により検索機能挿入要素のidの変更が可能です.
デフォルトでは「"sagoolSearch"」に設定されています。

	sagool.sagool.setTarget("newTargetId");

と実行することで, "newTargetId"というidが付与された要素に検索機能が挿入されます。

初期クエリの設定

初期クエリを設定することで、 HTML文書がブラウザに読み込まれた時点で検索が行われ、検索結果が表示されます。
sagool.sagool.setInitialQuery() 関数により初期クエリの設定が可能です.
デフォルトではなにも設定されていません。
なにも設定されていなければAPIを読み込んだ時点で検索は行われません。

	sagool.sagool.setInitialQuery("sagool");

と実行することで、「sagool」というクエリで検索された結果が最初から表示されます。

コールバック関数の変更

コールバック関数を変更することで、 SAGOOL 検索 AJAX APIが検索結果を読み込んだ時に
実行される関数を変更することが可能です。 sagool.sagool.setCallback() 関数によりコールバック関数の変更が可能です.
デフォルトでは sagool.sagool.pRS() 関数が設定されています。

	sagool.sagool.setCallback("doSomething");

と実行することで、検索結果の読み込みが完了した後に、

	doSomething(検索結果JSONオブジェクト);

が実行されます。

search()関数の使用

SAGOOL 検索 AJAX APIは sagool.sagool.search() 関数を用意しています。

	sagool.sagool.search("query");

と実行することで, "query"というクエリで検索し、その結果を, "sagoolSearch"のidが付与された要素に出力します。

	sagool.sagool.search("query","targetId");

と実行することで, "query"というクエリで検索し、その結果を, "targetId"のidが付与された要素に出力します。

用例:SAGOOLでの検索結果をHTML文書に挿入

以下の例では、検索窓を表示しない設定に変更し、初期クエリに「sagool」を設定し、検索機能を挿入する要素のidに「targetId」を設定しています。

	<html>
		<head>
			<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
			<script src="http://sagool.jp/img/sagoolSearchAjaxApi.js" type="text/javascript">
			</script>
			<script>
				//initialize
				//set your client URL
				sagool.sagool.setClientUrl("あなたのサイトのURL");

				//if you do not need a search Form, set 0
				sagool.sagool.setForm(0);

				//if you do not need a search Results, set 0
				//sagool.sagool.setResult(0);

				//set initial query
				sagool.sagool.setInitialQuery("sagool");

				//set target DOM id
				sagool.sagool.setTarget("targetId");

				//set callback Function of Responce JSONP
				//sagool.sagool.setCallback("sagool.sagool.pRS");
			</script>
		</head>
		<body>
			<div id="targetId">
				Loading...
			</div>
		</body>
	</html>