recsUsingStrategy

IMPORTANT: 必要なパラメーターだけをコールしてください。リッチレリバンスは多くのアプリケーションやクライアントを同時にサポートするAPIセットを使用しています。これらのAPIは、随時更新および改良されます。

Copy

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

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

説明: 特定のストラテジーからレコメンデーションを返します。このAPIコールにはプレースメントは必要ありません。

IMPORTANT: recsUsingStrategy APIによって返されるレコメンデーションはダッシュボードで設定されたレコメンデーション制限ルールを順守しますが、現時点ではブースト・ルールやマニュアル・レコメンデーション・ルールは遵守しません。

デバッグについて: recsUsingStrategyはuseDummyDataやDisplay Examplesとの互換性を備えていません。

パラメーター

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

パラメーター名	必須/オプション	説明
apiClientKey	必須	各API実装に固有のキーです。レポート、権限設定、マーチャンダイジングのために特定のアプリケーションまたはクライアントを識別します。このキーはRichRelevanceによって提供されます。例： apiClientKey=b0126f995ac848159d
apiKey	必須	サイトを識別するための一意のキーです。各RichRelevanceクライアントには、他のクライアントのデータやトラフィックと分離するための一意のAPIキーが割り当てられています。このキーはRichRelevanceによって提供されます。例： apiKey=4faeaf752ee40a0f
attribute	必須	カタログフィードで提供されるカスタム属性を取得します。複数の属性をリクエストするには、このパラメータを複数回使用し、それぞれの属性をアンパサンド（"&"）で区切って指定します。すべての属性をリクエストするには、パラメータ値にアスタリスク（"*"）を使用します。例： &attribute=COLOR&attribute=SIZE
blockedProductIds	オプション	マーチャントがユーザーにレコメンドしたくない単一または複数の商品IDを指定します。このパラメータを複数回指定するには、アンパサンド（"&"）を使用します。例： &blockedProductIds=uv2345&blockedProductIds=xt1234
callback	オプション	JSONデータが渡されるJavaScript関数の名前です。JSONPを使用する場合に指定する必要があります。このパラメータの値は、レスポンス内のJavaScript関数名として使用されます。例： callback=products_returned
categoryData	オプション	falseに設定すると、カテゴリデータ（categoryIdsおよびcategories）を省略します。デフォルトはtrueです。例： categoryData=false
cts	オプション	クリックスルーサーバー。レコメンドをクリックした際のクリックスルーURLの一部を変更します。クリックの遷移先サーバーを指定します（例：www.buystuff.comまたはm.buystuff.com）。このパラメータは、開発中にユーザーを同一の環境内に留めるために使用されます。例： cts=http://test.buystuff.com Note: APIリクエストにctsパラメータが指定されている場合、サイト設定やフィード内の商品URLに含まれるcts値よりも優先されます。
emailCampaignId	オプション	このリクエストがメールキャンペーンの一部である場合にのみ使用されます。例： emailCampaignId=afyw34567
requestId	オプション	マーチャントがレスポンスとリクエストを一致させるために使用します。返されるIDはレスポンスオブジェクト内で変更されずにそのまま返されます。複数のリクエストが同時に発行される場合に便利です。例： requestId=654123
resultCount	オプション	返されるカテゴリ数を指定します。デフォルトは5です。例： resultCount=3
rid	オプション	リージョンID。商品リージョンフィードで使用されるIDと一致している必要があります。例： rid=Switzerland-France
seed	必須	商品、カテゴリ、または検索文字列。これは、選択された strategyName の戦略タイプによって異なります。 PurchaseCP、ClickCP：商品 ID を使用します。 CategoryCP2、CategoryTopSellers、NewArrivalsIncategory：カテゴリ ID を使用します。 SolrSearchToProduct：検索語句を使用します。 BrandTopSellers：ブランド名を使用します。 TopSellers、TopRatedProducts、movers_and_shakers_1、PersonalizedClickCP：seed は不要です。その他：商品 ID を使用します。 Note: recsUsingStrategy は、商品 seed からカテゴリ情報を推定しません。例： seed=Baby.Shoes
sessionId	必須	ショッパーによる 1 回の訪問を識別します。セッションは、ショッピングセッションにおけるユーザー行動をスコープする行動モデルや、レポート指標で使用されます。例： sessionId=93484
strategyName	必須	以下のいずれかのストラテジーファミリー名を指定します： SiteWideBestSellers ProductBoughtBought CategoryBestSellers ProductViewedViewed SearchBought RatingsReviews NewArrivals CategoryBoughtBought MoversAndShakers Personalized BrandTopSellers 例： strategyName=SiteWideBestSellers
userAttribute	オプション	現在のショッパーを表すカスタムキーと値です。情報はセミコロンおよびパイプ「\|」文字で区切ります。例： userAttribute=eye_color:blue;green\|hair_color:brown
userAttributeReplace	オプション	userAttribute と同じ使用方法ですが、userAttributeReplace とともに送信された属性は、以前に送信されたその属性のすべての値を置き換えます。例：userAttributeReplace=eye_color:black 上記の例では、eye_color の以前のすべての値が削除され、black に置き換えられます。 1つのリクエスト内で userAttribute と userAttributeReplace の両方で同じ属性が送信された場合、userAttributeReplace で送信された値が優先されます。この属性は属性値に対する削除更新にも対応しています。例：userAttribute=eye_color:\|hair_color:
userId	必須	ユーザー ID。各ショッパーを一意に識別する文字列です。すべてのショッパーの行動はこのキーを使用して保存されます。大文字と小文字は区別され、他のアプリケーションで RichRelevance に送信されるユーザー ID と同一である必要があります。例： userId=0982347
includeSkuData	オプション	True/False（デフォルト値は false）。true に設定すると、SKU フィードで提供された利用可能な SKU データが、返された商品に対して提供されます。例： includeSkuData=true JSON レスポンスの例： Copy `"skuData": [{ "color": "White", "size": "12", "image_url": "http://demandware.edgesuite.net/9400.jpg", "sku": "9400" }, { "color": "White", "size": "13", "image_url": "http://demandware.edgesuite.net/9401.jpg", "sku": "9401" }]`
seedType	オプション	レコメンドに使用されるシードのタイプを定義できます。例 1： seedType=BRAND&seed=BRAND2 例 2： seedType=SEARCH&seed=SEARCH10
sgs	オプション	レコメンドのシードとしてセグメントを渡すことができます。例： sgs=SEGMENT6

