カテゴリマスタ情報全取得
/category_list [GET]
基本情報
概要
全てのカテゴリ情報を取得します。
URL
https://{HOST}/{CID}/v1/category_list
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
出力順
- 弊社独自の調整をしており、必ずしもコード順とはなりません
諸注意事項
・返却データが 100KB 程度と大きめです。短期間で頻繁にリクエストするような使い方は避けてください。
・カテゴリは定期的に再編されます。小項目と細項目のキャッシュは非推奨です。
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ・ピリオド区切りで複数指定可能 ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可) |
langパラメータの指定時の注意点
langパラメータ指定時のレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。
リクエスト例
- 全てのカテゴリを取得
/category_list
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| カテゴリ情報 | items | Categoryオブジェクト | ○ | カテゴリ情報のまとまり |
Categoryオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| カテゴリコード | code | 文字列 | ||
| カテゴリ名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| カテゴリ名の読み仮名 | ruby | 文字列/Multilingualオブジェクト | langパラメータ指定時は、lang=jaの場合のみMultilingualオブジェクトで返却 ただし"ja"を含む場合のみ(日本語のみ) |
|
| カテゴリコードのレベル | level | 文字列 | large, middle, small, detail の４階層 langパラメータで"en"以外を指定した場合も英語表記のみ |
|
| 子要素 | children | Categoryオブジェクト | ○ | 検索したカテゴリの下位カテゴリ群の情報をまとめたオブジェクト |
Categoryオブジェクト(子要素がない場合)
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| カテゴリコード | code | 文字列 | ||
| カテゴリ名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| カテゴリ名の読み仮名 | ruby | 文字列/Multilingualオブジェクト | langパラメータ指定時は、lang=jaの場合のみMultilingualオブジェクトで返却 ただし"ja"を含む場合のみ(日本語のみ) |
|
| カテゴリコードのレベル | level | 文字列 | large, middle, small, detail の４階層 langパラメータで"en"以外を指定した場合も英語表記 |
Multilingualオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 英語名称 | en | 文字列 | ||
| 日本語名称 | ja | 文字列 | ||
| 韓国語名称 | ko | 文字列 | ||
| タイ語名称 | th | 文字列 | ||
| 中国語(簡体字)名称 | zh-CN | 文字列 | ||
| 中国語(繁体字)名称 | zh-TW | 文字列 |
レスポンス例
{
"items": [
{
"code": "01",
"name": "遊ぶ/趣味",
"ruby": "あそぶしゅみ",
"level": "large",
"children": [
{
"code": "0101",
"name": "レジャー/アウトドア",
"ruby": "れじゃーあうとどあ",
"level": "middle",
"children": [
{
"code": "0101001",
"name": "遊園地/テーマパーク",
"ruby": "ゆうえんちてーまぱーく",
"level": "small",
"children": [
{
"code": "0101001001",
"name": "遊園地/テーマパーク",
"ruby": "ゆうえんちてーまぱーく",
"level": "detail"
}
]
},
{
"code": "0101013",
"name": "プール",
"ruby": "ぷーる",
"level": "small",
"children": [
{
"code": "0101013001",
"name": "プール",
"ruby": "ぷーる",
"level": "detail"
}
]
},
・・・
]
}
・・・
]
},
{
・・・
}
]
}
レスポンス例(lang=en.ko指定時)
{
"items": [
{
"code": "01",
"name": {
"en": "Leisure / Hobbies",
"ko": "오락/취미"
},
"level": "large",
"children": [
{
"code": "0101",
"name": {
"en": "Leisure / Outdoors",
"ko": "레저/아웃도어"
},
"level": "middle",
"children": [
{
"code": "0101001",
"name": {
"en": "Amusement Park / Theme Park",
"ko": "놀이공원/테마파크"
},
"level": "small",
"children": [
{
"code": "0101001001",
"name": {
"en": "Amusement Park / Theme Park",
"ko": "놀이공원/테마파크"
},
"level": "detail"
}
]
},
{
"code": "0101013",
"name": {
"en": "Pool",
"ko": "수영장"
},
"level": "small",
"children": [
{
"code": "0101013001",
"name": {
"en": "Pool",
"ko": "수영장"
},
"level": "detail"
}
]
},
・・・
]
}
・・・
]
},
{
・・・
}
]
}