カテゴリオートコンプリート

/category/autocomplete [GET]

基本情報

概要

指定したワードに対するカテゴリ名の自動補完候補を取得します。

URL

https://{HOST}/{CID}/v1/category/autocomplete

※APIマーケットの場合はURL体系が異なります

出力形式

JSON

対応言語

ja, en, ko, zh-CN, zh-TW, th

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
word	✔	検索ワード	文字列		最小：2文字最大：50文字	検索したいカテゴリ名称アラビア数字・漢数字はそのまま検索します
lang		言語	文字列		ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語	出力する言語を指定します ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可)

データの出力件数について

当APIでは、出力件数が一律20までとなります。

langパラメータの指定時の注意点

langパラメータ指定時のレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。

パラメータ構成例

「こn」で始まるカテゴリ名称の候補を検索

/category/autocomplete?word=こn

レスポンス

名称	レスポンス名	型名	配列	説明
カテゴリ情報	items	Categoryオブジェクト	○	カテゴリ情報のまとまり

Categoryオブジェクト

名称	レスポンス名	型名	配列	説明
カテゴリコード一覧	categories	CategoryCodeオブジェクト	◯
カテゴリ名	name	文字列/Multilingualオブジェクト	langパラメータ指定時は、Multilingualオブジェクトで出力

CategoryCodeオブジェクト

名称	レスポンス名	型名	配列	説明
カテゴリコード	code	文字列
カテゴリコードのレベル	level	文字列		large, middle, small, detail の4階層 langパラメータで"en"以外を指定した場合も英語表記

Multilingualオブジェクト

名称	レスポンス名	型名
英語名称	en	文字列
日本語名称	ja	文字列
韓国語名称	ko	文字列
タイ語名称	th	文字列
中国語(簡体字)名称	zh-CN	文字列
中国語(繁体字)名称	zh-TW	文字列

レスポンス例

{
    "items": [
        {
            "categories": [
                {
                    "code": "0201001",
                    "level": "small"
                }
            ],
            "name": "コンビニ"
        }
    ]
}

レスポンス例(lang=en指定時)

{
    "items": [
        {
            "categories": [
                {
                    "code": "0201001",
                    "level": "small"
                }
            ],
            "name": {
                "en": "Convenience Store"
            }
        }
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: word: required field	必須パラメータである word が指定されていない、または空文字の場合に発生します。
400	parameter error: word: ['min length is 2']	word に2文字未満の値を指定した場合に発生します。
400	parameter error: word: ['max length is 50']	word に50文字を超える値を指定した場合に発生します。
400	parameter error: lang: ['unallowed value {value}']	lang に ja, en, ko, zh-CN, zh-TW, th 以外の不正な値を指定した場合に発生します。
400	bad usage on this contract　:　Multilingual	lang パラメータを指定したが、契約で多言語オプションが有効化されていない場合に発生します。