[Premium]{class="badge positive" title="Target Premium に含まれる機能を確認してください。"}

エンティティの属性

エンティティ属性を使用して、製品情報またはコンテンツ情報を Adobe Target Recommendations に渡します。

エンティティとは、レコメンデーションする項目を指します。 エンティティには、製品、コンテンツ（記事、スライドショー、画像、ムービー、テレビ番組）、求人情報、レストランなどが含まれます。

Recommendations は、アルゴリズムで使用される productId または productPurchasedId（コードでは entity.id と呼ばれる）を送信します。

次の点に留意してください。

ほとんどの定義済みパラメーターでは単一の値のみを受け取り、新しい値により古い値が上書きされます。 categoryId パラメーターは、その商品を含む各カテゴリ用の値のコンマ区切りリストを受け取ることができます。 新しい categoryId の値は既存の値を上書きせず、代わりにエンティティ更新の際に追加されます（上限 250 文字）。

一般に、at.js 1.x を mboxCreate と使用している場合、表示情報 mbox は次の例のようになります。 エンティティのパラメーター属性はすべて大文字と小文字が区別されます。

<div class="mboxDefault"></div><script language="JavaScript1.2">

mboxCreate('productPage',

'entity.id=67833',

'entity.name=GIANTS VS ROCKIES 5/12',

'entity.categoryId=BASEBALL, GIANTS, SF BAY AREA',

'entity.pageUrl=/help/baseball/giants-tix/giantsvrockies5.12.2000-67833',

'entity.venue=AT&T PARK',

'entity.secondary=ROCKIES',

'entity.thumbnailUrl=/help/baseball/giants-tix/giants-136px.gif',

'entity.message=FAMILY SPECIAL',

'entity.value=15.99',

'entity.inventory=1'

);

</script>

mbox が製品ページにある場合は、製品 ID とカテゴリ ID の両方を含めることができます。 そのどちらが表示されるかは選択されているアルゴリズムで決定されます。 商品 ID は親和性アルゴリズムで使用され、カテゴリ ID はカテゴリアルゴリズムで使用されます。

使用できる変数

次のリストで、使用できる変数について説明します。

entity.id

単一値のみ。

この必須パラメーターで商品を識別します。 様々な商品の品目を識別してそのデータを共有するために、この英数字 ID は、使用するすべての Adobe Experience Cloud 製品（Analytics を含む）で同じにする必要があります。

entity.id の値には、スペース、スラッシュ、アンパサンド、疑問符、パーセント記号、コンマまたは REST API 呼び出しで渡される際に URL エンコーディングが必要となるその他の句読点文字を含めることはでき​ません。 ハイフンとアンダースコアは許可されています。 entity.id 値に無効な句読点を含めると、一部の Recommendations 機能が正常に動作しなくなることがあります。

例：'entity.id=67833'

entity.name

単一値のみ。

商品がレコメンデーションされる際に Web サイトに表示される商品名。

例：'entity.name=Giants& vs& Rockies& 5/12'

entity.categoryId

複数値（コンマ区切りリスト）をサポート。

現在のページのカテゴリです。 entity.categoryID には、カーディガンのサブサブセクション（例：womens、womens:sweaters、womens:sweaters:cardigans）など、複数のカテゴリを含めることができます。 複数のカテゴリはコンマで区切る必要があります。

categoryId の値は 250 文字に制限されています。

例：

カテゴリベースのレコメンデーションの場合、カテゴリ値はコンマで区切られます。 コンマで区切られた値はカテゴリになります。 また、別の区切り文字（コロン（:）など）を使用してカテゴリ値内のサブカテゴリを区切ることで、サブカテゴリを定義できます。

例えば、次のコードでは、Women’s カテゴリが複数のサブカテゴリに分割されています。

mboxCreate('mboxName', 'entity.id=343942-32', 'entity.categoryId= Womens, Womens:Outerwear, Womens:Outerwear:Jackets, Womens:Outerwear:Jackets:Parka, Womens:Outerwear:Jackets:Caban', 'entity.thumbnailUrl=...', 'entity.message=...', );

