$p("setRequestFields")

$p("setRequestFields"): ([String]) -> undefined

📘

技術ドキュメント

このページでは、setRequestFields関数について説明します。さらに詳しい説明については、フィールドの編集およびアイテムの非表示のドキュメントを参照してください。

お客様のアイテムに関連するあらゆるデータをLiftIgniterに送ることができますが、お客様側でリコメンデーションを表示する際には、それらのフィールドを返す必要はありません。そのような場合は、SDK関数の$p("setRequestFields", FIELD_ARRAY)を使用することができます。

// 返されるリコメンデーションにtitleとurlのフィールド名をリクエストする。
$p("setRequestFields",["name","title","url"])

リコメンデーションを取得する前にこの関数を呼び出すことで、リコメンデーションが、指定されたフィールドだけをメタデータとして返すようにします。

お客様が指定したすべてのリクエストフィールドを持つアイテムだけを返すようにするには、リコメンデーションを取得する前に下記の関数を実行することができます。ここではAONはall or nothingを意味します。

$p("setRequestFieldsAON",true)

常に受け取るフィールドのリクエストの組み合わせがあり、それがすべてのリクエストフィールドではない場合は、必須のリクエストフィールドを別に設定することができます。必須のリクエストフィールドは、リクエストするフィールドの組み合わせである必要があります。それ以外の場合はなにも返されません。

// titleとurlをリコメンデーションを返す際の必須のフィールドに指定する
$p("setMandatoryRequestFields",["title","url"])

必須のフィールドを持つアイテムだけが返されます。残りの必須ではないフィールドは、アイテムがそれらのフィールドを持つ場合だけ返されます。

[setRequestFieldsAON]は、[setMandatoryRequestFields]よりも優先されます。