リクエスト例

Copy

https://recs.richrelevance.com/rrserver/api/rrPlatform/recsUsingStrategy?&apiClientKey=e9c9e05289be70e6&apiKey=showcaseparent&userId=1&sessionId=1&strategyName=CategoryBoughtBought&seed=Baby

レスポンス例

Copy

{
    "strategyName": "CategoryBoughtBought",
    "requestId": "",
    "message": "People who bought this category also bought",
    "recommendedProducts": [{
        "clickURL": "http://recs.richrelevance.com/rrserver/apiclick?a=showcaseparent&cak=e9c9e05289be70e6&ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F10315241&vg=0d470833-48f4-49b4-fd87-69529e9847d6&stid=82&pti=11&pa=-1&pos=0&p=10315241&channelId=e9c9e05289be70e6&s=1&u=1",
        "regionPriceDescription": "",
        "salePriceRangeCents": [388, 388],
        "rating": 4.745999813079834,
        "numReviews": 0,
        "priceRangeCents": [388, 388],
        "categoryIds": ["Grocery", "Grocery.Beverages", "Grocery.Dairy, Eggs & Cheese", "Grocery.Beverages.Coffee", "Grocery.Dairy, Eggs & Cheese.Milk & Cream"],
        "salePriceCents": 388,
        "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/g/r/great-value-coffee-non-dairy-creamer-35.3-oz-7853f7455506646c0f389886316a0304.jpg",
        "name": "Great Value: Coffee Non-Dairy Creamer, 35.3 Oz",
        "genre": "Grocery",
        "isRecommendable": true,
        "priceCents": 388,
        "id": "10315241",
        "categories": [{
            "hasChildren": false,
            "name": "Grocery",
            "id": "Grocery"
        }, {
            "hasChildren": false,
            "name": "Beverages",
            "id": "Grocery.Beverages"
        }, {
            "hasChildren": false,
            "name": "Dairy, Eggs & Cheese",
            "id": "Grocery.Dairy, Eggs & Cheese"
        }, {
            "hasChildren": false,
            "name": "Coffee",
            "id": "Grocery.Beverages.Coffee"
        }, {
            "hasChildren": false,
            "name": "Milk & Cream",
            "id": "Grocery.Dairy, Eggs & Cheese.Milk & Cream"
        }],
        "brand": "Great Value"
    }, {
        "clickURL": "http://recs.richrelevance.com/rrserver/apiclick?a=showcaseparent&cak=e9c9e05289be70e6&ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F10532717&vg=0d470833-48f4-49b4-fd87-69529e9847d6&stid=82&pti=11&pa=-1&pos=1&p=10532717&channelId=e9c9e05289be70e6&s=1&u=1",
        "regionPriceDescription": "",
        "salePriceRangeCents": [177, 177],
        "rating": 4.861999988555908,
        "numReviews": 0,
        "priceRangeCents": [177, 177],
        "categoryIds": ["Grocery", "Baby", "Baby.Diapering & Potty", "Grocery.Infant & Childcare", "Baby.Diapering & Potty.Other Diaper Accessories", "Grocery.Infant & Childcare.Baby Skin Care & Grooming"],
        "salePriceCents": 177,
        "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/e/q/enfamil-mild-baby-powder-22-oz-f1bab211aed511a83db87d1d7beb5cc1.jpg",
        "name": "Enfamil Mild Baby Powder 22 Oz",
        "genre": "Grocery",
        "isRecommendable": true,
        "priceCents": 177,
        "id": "10532717",
        "categories": [{
            "hasChildren": false,
            "name": "Grocery",
            "id": "Grocery"
        }, {
            "hasChildren": false,
            "name": "Baby",
            "id": "Baby"
        }, {
            "hasChildren": false,
            "name": "Diapering & Potty",
            "id": "Baby.Diapering & Potty"
        }, {
            "hasChildren": false,
            "name": "Infant & Childcare",
            "id": "Grocery.Infant & Childcare"
        }, {
            "hasChildren": false,
            "name": "Other Diaper Accessories",
            "id": "Baby.Diapering & Potty.Other Diaper Accessories"
        }, {
            "hasChildren": false,
            "name": "Baby Skin Care & Grooming",
            "id": "Grocery.Infant & Childcare.Baby Skin Care & Grooming"
        }],
        "brand": "Enfamil"
    }, {
        "clickURL": "http://recs.richrelevance.com/rrserver/apiclick?a=showcaseparent&cak=e9c9e05289be70e6&ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F10532717&vg=0d470833-48f4-49b4-fd87-69529e9847d6&stid=82&pti=11&pa=-1&pos=2&p=10532717&channelId=e9c9e05289be70e6&s=1&u=1",
        "regionPriceDescription": "",
        "salePriceRangeCents": [177, 177],
        "rating": 4.861999988555908,
        "numReviews": 0,
        "priceRangeCents": [177, 177],
        "categoryIds": ["Grocery", "Baby", "Baby.Diapering & Potty", "Grocery.Infant & Childcare", "Baby.Diapering & Potty.Other Diaper Accessories", "Grocery.Infant & Childcare.Baby Skin Care & Grooming"],
        "salePriceCents": 177,
        "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/e/q/enfamil-mild-baby-powder-22-oz-f1bab211aed511a83db87d1d7beb5cc1.jpg",
        "name": "Enfamil Mild Baby Powder 22 Oz",
        "genre": "Grocery",
        "isRecommendable": true,
        "priceCents": 177,
        "id": "10532717",
        "categories": [{
            "hasChildren": false,
            "name": "Grocery",
            "id": "Grocery"
        }, {
            "hasChildren": false,
            "name": "Baby",
            "id": "Baby"
        }, {
            "hasChildren": false,
            "name": "Diapering & Potty",
            "id": "Baby.Diapering & Potty"
        }, {
            "hasChildren": false,
            "name": "Infant & Childcare",
            "id": "Grocery.Infant & Childcare"
        }, {
            "hasChildren": false,
            "name": "Other Diaper Accessories",
            "id": "Baby.Diapering & Potty.Other Diaper Accessories"
        }, {
            "hasChildren": false,
            "name": "Baby Skin Care & Grooming",
            "id": "Grocery.Infant & Childcare.Baby Skin Care & Grooming"
        }],
        "brand": "Enfamil"
    }, {
        "clickURL": "http://recs.richrelevance.com/rrserver/apiclick?a=showcaseparent&cak=e9c9e05289be70e6&ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F13399650&vg=0d470833-48f4-49b4-fd87-69529e9847d6&stid=82&pti=11&pa=-1&pos=3&p=13399650&channelId=e9c9e05289be70e6&s=1&u=1",
        "regionPriceDescription": "",
        "salePriceRangeCents": [474, 474],
        "rating": 4.76200008392334,
        "numReviews": 0,
        "priceRangeCents": [497, 497],
        "categoryIds": ["Grocery", "Grocery.Dairy, Eggs & Cheese", "Health", "Health.Diet & Nutrition", "Grocery.Dairy, Eggs & Cheese.Milk & Cream", "lth", "lth.Diet & Nutrition", "Health.Diet & Nutrition.Sports Nutrition", "lth.Diet & Nutrition.Sports Nutrition"],
        "salePriceCents": 474,
        "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/e/a/health-advantedge-carb-control-rich-dark-chocolate-ready-to-drink-shake-11-fl-oz-carton-4-count-d3b10172d9d46e72e57780688ac1d4ae.jpg",
        "name": "Health AdvantEDGE Carb Control Rich Dark Chocolate Ready-to-Drink Shake, 11 fl oz carton, 4-count",
        "genre": "Health",
        "isRecommendable": true,
        "priceCents": 497,
        "id": "13399650",
        "categories": [{
            "hasChildren": false,
            "name": "Grocery",
            "id": "Grocery"
        }, {
            "hasChildren": false,
            "name": "Dairy, Eggs & Cheese",
            "id": "Grocery.Dairy, Eggs & Cheese"
        }, {
            "hasChildren": false,
            "name": "Health",
            "id": "Health"
        }, {
            "hasChildren": false,
            "name": "Diet & Nutrition",
            "id": "Health.Diet & Nutrition"
        }, {
            "hasChildren": false,
            "name": "Milk & Cream",
            "id": "Grocery.Dairy, Eggs & Cheese.Milk & Cream"
        }, {
            "hasChildren": false,
            "name": "lth",
            "id": "lth"
        }, {
            "hasChildren": false,
            "name": "Diet & Nutrition",
            "id": "lth.Diet & Nutrition"
        }, {
            "hasChildren": false,
            "name": "Sports Nutrition",
            "id": "Health.Diet & Nutrition.Sports Nutrition"
        }, {
            "hasChildren": false,
            "name": "Sports Nutrition",
            "id": "lth.Diet & Nutrition.Sports Nutrition"
        }],
        "brand": "EAS"
    }, {
        "clickURL": "http://recs.richrelevance.com/rrserver/apiclick?a=showcaseparent&cak=e9c9e05289be70e6&ct=http%3A%2F%2Flabs.richrelevance.com%2Fstorre%2Fcatalog%2Fproduct%2Fview%2Fsku%2F10292621&vg=0d470833-48f4-49b4-fd87-69529e9847d6&stid=82&pti=11&pa=-1&pos=4&p=10292621&channelId=e9c9e05289be70e6&s=1&u=1",
        "regionPriceDescription": "",
        "salePriceRangeCents": [250, 250],
        "rating": 3.9549999237060547,
        "numReviews": 0,
        "priceRangeCents": [250, 250],
        "categoryIds": ["Grocery", "Grocery.Snacks, Cookies & Chips", "Home", "Grocery.Snacks, Cookies & Chips.Crackers"],
        "salePriceCents": 250,
        "imageURL": "http://labs.richrelevance.com/storre/media/catalog/product/n/a/nabisco-premium-original-saltine-crackers-16-oz-3e0fbe10087a255d525fb6ebe20f7e33.jpg",
        "name": "Nabisco Premium Original Saltine Crackers, 16 oz",
        "genre": "Grocery",
        "isRecommendable": true,
        "priceCents": 250,
        "id": "10292621",
        "categories": [{
            "hasChildren": false,
            "name": "Grocery",
            "id": "Grocery"
        }, {
            "hasChildren": false,
            "name": "Snacks, Cookies & Chips",
            "id": "Grocery.Snacks, Cookies & Chips"
        }, {
            "hasChildren": false,
            "name": "Home",
            "id": "Home"
        }, {
            "hasChildren": false,
            "name": "Crackers",
            "id": "Grocery.Snacks, Cookies & Chips.Crackers"
        }],
        "brand": "Nabisco"
    }]
}