catalogInfo

Last updated
Save as PDF

重要: 必要なパラメーターのみコールしてください。弊社は、多くのアプリケーションやクライアントを同時にサポートするAPIのセットを使用しています。これらのAPIは随時更新または改善される場合があります。モバイル・アプリについてはモバイルSDKを使用してください。

http://recs.richrelevance.com/rrserver/api/rrPlatform/catalogInfo/

このAPIは特定のカテゴリー内の子カテゴリーを指定されたレベル（深さ）まで返します。カテゴリー内の兄弟カテゴリーを確認する場合はcatalogInfo/siblingsを参照してください。

注記: URLが正しく機能するためにはAPIキートパラメータが必要です。URLリスエストの例については以下を参照してください。

パラメーター

注記: パラメーターはすべて大文字小文字を区別します。

名称	必須 / オプション	説明
apiKey	Required	サイトを特定する固有のキーです。弊社のクライアントはそれぞれ固有のAPIキーをお持ちです。これによって他のクライアントのデータやトラフィックと区別します。このキーは弊社からクライアントに提供されます。例: apiKey=4faeaf752ee40a0f
apiClientKey	Required	各APIの実装に固有のキーです。レポート、パーミッション、マーチャンダイジング用の特定の実装チャネルの識別子です。このキーは弊社からクライアントに提供されます。例: apiClientKey=b0126f995ac848159d
categoryId	Required	マーチャントが調査するカテゴリーのIDです。マーチャントがリッチレリバンスに提供しているこのカテゴリーの外部IDと一致している必要があります。例: categoryId=902312
depth	Optional	返すカテゴリー階層レベルの数です。0（既定値）に設定されている場合、トップ・レベルだけが返されます。例: depth=2

リクエスト例

http://recs.richrelevance.com/rrserver/api/rrPlatform/catalogInfo/?&apiClientKey=e9c9e05289be70e6&apiKey=showcaseparent&categoryId=Baby.Feeding&depth=2

レスポンス例

[{
    "hasChildren": true,
    "name": "Feeding",
    "childCategories": [{
        "hasChildren": false,
        "name": "Formula",
        "childCategories": [],
        "id": "Baby.Feeding.Formula"
    }, {
        "hasChildren": false,
        "name": "Baby Formula",
        "childCategories": [],
        "id": "Baby.Feeding.Baby Formula"
    }],
    "ancestorCategories": [{
        "hasChildren": true,
        "name": "Baby",
        "id": "Baby"
    }],
    "id": "Baby.Feeding"
}]

レスポンスの定義

レスポンスは以下のフィールドを含むJSONオブジェクトです。

フィールド	説明
id	カテゴリーIDです。
name	カテゴリーの名称です。
hasChildren	カテゴリーにサブカテゴリーがあるかどうかを示します。有効な値はtrueまたはfalseです。
childCategories	このカテゴリーのサブカテゴリーであり、categoryInfoオブジェクトの配列です。コンテキストに応じて（depthパラメーターの値等）、このフィールドに値が入るかどうかが決まります。値がない場合でもカテゴリーにサブカテゴリーが存在する場合があります。hasChildrenフィールドで確認してください。カテゴリーにサブカテゴリーがない場合は空白の配列を設定してください。
ancestorCategories	このカテゴリーの上位カテゴリーであり、categoryInfoオブジェクトの配列です。