mbox 配信の場合、最も長い属性名がキーに使用されます。 同じ長さの場合、最後の属性が使用されます。 上記の例では、カテゴリキーは Womens:Outerwear:Jackets:Caban です。

entity.brand

単一値のみ。

品目のブランド名を表示します。

例：'entity.brand=brandxyz'

entity.pageUrl

単一値のみ。

その品目を購入できるページの相対 URL を定義します。

例：'entity.pageUrl=baseball/giants-tix/giantsvrockies5.12.2000-67833'

entity.thumbnailUrl

単一値のみ。

品目と共に表示されるサムネールの相対 URL を定義します。

例：'entity.thumbnailUrl=baseball/giants-tix/giants-136px.gif'

entity.message

単一値のみ。

「特価」や「クリアランス」など、レコメンデーションに表示する商品についてのメッセージです。 メッセージは通常、商品名よりも長いものとなります。 entity.message を使用して、テンプレート内で製品と共に表示する追加情報を定義します。

例：'entity.message=Family special'

entity.inventory

単一値のみ。 整数値または long 値が必要です。

品目の在庫レベルを表示します。

例：'entity.inventory=1'

在庫が空の場合の属性処理：​配送の場合、entity.inventory > 0 または entity.inventory = 0 の包含ルール、コレクションルールまたは条件設定があり、製品の在庫が設定されていない場合、Target はこの値を TRUE と評価し、在庫が設定されていない製品を含めます。 その結果、在庫が設定されていない製品がレコメンデーション結果に表示されます。

同様に、entity.inventory = 0 で entity.inventory が設定されていないグローバル除外ルールがある場合は、Target はこのルールを TRUE と評価し、その商品を除外します。

既知の問題：​在庫値の属性が設定されていない場合、製品検索に配送との一貫性がありません。 例えば、entity.inventory = 0 のルールの場合、製品検索では在庫値が設定されていない製品は表示されません。

entity.value

単一値のみ。

品目の価格や価値を定義します。

例：'entity.value=15.99'

entity.value は小数形式のみをサポートします（例：15.99）。 コンマ形式（15,99）はサポートされていません。

entity.margin

単一値のみ。

その品目の利益幅またはその他の価値。

例：'entity.margin=1.00'

entity.custom

複数値（JSON 配列）をサポートします。

品目について追加情報を提供するカスタム変数を最大 100 個まで定義できます。 カスタム属性のそれぞれに対し、未使用の属性名を指定できます。 例えば、書籍や映画を定義するために、entity.genre というカスタム属性を作成できます。 チケットベンダーは、スポーツイベントの来訪チームやコンサートの前座など、2 次的な出演者向けにイベント会場の属性を作成できます。

制限事項：

例：

'entity.venue=AT&T Park'

'entity.secondary=Rockies'

カスタムエンティティの属性では、複数の値がサポートされます。 文字および値の制限については、カスタムエンティティの属性を参照してください。

例：'entity.secondary=["band1", "band2"]'

複数値のカスタムエンティティの属性には、有効な JSON 配列が必要です。 詳しくは、カスタムエンティティ属性を参照してください。

entity.event.detailsOnly

単一値のみ。

mbox の呼び出しによって、アルゴリズムの行動データカウンターが増加することを回避するために使用します。

例：'entity.event.detailsOnly=true'

以下の例では、最初の mbox 呼び出しにより、カタログと行動データが更新されます。 2 回目の mbox 呼び出しでは、カタログのみが更新されます。

mboxCreate('myMbox', 'profile.geo.city = new york', 'profile.geo.state = new york',  'entity.id = 'entity.inventory = 4' )
mboxCreate('myMbox',  'profile.geo.city = new york', 'profile.geo.state = new york',  'entity.id = 123', 'entity.inventory = 4' 'entity.event.detailsOnly=true' )