Relevance Cloud: APIs

概要

ウェブサイトやアプリでの商品およびコンテンツのレコメンデーションのパーソナライズに、Relevance Cloud APIを利用することができます。

最も効率的な方法でリンクを提供しレイテンシーを抑えるために、APIは必要な全情報を一つのコールで返します。レコメンド商品の表示に必要なすべての情報はレスポンスで提供されます。

含まれる機能の一部

Relevance Cloudダッシュボードによる完全なレポート
ユーザー行動に基づくインテリジェントなデータ・モデルの調整
マーチャンダイジング・ルールのサポート（APIによって返されるレコメンデーションはダッシュボードで設定されたすべてのルールを遵守します）

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

詳細ページへのリンク（英語版）	説明
catalogInfo	特定のカテゴリー内の子カテゴリーを指定されたレベル（深さ）まで返します。カテゴリー内の兄弟カテゴリーを確認する場合はcatalogInfo/siblingsを参照してください。
catalogInfo/siblings	特定のカテゴリーの兄弟カテゴリーを返します。
doNotUse	レコメンデーションに使用しない商品にマークを付けます。マーク付けされた商品はパーソナライズド・レコメンデーションには使用されません。
find/auto-complete	ある接頭辞で始まる人気の検索ワードの一覧を返します。
find/search	ある検索ワードの結果と選択された商品を返します。これは検索リクエストを開始する主要なAPIです。
find/track/addtocart	検索結果に含まれる商品がカートに追加された場合、そのイベントを記録します。
getProducts	指定された商品の情報を返します。
myRecs	閲覧および購入履歴に基づいてパーソナライズされたレコメンデーションを返します。パーソナライズされたレコメンデーションを返すためには、userIdパラメーターが使用されます。
personalize	特定のユーザー及びプレースメントに対するコンテンツを返します。
recsForPlacements	指定されたプレースメントに対するレコメンデーションを返し買物客の行動を記録します。
recsUsingStrategy	特定のストラテジーによるレコメンデーションを返します。このAPIコールにプレースメントは必要ありません。
service/typeAhead	キーワードの接頭辞に対するタイプアヘッド・サジェスチョンを返します。
service/userProfile	ユーザーのプロファイル情報を入手します。
service/userProfileEventStream	UPS（User Profile Service）にストリーミングされるすべてイベントを受け取るウェブ・ソケット・インターフェースです。接続時にはUPSに送られるイベント毎に1件のメッセージを受け取ります。
userInfo	ユーザーの購入および閲覧履歴に関する情報を返します。
user/preference	顧客のプリファレンスをRelevance Cloudに記録します。商品、ブランド、カテゴリー、店舗等の「好き」、「好きではない」を明示できます。またレコメンデーションに表示して欲しくない商品を明示することもできます。
user/preference{USER ID}	CPC（Customer Preference Center）の一部です。顧客の情報とプリファレンスを集約します。

圧縮

パフォーマンスの観点から、HTTPリクエストのヘッダーとレスポンス・ヘッダーにgzip圧縮を使用することを強くお勧めします。

圧縮したコンテンツ（gzip圧縮）を受領可能であるというヘッダーをサーバーに送ってください: Accept-Encoding: gzip

APIがリクエスト・ヘッダーを受け取ると、コンテンツが圧縮されレスポンスには次ようなヘッダーが付けられます: Content-Encoding: gzip

必須項目

以下の情報は弊社担当者から提供します。各APIコールの必須項目は以下のとおりです。

項目	例	説明
APIクライアント・キー	[無作為な文字列]	API実装毎の一意のキーです。レポート、許可、ログ、モニタリング用のアプリケーションを識別します。
APIキー	[無作為な文字列]	クライアントのECサイトのAPIキーです。お客様のアカウントの一意のIDです。
プレースメント	Home_page.mobile_splash, category_page.call_center_right	パーソナライズされた内容が表示されるお客様のECサイトまたはアプリの特定のエリアを識別します。（APIエンドポイントには必須ではありませんがrecsForPlacementsに必要です）