パーソナライズAPI

説明

recs.richrelevance.com/rrserver/api/personalize

任意のユーザー及びプレースメントに対するコンテンツを返します。

パラメーター

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

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

名称	必須 / オプション	説明
apiClientKey	必須	各APIの実装に固有のキーです。レポート、パーミッション、マーチャンダイジング用の特定の実装チャネルの識別子です。このキーは弊社からクライアントに提供されます。例: apiClientKey=b0126f995ac848159d
apiKey	必須	サイトを特定する固有のキーです。弊社のクライアントはそれぞれ固有のAPIキーをお持ちです。これによって他のクライアントのデータやトラフィックと区別します。このキーは弊社からクライアントに提供されます。例: apiKey=4faeaf752ee40a0f
atcid	カートに追加ページで必須	カートに追加IDです。単独または複数の商品IDです。カートに複数の商品が入れられている場合は、商品IDをパイプ「\|」で区切ってください。例: atcid=uv2345\|xt1234
callback	オプション	JSONデータが渡されるJavasScriptの関数名です。このパラメーターはJSONPが使用されている場合必須です。このパラメーターの値は、レスポンス内で関数名として使用されます。例: callback=products_returned
categoryData	オプション	false（偽）に設定されている場合はカテゴリー・データ（カテゴリーID及びカテゴリー）を省略します。既定値はtrue（真）です。例: categoryData=false
categoryId	カテゴリー・ページで必須	マーチャントが調査するカテゴリーのIDです。マーチャントがリッチレリバンスに提供しているこのカテゴリーの外部IDと一致している必要があります。例: categoryId=902312
cv	オプション	カート合計額です。カート合計額に基づきターゲットを絞ったキャンペーンに使用されます。例: cv=9550（ドルの場合$95.50、日本円の場合9,550円）
excludeHtml	オプション	true/false（真偽）値で設定されます。true（真）の場合、リッチレリバンスのサーバー・レスポンスで返されるHTMLを省略します。false（偽）の場合、レスポンスにhtmtフィールドのレイアウトで設定されたプレースメントのHTMLが含まれます。既定値はfalse（偽）です。例: excludeHtml=true
fpb	オプション	ページ上でブランドを表示します。BrandTopSellersなどのブランドをシードとするストラテジーでシードの設定に使用されます。例: fpb=Microsoft
includeRcs	オプション	trueの場合、rcsの文字列が含まれます。既定値はfalseです。例: includeRcs=true
placements	必須	プレースメントIDの一覧です。各IDはページ・タイプとプレースメント名で構成されています。IDは、パイプ文字で区切られます。一つのプレースメントに対し受け取るコンテンツは一つです。一つのコール内のプレースメントはすべて同じページ・タイプの物である必要があります。例: placements=item_page.horizontal\|item_page.vertical
pref	オプション	買物客がページを閲覧する前の参照元（リファラ）です。レポートやマーチャンダイジングに使用されます。お使いになるよう強くお勧めします。例: pref=http://www.google.com
productId	以下のページで必須: アイテム・ページカートに追加ページ購入完了ページ、カート・ページ（商品が入っている場合の）	単独のまたは複数の商品IDです。購入完了ページの注文定義の一部です。商品IDはパイプ「\|」で区切ってください。例: productId=uv2345\|xt1234
rcs	オプション	ファーストパーティ・クッキーの文字列です。リッチレリバンス・クッキーの暗号化された値です。事前にAPIレスポンスで受け取ったものをそのまま送信してください。
recentlyPurchased	オプション	現在のセッションで買物客が購入した商品です。単独または複数の商品IDです。一連の商品は履歴データと合わせて考慮されます。商品IDはパイプ「\|」で区切ってください。例: recentlyPurchased=uv2345\|xt1234
sessionId	オプション	買物客の一回の訪問を識別します。セッションは行動モデルで使用され（買物セッション中のユーザー・コードをスコープします）、指標をレポートします。例: sessionId=93484
sgs	オプション	ユーザー・セグメントです。セグメントをターゲットとしたキャンペーンで使用されます。segment_number:segment_name形式で各セグメントを記載しパイプ「\|」でセグメントを区切ってください。各セグメントのセグメントIDとセグメント名を渡す必要があります。例: sgs=101:NewUser\|202:Male
ssl	オプション	trueの場合、レイアウトで変数がどのように命名されているかに応じてhttp/httpsを返します。 ssl=true
userAttribute	オプション	現在の買物客を表すカスタム・キー及び値です。情報はセミコロン「;」及びパイプ「\|」で区切ってください。例: userAttribute=eye_color:blue;green\|hair_color:brown
userId	オプション	ユーザーIDです。各買物客（ユーザー）を特定する固有の文字列です。買物客の全ての行動は、このキーを使用して保存されます。大文字小文字を区別し、また他のリッチレリバンスの他のアプリケーションで使用されているユーザーIDと一致している必要があります。例: userId=0982347 ユーザーIDがないと、レコメンデーションは（recentlyViewedやrecentlyPurchasedパラメーター又はクッキーによる）閲覧や購入履歴に基づくか、あるいはCategoryBestSellersなどの非パーソナライズド・ストラテジーに基づくものになってしまいます。

