定義
ドキュメント
ユーザデータとアクティビティおよびModelクエリの一貫性
ユーザデータとアクティビティおよびModelクエリのユーザデータとの関連付けを行うには、アクティビティとModelクエリの間で、同じユーザIDの値を使用する必要があります。そうすることで、その情報に基づいてユーザデータと最適化されたリコメンデーションを、そのユーザIDに対して送ることができます。
/activity bodyと共有するフィールド
JSONの例と[/activity]エンドポイントに示した通り、JSONの[key]フィールドは似ています。LiftIgniterでは、ユーザの行動のコンテキストにあわせた[インベントリ]アイテムのリコメンデーションを送信します。[apiKey]を送るだけでもリコメンデーションを送りはしますが、[タイムスタンプ]、[URL]、[ユーザID]、[閲覧履歴]、[リファラ]をあわせて送るときほどの効果を出すことはできません。The pageviewId and sessionId fields may make sense depending on your context (we recommend sending these if you are sending the corresponding fields in the activities).
pageviewId and deduplication
Sending both userId and pageviewId allow us to deduplicate recommendations between queries that have the same pageviewId and userId (e.g., different areas on the same page).
Note however that we only deduplicate if the requests are made serially; we deduplicate between a request and previous completed requests, but we do not deduplicate between requests made in parallel. If you need to make multiple requests on the same userId and pageviewId in parallel and want deduplication, you should request more items than you need for each widget and handle the deduplication yourself.
Modelクエリの特有のフィールド
[maxCount]（この利用を推奨します）は、受け取りたいアイテムの最大件数です。技術的には最大で100件まで処理できます（デフォルト値）。しかしながら、通常では25件以上のアイテムを返すことは保証していません。特定のユーザのコンテキストにおいて、制限のあるルールを適用すると、リクエストされた件数に満たない数のアイテムを返すことがあります。[requestFields]は、インベントリアイテムを返す際に含めたいインベントリフィールドのリストです。それぞれのインベントリアイテムに対して、インベントリアイテムでここに含められたフィールドのみを送信します。ここに設定されたデフォルトの値は、title、url、rankおよびthumbnailです。しかしながら、お客様がごとに指定された値をデフォルトでは設定することもできます。そうすることでリクエストを送る際に、毎回このフィールドを設定する必要がなくなります。Javascriptでの組み込みに関連するオプションについては、リコメンデーションのリクエスト特有のフィールドにおいて説明しています。[requestFieldsAON]は、"true"または"false"で指定する値で、ここではデフォルトで"false"に設定しています。この値が"true"の場合はリクエストされたすべてのフィールドを持つアイテムを返します。Javascriptでの組み込みに関するオプションについては、リコメンデーションのリクエスト特有のフィールドにおいて説明しています。[maxAgeInSeconds]は、受け取りたいアイテムの最大表示時間（秒）です。Javascriptでの組み込みに関するオプションについては、リコメンデーションの表示時間の設定において説明しています。[excludeItems]は、リコメンデーションの対象から除外したいアイテムの識別子です。Javascriptでの組み込みに関するオプションについては、リコメンデーションのアイテム除外において説明しています。
Modelクエリエンドポイントを使用したランキングの更新
Modelクエリエンドポイントは、ランキングの更新にも使用できます。このような使用を行うためには、[itemsToRank]のフィールドに、ランキングの更新をしたいアイテムの配列を指定して送る必要があります。
Modelクエリエンドポイントを使用した人気の高いまたはトレンディングアイテムのリスト取得
Modelクエリエンドポイントは、人気の高いまたはトレンディングアイテムのリストを受け取ることにも使用できます。しかしながら、このようなリストをリコメンデーションと同様に使用すると、リコメンデーションとしての効果が弱まる場合があることを事前に認識してください。このような使用は、オプティマイゼーションやCTRに関係なく、人気のアイテムのリストを作成したい場合のみに使用することを推奨します。
このエンドポイント特有のパラメータは下記のとおりです:
[rankingKey]は、アイテムを降順でランク付けするためのキーです。"click"、"visible"、"show"、"click:visible"、"click:show"、"visible:show"の値をrankingKeyに使用できます。値の中に":"が含まれているものは比率に換算されるため、分子から分母に対する比率の降順にランク付けされます。この値が指定されていない場合は、上位のアイテムがランダムに送信されます。[lookupKey]は、"popular"または"click"の2つの値を持つキーです。"popular"キーを指定すると多く閲覧されたアイテム、"click"キーを指定すると多くクリックされたアイテムのリストを取得します。この[lookupKey]のデフォルト値は"click"です。[hoursBehind]は、この処理対象に含める時間長を示します。この値を24に設定すると、過去24時間の[rankingKey]および[lookupKey]に応じた上位アイテムを送信します。
その他のパラメータのうち、下記のパラメータを継続して使用します:
- apiKey
- maxCount
- getQueryInfo（ここでは基本的なModelクエリに使用される処理ステップが適用されないため、特定の情報の一部が少なくなります）
- requestFields
- requestFieldsAON
これ以外のフィールドは無視されます。