データAPI/検索類似語の取得(アプリ向け) の変更点

追加された行はこの色です。
削除された行はこの色です。
データAPI/検索類似語の取得(アプリ向け) へ行く。
[[FrontPage]]

&size(24){データAPI/検索類似語の取得(アプリ向け)};

* API情報 [#q6190828]

|~名称|検索類似語の取得(アプリ向け)|
|~APIバージョン|1|
|~認証タイプ|クライアント認証|
|~URL|&#104;&#116;&#116;&#112;&#115;&#58;&#47;&#47;&#40;&#65;&#80;&#73;&#12469;&#12540;&#12496;&#12540;&#21517;&#41;/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|application/x-www-form-urlencoded|

* 概要 [#jfe13a2c]

検索語の類似語を取得する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bn(固定)|string定数|必須|コマンド&br;Bn = BBAPIを呼び出す|
|Category|DCT(固定)|string定数|必須|オペレーションカテゴリー&br;DCT = ディクショナリーデータ|
|Operation|god(固定)|string定数|必須|オペレーション&br;god = GETオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|IDseed|認証シード|string|必須|認証に使う毎回変わるランダムの文字列|
|IDval|認証ハッシュ値|hash|必須|sha1(アプリケーションシークレット+認証シード)の値|
|StructData|要求語彙データ|xml|必須|要求語彙データ|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,IDseed,IDvalについては、[[API認証>API認証#authtype_client]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

* クエリーデータXML [#d1118dc6]

** データ定義XML構成 [#sbcdc85d]
 QuerySetタグ: ルートノード
 qtypeタグ: クエリータイプ SimilarWord固定 [必須]
 wordタグ: 検索語 [必須]
 maxresultタグ: 取得最大数 [任意]

** XML例 [#g9ecbe25]
#html{{
<pre class="brush:xml;">
}}
#htmlinsert(samxml_mobadaiapi_simwords.xml)
#html{{
</pre>
}}

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|struct|array|結果データの配列|

結果データの配列
|変数名|型|内容|h
|word|string|入力語|
|result|array|語の列挙|

** JSONの例 [#a81f6668]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"struct":{
		"word":"\u3089",
		"result":[
			"\u3089",
			"\u3089\u30fc",
			"\u3089\u30fc\u304f\u308a\u307e\u304f",
			"\u3089\u30fc\u3053\u3093\u3057\u304a",
			"\u3089\u30fc\u3053\u3093\u3057\u3087",
			"\u3089\u30fc\u3053\u3093\u3068\u3093",
			"\u3089\u30fc\u3053\u3093\u307f\u305d",
			"\u3089\u30fc\u3058",
			"\u3089\u30fc\u3058\u3055\u3044\u305a",
			"\u3089\u30fc\u3058\u306c\u30fc\u3069",
			"\u3089\u30fc\u3058\u3089\u3044\u3059"
		]
	}
}
</pre>
}}


** XMLの例 [#wb22f315]
#html{{
<pre class="brush:xml;">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;response&gt;
	&lt;api_result&gt;1&lt;/api_result&gt;
	&lt;struct&gt;
		&lt;word&gt;ら&lt;/word&gt;
		&lt;result&gt;
			&lt;item&gt;ら&lt;/item&gt;
			&lt;item&gt;らー&lt;/item&gt;
			&lt;item&gt;らーくりまく&lt;/item&gt;
			&lt;item&gt;らーこんしお&lt;/item&gt;
			&lt;item&gt;らーこんしょ&lt;/item&gt;
			&lt;item&gt;らーこんとん&lt;/item&gt;
			&lt;item&gt;らーこんみそ&lt;/item&gt;
			&lt;item&gt;らーじ&lt;/item&gt;
			&lt;item&gt;らーじさいず&lt;/item&gt;
			&lt;item&gt;らーじぬーど&lt;/item&gt;
			&lt;item&gt;らーじらいす&lt;/item&gt;
		&lt;/result&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/データAPI/検索類似語の取得(アプリ向け)]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|