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

/category/autocomplete [GET]

基本情報

概要

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

URL

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

※RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

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

パラメータ

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

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

当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"
            }
        }
    ]
}