Engageコンテンツ・ルール・マネージメントAPI
Engageコンテンツ・ルール・マネージメントAPIを使い、サイトで使用するコンテンツ・ルールを作成し管理することができます。コンテンツ・ルールを使用して、セグメントやコンテキストと一致する訪問者への、例えばホームページ上のプレースメントの商品レコメンデーションのシード・カテゴリーを送信することができます。
注記: ContextIDやSegmentIDによってこのAPIを使用するためには、コンテキストやセグメントを作成する必要があります。
https://{environment}.richrelevance.com/engage/api/engageRules/{version}
注記: URLには環境（ゲートウェイ、ステージング・ゲートウェイ、又はQAゲートウェイ）、バージョン、及びパラメーターが必要です。URLリクエストの例に関するさらなる情報については以下を参照してください。
説明: ユーザー・プロファイル・サービス内のユーザー・プロファイルを更新します（現時点ではオプトアウトのみ実装します）。
パラメーター
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| externalId | オプション | ルールに対し生成されたIDです。新しいルールの場合は空白のままにしてください。 |
| name | オプション | ルールの名称です。 |
| contextId | オプション | コンテキストのIDです。 |
| segmentId | オプション | セグメントのIDです。 |
| enableQA | オプション | ルールがQA環境に適用可能かどうかを示します。 |
| enableProd | オプション | ルールが本番環境に適用可能かどうかを示します。 |
| startTime | オプション | ルールが有効になる時刻です。 |
| endTime | オプション | ルールの有効期限時刻です。 |
| contentType | オプション | ルールの対象となるコンテンツのタイプです。 |
| engageContent | オプション | countentTypeの値と一致している必要があります。 |
| personalizedRecommendation | オプション | 商品レコメンデーションがパーソナライズされているかどうかを示します。 既定値はfalse（偽）です。 |
| categoryExternalId | オプション | このルールの一部として表示される商品レコメンデーションに使用されるカテゴリー・シードです。 |
| brandExternalID | オプション | このルールの一部として表示される商品レコメンデーションに使用されるブランド・シードです。 |
| targetCartValueCents | オプション | ターゲットとするカート合計額です。 |
| content | オプション | |
| priority | オプション | 0から10の整数で表されるルールの優先度です。既定値は5です。 |
ラベル
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
|
labelType |
オプション | ラベルに対し生成されたIDです。 |
| label | オプション | ラベルの値です。 |
例
value: "{\n \"id\": 0,\n \"label\": \"some label\"\n}"
タグ・タイプ
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
|
id |
オプション | タグに対し生成されたIDです。 |
| label | オプション | タグの値です。 |
例
value: "{\n \"id\": 0,\n \"label\": \"some label\"\n}"
Content Type
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| id | オプション | タグに対し生成されたIDです。 |
| productType | オプション | |
| exertnalId | オプション | |
| title | オプション | |
| startDate | オプション | |
| endDate | オプション | |
| recommendable | オプション | |
| findable | オプション | |
| attributes | オプション | |
| label | オプション | タグの値です。 |
例
value: "{\n \"AREA\": \"DESTAQUE\",\n \"CONTENT_ALT\": \"OFERTA\"\
,\n \"CONTENT_IMAGE\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
,\n \"CONTENT_IMAGE_M\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
,\n \"CONTENT_URL\": \"https://www.americanas.com.br/hotsite/dia-das-maes\"\
,\n \"r_recommend\": \"true\",\n \"start_time\": \"00:00\"\n}"
| 名称 | 必須 / オプション | 説明 |
|---|---|---|
| regionalAttributes | オプション | |
| totalMaxViews | オプション | |
| startDateTime | オプション | |
| totalMaxViews | オプション | |
| resetViews | オプション | |
| startDateTime | オプション | |
| endDateTime | オプション | |
| trimmedName | オプション | |
| previewImageURL | オプション | |
| previewImageURL | オプション | |
| tags | オプション |
例
value: "{\n\t\t\t\"id\": 20308744177,\n\t\t\t\"productType\": 2,\n\t\t\t\"externalId\"\
: \"content__12\",\n\t\t\t\"title\": \"Banner ABAIXO 3\",\n\t\t\t\"startDate\"\
: \"2018-04-05\",\n\t\t\t\"endDate\": null,\n\t\t\t\"recommendable\": true,\n\
\t\t\t\"findable\": false,\n\t\t\t\"attributes\": {\n\t\t\t\t\"AREA\": \"\
DESTAQUE\",\n\t\t\t\t\"CONTENT_ALT\": \"OFERTA\",\n\t\t\t\t\"CONTENT_IMAGE\"\
: \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
,\n\t\t\t\t\"CONTENT_IMAGE_M\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
,\n\t\t\t\t\"CONTENT_URL\": \"https://www.americanas.com.br/hotsite/dia-das-maes\"\
,\n\t\t\t\t\"r_recommend\": \"true\",\n\t\t\t\t\"start_time\": \"00:00\"\n\
\t\t\t},\n\t\t\t\"regionalAttributes\": [],\n\t\t\t\"totalMaxViews\": -1,\n\
\t\t\t\"resetViews\": false,\n\t\t\t\"startDateTime\": \"2018-04-05T00:00\"\
,\n\t\t\t\"endDateTime\": null,\n\t\t\t\"trimmedName\": \"Banner ABAIXO 3\"\
,\n\t\t\t\"active\": true,\n\t\t\t\"previewImageURL\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\"\
,\n\t\t\t\"tags\": [{\n\t\t\t\t\"id\": 196254,\n\t\t\t\t\"externalId\": \"\
3\"\n\t\t\t}]\n\t\t}"