user/preference

Last updated
Save as PDF

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

http://recs.richrelevance.com/rrserver/api/user/preference

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

説明: 顧客のプリファレンスをRelevance Cloudに記録します。商品、ブランド、カテゴリー、店舗等の「好き」、「好きではない」を明示できます。またレコメンデーションに表示して欲しくない商品を明示することもできます。

パラメーター

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

名称	必須 / オプション	説明
actionType	必須	p（preference）パラメーターによる、買物客が示唆したブランド、カテゴリー、店舗です。値は「like」、「dislike」、「neutral」、「notForRecs」のいずれかになります。actionTypeの値を「neutral」に設定すると以前設定した「like」や「dislike」は取り消されます。値をnotForRecsにすると「dislike」を設定することなく当該商品をレコメンドしないようフラグ付けされます。たとえば顧客がすでにある商品を持っている場合、その商品は「like」であるかもしれませんがレコメンドとして表示すべきではありません。notForRecsでフラグ付けされた商品は、すべてのパーソナライズド・ストラテジーのシードとして使用されなくなります。例: actionType=like
apiKey	Required	サイトを特定する固有のキーです。弊社のクライアントはそれぞれ固有のAPIキーをお持ちです。これによって他のクライアントのデータやトラフィックと区別します。このキーは弊社からクライアントに提供されます。例: apiKey=4faeaf752ee40a0f
callback	Required for JSONP	JSONデータが渡されるJavasScriptの関数名です。このパラメーターはJSONPが使用されている場合必須です。このパラメーターの値は、レスポンス内で関数名として使用されます。例: callback=products_returned
p	Required	プリファレンスです。ブランドID、カテゴリーID、商品ID、または店舗IDの一覧です。targetTypeの値によって、これらのいずれかであるかが決定されます。ここの値はパイプ文字で区切ってください。例: p=Microsoft\|Logitech\|Apple (this example is if targetType=brand)
s	Required	セッションIDです。買物客の一回の訪問、あるいはサイト/アプリの使用を識別します。行動モデルの構築の際「スコープ」の決定に使用されます。例: s=93484
targetType	Required	プリファレンスとして送られる値です。ブランド、カテゴリー、商品、店舗のいずれかの値である必要があります。例: targetType=brand
u	Required	ユーザーIDです。各買物客（ユーザー）を識別する一意の文字列です。すべてのショッパー行動はこのキーを使用して保存されます。大文字小文字を区別します。また他のアプリケーションで弊社に送っているユーザーIDと一致している必要があります。例: u=0982347
vg	Optional	View GUIDです。レコメンデーション・セットを識別するための一意の文字列です。リッチレリバンスのレスポンスの一部として返されます。例: vg=1a477338-4fae-4185-e637-3252c78feade

リクエスト例

GET

http://recs.richrelevance.com/rrserver/api/user/preference?apiKey=showcaseparent&s=10&u=1&vg=1a477338-4fae-4185-e637-3252c78feade&p=21653692&targetType=product&actionType=like

JavaScriptのリクエスト例

function logPreference(action, target, externalId) {
  var prefUrl="http://recs.richrelevance.com/rrserver/api/user/preference?apiKey="+ R3_COMMON.apiKey + "&s="+ rrSessionId + "&u=" + R3_COMMON.userId +"&vg=" + RR.pq('vg') + "&p=" + externalId + "&targetType="+ target +"&actionType=" + action;
  jQuery.ajax(prefUrl, {
    dataType: "jsonp",
    success: function(data, status) {
      console.log(data);
    }
  });
 }
function likeBrand() {
  logPreference("like", "brand", R3_COMMON.brand);
  }
function unlikeBrand() {
  logPreference("neutral", "brand", R3_COMMON.brand);
  }
function likeItem() {
  logPreference("like", "product", R3_ITEM.id);
  }
function unlikeItem() {
  logPreference("neutral", "product", R3_ITEM.id);
  }
function retrievePreferences(target) {
  var prefUrl="http://recs.richrelevance.com/rrserver/api/user/preference/" + R3_COMMON.userId + "?apiKey="+ R3_COMMON.apiKey + "&u=" + R3_COMMON.userId +"&fields=pref_" + target;
  jQuery.ajax(prefUrl, {
    dataType: "jsonp",
    success: function(data, status) {
      console.log(data);
    }
  });
}

結果の例

200 OK

{
   'userId':'USER185',
   'pref_product':{
      'like':[
         '1234',
         '5678'
      ],
      'dislike':[
         'abcd'
      ]
   },
   'pref_brand':{
      'like':[
         'Sony',
         'Nabisco'
      ]
   },
   'pref_category':{
      'like':[
         '8989',
         '8080'
      ]
   },
   'pref_store':{
      'like':[
         'ca_128'
      ]
   }
}