Personalize API

各APIの実装に固有のキーです。レポート、パーミッション、マーチャンダイジング用の特定の実装チャネルの識別子です。このキーは弊社からクライアントに提供されます。

例: apiClientKey=b0126f995ac848159d

サイトを特定する固有のキーです。弊社のクライアントはそれぞれ固有のAPIキーをお持ちです。これによって他のクライアントのデータやトラフィックと区別します。このキーは弊社からクライアントに提供されます。

例: apiKey=4faeaf752ee40a0f

カートに追加IDです。単独または複数の商品IDです。カートに複数の商品が入れられている場合は、商品IDをパイプ「|」で区切ってください。

例: atcid=uv2345|xt1234

JSONデータが渡されるJavasScriptの関数名です。このパラメーターはJSONPが使用されている場合必須です。このパラメーターの値は、レスポンス内で関数名として使用されます。

例: callback=products_returned

false（偽）に設定されている場合はカテゴリー・データ（カテゴリーID及びカテゴリー）を省略します。既定値はtrue（真）です。

例: categoryData=false

マーチャントが調査するカテゴリーのIDです。マーチャントがリッチレリバンスに提供しているこのカテゴリーの外部IDと一致している必要があります。

例: categoryId=902312

カート合計額です。カート合計額に基づきターゲットを絞ったキャンペーンに使用されます。

例: cv=9550（ドルの場合$95.50、日本円の場合9,550円）

true/false（真偽）値で設定されます。true（真）の場合、リッチレリバンスのサーバー・レスポンスで返されるHTMLを省略します。false（偽）の場合、レスポンスにhtmtフィールドのレイアウトで設定されたプレースメントのHTMLが含まれます。既定値はfalse（偽）です。 

例: excludeHtml=true

ページ上でブランドを表示します。BrandTopSellersなどのブランドをシードとするストラテジーでシードの設定に使用されます。

例: fpb=Microsoft

trueの場合、rcsの文字列が含まれます。既定値はfalseです。

例: includeRcs=true

trueの場合、 既定値はfalseです。true の場合、レスポンスには選択されたコンテンツに対するルール情報、具体的にはルール名とルールIDが含まれます

例: includeRuleInfo=true

trueの場合、 既定値はfalseです。true の場合、応答には各プレースメントで選択されたコンテンツのスコアが含まれます。

例: includeScore=true

trueの場合、 既定値はfalseです。true の場合、応答には選択したコンテンツのタグのリストが含まれます。

例: includeTags=true

プレースメントIDの一覧です。各IDはページ・タイプとプレースメント名で構成されています。IDは、パイプ文字で区切られます。

一つのプレースメントに対し受け取るコンテンツは一つです。一つのコール内のプレースメントはすべて同じページ・タイプの物である必要があります。

例: placements=item_page.horizontal|item_page.vertical

買物客がページを閲覧する前の参照元（リファラ）です。レポートやマーチャンダイジングに使用されます。お使いになるよう強くお勧めします。

例: pref=http://www.google.com

単独のまたは複数の商品IDです。購入完了ページの注文定義の一部です。商品IDはパイプ「|」で区切ってください。

例: productId=uv2345|xt1234

ファーストパーティ・クッキーの文字列です。リッチレリバンス・クッキーの暗号化された値です。事前にAPIレスポンスで受け取ったものをそのまま送信してください。

現在のセッションで買物客が購入した商品です。単独または複数の商品IDです。一連の商品は履歴データと合わせて考慮されます。商品IDはパイプ「|」で区切ってください。

例: recentlyPurchased=uv2345|xt1234

買物客の一回の訪問を識別します。セッションは行動モデルで使用され（買物セッション中のユーザー・コードをスコープします）、指標をレポートします。

例: sessionId=93484

ユーザー・セグメントです。セグメントをターゲットとしたキャンペーンで使用されます。segment_number:segment_name形式で各セグメントを記載しパイプ「|」でセグメントを区切ってください。各セグメントのセグメントIDとセグメント名を渡す必要があります。

例: sgs=101:NewUser|202:Male

trueの場合、レイアウトで変数がどのように命名されているかに応じてhttp/httpsを返します。

ssl=true

現在の買物客を表すカスタム・キー及び値です。情報はセミコロン「;」及びパイプ「|」で区切ってください。

例: userAttribute=eye_color:blue;green|hair_color:brown

リクエストに基づくプロモーション用のプレースメント一覧です。JSONオブジェクトの配列であり、それぞれが一つのプレースメントを記述しています。

表示する創作物の一覧です。ほとんどの場合一つだけです。

クリックの追跡のため宛先URLは変換され本来のクリックスルーURLにリディレクトされます。

そのプレースメントに対するレイアウトと選択したキャンペーンに基づく完全なフォームのHTMLです。デフォルトでレスポンスに含まれます。excludeHtmlリクエスト・パラメーターを使用してオフにできます。

表示する創作物の一覧です。ほとんどの場合一つだけです。

「ok」または「error」となります。