レコメンド取得の実行 #
Rtoaster SDKでは、トラッキングを行った後、 recommend
メソッドによりレコメンドを取得できます。
- レコメンドを取得するには、
track
メソッドが返すトラッカーオブジェクトが必要です。 - トラッカーオブジェクトが有効なレコメンドは1回限りです。何度もレコメンド取得を行うには、レコメンド取得毎にトラッキングを実行してください。
レコメンデーションパラメータ #
recommend
メソッドへは、 RecommendationParameter
クラスを用いてパラメータを指定します。
指定できるパラメータの内容は、以下のとおりです。
パラメータ名 | 型 | 説明 | 必須 |
---|---|---|---|
elementIds | ElementIdクラスの配列 | 取得するレコメンドに紐付くエレメントID | ○ |
values | RecommendationValuesクラス | 取得するレコメンドのフィルタを設定するパラメータ | |
tracker | ITrackerクラス | レコメンドに紐付くトラッカーオブジェクト | ○ |
RecommendationValuesクラス #
レコメンド取得では RecommendationValues
クラスを利用してレコメンド結果を制御するフィルタを設定することができます。
RecommendationValues
オブジェクトは、recommend
メソッド呼び出し時、RecommendationParameter.values
に設定します。
パラメータの詳細な使い方については、アイテム軸自動レコメンドおよびレコメンドフィルタをご覧ください。
パラメータ名 | 型 | 説明 | 必須 |
---|---|---|---|
itemCode | ItemCodesクラス | アイテム軸自動レコメンドを指定するためのアイテムコードセットを設定します。 | |
category1 | Categoryクラス | カテゴリフィルタ(1階層目)を設定します。 | |
category2 | Categoryクラス | カテゴリフィルタ(2階層目)を設定します。 | |
category3 | Categoryクラス | カテゴリフィルタ(3階層目)を設定します。 | |
category4 | Categoryクラス | カテゴリフィルタ(4階層目)を設定します。 | |
category5 | Categoryクラス | カテゴリフィルタ(5階層目)を設定します。 | |
priceRange | PriceRangeクラス | 価格フィルタを設定します。 | |
targetItemCodes | MultipleTargetMapクラス | マルチターゲットアイテムマップを設定します。 | |
excludedItemCodes | ItemCodeSetクラス | アイテムフィルタ(レコメンドから除外するアイテム条件)のアイテムコードセットを設定します。 |
レコメンド処理のコールバック #
recommend
メソッドが呼び出されるとイベントによって下記のコールバックが呼び出されます。
処理が必要なイベントには、コールバックを実装してください。
コールバック | 呼び出されるタイミング |
---|---|
onStart | レコメンドリクエストが送信開始されたとき |
onSuccess | レコメンドリクエストが成功したとき 呼び出し時、取得したレコメンド結果を格納した RecommendationResult クラスのパラメータが渡されます。取得したレコメンド結果が0件の場合にも対応してください。 |
onFailure | レコメンドリクエストが失敗したとき |
onCancel | レコメンドリクエストがcancel メソッドによりキャンセルされたとき |
サンプルコード #
サンプルコードはアイテム軸自動レコメンドをご覧ください。