サグールテレビ

1. 概要

サグールテレビ検索 Ajax APIは html文書にサグールテレビの動画検索機能を追加するAPIです。

2.利用のガイドライン

ガイドラインに同意いただけない場合は、サグールテレビ検索 Ajax APIを使用するライセンスは許諾されません。
API利用のガイドライン

3. 使い方

簡単な使い方
設定の変更
search()関数の使用
用例

3.1. 簡単な使い方

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

<head> の中に <script src="http://sagool.tv/web/js/sagoolTvSearchAjaxApi.js" type="text/javascript"></script> と書き込んでください。
クライアントURLを指定します。
次に,html文書中でサグールテレビ検索機能を挿入したい部分に <div id="sagoolTvSearch"></div> と書き込んでください。

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

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

3.2. 設定の変更

サグールテレビ検索 Ajax API では次の項目の設定の変更が可能です。

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

設定の変更はサグールテレビ検索 Ajax APIが用意した Java Script関数を実行することで行われます。

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

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

	sagool.sagooltv.setForm(0);

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

	sagool.sagooltv.setForm(1);

と実行して下さい。

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

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

	sagool.sagooltv.setResult(0);

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

	sagool.sagooltv.setResult(1);

と実行して下さい。

検索フォームと結果の挿入位置を変更

sagool.sagooltv.setTarget() 関数によりサグールテレビの検索フォームと検索結果を挿入するDOM要素のIDの変更が可能です.
デフォルトでは「"sagoolTvSearch"」に設定されています。

例えば、 <div id="newTargetId"> に検索フォームと検索結果を挿入したい場合,

	sagool.sagooltv.setTarget("newTargetId");

と実行してください。

初期クエリの設定

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

	sagool.sagooltv.setInitialQuery("sagool");

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

コールバック関数の変更

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

	sagool.sagooltv.setCallback("doSomething");

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

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

が実行されます。

3.3. search()関数の使用

サグールテレビ検索 Ajax APIは sagool.sagooltv.search() 関数を用意しています。

	sagool.sagooltv.search("query");

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

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

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

3.4. 用例

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

	<html>
		<head>
			<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
			<script src="http://sagool.tv/web/js/sagoolTvSearchAjaxApi.js" type="text/javascript">
			</script>
			<script>
			<!--
				//initialize
				//クライアントURLを指定します。
				//sagool.sagooltv.setClientUrl()関数の引数に
				//このAPIをご利用になるWebサービスやブログなどのURLを指定してください。
				sagool.sagooltv.setClientUrl("あなたのサイトのURL");
				
				//検索フォームが必要ない場合はコメントを削除してください。
				sagool.sagooltv.setForm(0);

				//検索結果が必要ない場合はコメントを削除してください。
				//sagool.sagooltv.setResult(0);

				//初期クエリを設定してください。
				sagool.sagooltv.setInitialQuery("sagool");

				//検索機能挿入要素のidを指定してください。
				sagool.sagooltv.setTarget("targetId");

				//コールバック関数を指定してください。
				//sagool.sagooltv.setCallback("sagool.sagooltv.pRS");
			//-->
			</script>
		</head>
		<body>
			<div id="targetId">
				Loading...
			</div>
		</body>
	</html>

閉じる

SOMERIGHT RESERVED TEAM LAB INC.