リクエスト例

http://recs.richrelevance.com/rrserver/api/personalize?apiKey=ABCD&apiClientKey=1234&sessionId=sess456&userId=u789&placements=home_page.page_area1

レスポンス例

{
    request: {
        apiKey: "abcd09875",
        clientKey: "f54ea54cb24",
        placements: [
            "home_page.promotion_top_01",
            "home_page.promotion_top_02",
            "home_page.promotion_top_03"
        ],
        sessionId: "null",
        userId: "null"
    },
    rcs: "eF4Ny7ERgDAMA8AmFbuIQ1gO8QbMEZOCgg6YH77_Up7cxaV1DkPPcMhMUGdFrh6xDY8c63S993nM0QJ0mazWZhTxD_ADc7cRDQ",
    placements: [
        {
            creatives: [
                {
                    DESTINATION_URL: "http://recs.richrelevance.com/rrserver/click?a=c6db6e5a99c90d0e&vg=a209885c-4513-4418-0713-f959d6ff5c41&pti=9&pa=promotion_top_01&hpi=11963&rti=2&sgs=&mvtId=-1&mvtTs=1543436683141&uguid=4108b1e3-bc95-4334-4b16-c25997e59ce2&channelId=15937f54ea54cb24&s=&pg=-1&p=content__868&ct=https%3A%2F%2Fwww.verkkokauppa.com%2Ffi%2Fjoulu",
                    START_TIME: "00:00",
                    END_TIME: "00:00",
                    MEDIA_URL: "https://cdn-a.verkkokauppa.com/files/5be3f/39b38/92800/e3f11/d78e.png",
                    trackingUrl: "N/A",
                    SIZE: "six-by-one",
                    campaign: "Joululahjaideat 2018 6x1",
                    ALT_TEXT: "Joululahjaideat. Tilaa kätevästi netistä",
                    R_RECOMMEND: "true"
                }
            ],
            html: "",
            placement: "home_page.promotion_top_01"
        }
    ],
    message: "",
    status: "ok"
}

フィールド	説明
placements	リクエストに基づくプロモーション用のプレースメント一覧です。JSONオブジェクトの配列であり、それぞれが一つのプレースメントを記述しています。
creatives	表示する創作物の一覧です。ほとんどの場合一つだけです。クリックの追跡のため宛先URLは変換され本来のクリックスルーURLにリディレクトされます。
html	そのプレースメントに対するレイアウトと選択したキャンペーンに基づく完全なフォームのHTMLです。デフォルトでレスポンスに含まれます。excludeHtmlリクエスト・パラメーターを使用してオフにできます。
status	表示する創作物の一覧です。ほとんどの場合一つだけです。
errormessage	「ok」または「error」となります。
request	リクエストのパラメーターで弊社がリクエストの処理に使用したものです。通常、テストに使用されます。