API de gestion des règles de contenu Engage
Vue d’ensemble
L'API de gestion des règles de contenu Engage permet à une organisation de créer et de gérer les règles de contenu pour leur site. Les règles de contenu peuvent être utilisées pour transmettre une catégorie de départ pour les recommandations de produits aux visiteurs correspondant à un segment et un contexte, comme un emplacement sur la page d'accueil.
Note: Le Contexte et/ou les Segments doivent être créés pour utiliser cette API avec le ContextID ou le SegmentID.
https://{environment}.richrelevance.com/engage/api/engageRules/{version}Note: L’URL nécessite l’environnement (gateway, staging-gateway ou qa-gateway), la version et les paramètres pour fonctionner correctement. Voir ci-dessous pour plus d’informations sur les exemples de requêtes URL.
Description : Fournit des mises à jour au profil utilisateur dans le service de profil utilisateur (actuellement, implémente uniquement l’option de désactivation).
Paramètres
|
Nom |
Obligatoire ou Optionnel |
Description |
|---|---|---|
|
externalId |
Optionnel |
L'ID généré de la règle. Laissez vide pour de nouvelles règles. |
|
name |
Optionnel |
Le nom de la règle |
|
contextId |
Optionnel |
L'ID du contexte |
|
segmentId |
Optionnel |
L'ID du (des) segment(s) |
|
enableQA |
Optionnel |
La règle est-elle applicable dans l'environnement QA ? |
|
enableProd |
Optionnel |
La règle est-elle applicable dans l'environnement de production ? |
|
startTime |
Optionnel |
L'heure à laquelle la règle devient active |
|
endTime |
Optionnel |
L'heure à laquelle la règle expire. |
|
contentType |
Optionnel |
Le type de contenu à inclure via la règle |
|
engageContent |
Optionnel |
Doit correspondre à la valeur de contentType |
|
personalizedRecommendation |
Optionnel |
Les recommandations de produits doivent-elles être personnalisées ? Par défaut : false |
|
categoryExternalId |
Optionnel |
L'ID externe de la catégorie utilisée comme point de départ pour les recommandations de produits affichées dans cette règle. |
|
brandExternalID |
Optionnel |
L'ID externe de la marque utilisée comme point de départ pour les recommandations de produits affichées dans cette règle. |
|
targetCartValueCents |
Optionnel |
La valeur cible du panier en centimes. |
|
content |
Optionnel |
Le contenu associé à cette règle. |
|
priority |
Optionnel |
Priorité de la règle, exprimée sous forme d'entier entre 0 et 10. La valeur par défaut est 5. |
Étiquettes
|
Nom |
Obligatoire ou Optionnel |
Description |
|---|---|---|
|
labelType |
Optionnel |
ID généré pour l'étiquette. |
|
label |
Optionnel |
Valeur de l'étiquette. |
Exemple
value: "{\n \"id\": 0,\n \"label\": \"some label\"\n}"Type de Tag
|
Nom |
Obligatoire ou Optionnel |
Description |
|---|---|---|
|
id |
Optionnel |
ID généré pour le tag. |
|
label |
Optionnel |
Valeur du tag. |
Exemple
value: "{\n \"id\": 0,\n \"label\": \"some label\"\n}"Type de Contenu
|
Nom |
Obligatoire ou Optionnel |
Description |
|---|---|---|
|
id |
Optionnel |
ID généré pour le contenu. |
|
productType |
Optionnel |
Type de produit associé. |
|
externalId |
Optionnel |
ID externe associé. |
|
title |
Optionnel |
Titre associé au contenu. |
|
startDate |
Optionnel |
Date de début associée au contenu. |
|
endDate |
Optionnel |
Date de fin associée au contenu. |
|
recommendable |
Optionnel |
Indique si le contenu peut être recommandé. |
|
findable |
Optionnel |
Indique si le contenu est trouvable. |
|
attributes |
Optionnel |
Attributs associés au contenu. |
|
label |
Optionnel |
Valeur de l'étiquette associée au contenu. |
Exemple
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
}"
|
Nom |
Obligatoire ou Optionnel |
Description |
|---|---|---|
|
regionalAttributes |
Optionnel |
Attributs régionaux associés au contenu. |
|
totalMaxViews |
Optionnel |
Nombre maximum total de vues pour le contenu. |
|
startDateTime |
Optionnel |
Date et heure de début associées au contenu. |
|
endDateTime |
Optionnel |
Date et heure de fin associées au contenu. |
|
trimmedName |
Optionnel |
Nom raccourci du contenu. |
|
previewImageURL |
Optionnel |
URL de l'image d'aperçu associée au contenu. |
|
tags |
Optionnel |
Tags associés au contenu. |
Exemple
value: "{\n
\"id\": 20308744177,\n
\"productType\": 2,\n
\"externalId\": \"content__12\",\n
\"title\": \"Banner ABAIXO 3\",\n
\"startDate\": \"2018-04-05\",\n
\"endDate\": null,\n
\"recommendable\": true,\n
\"findable\": false,\n
\"attributes\": {\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
},\n
\"regionalAttributes\": [],\n
\"totalMaxViews\": -1,\n
\"resetViews\": false,\n
\"startDateTime\": \"2018-04-05T00:00\",\n
\"endDateTime\": null,\n
\"trimmedName\": \"Banner ABAIXO 3\",\n
\"active\": true,\n
\"previewImageURL\": \"https://images-americanas.b2w.io/spacey/2018/04/10/DiaDasMaes__SITE_banner-quadruplo.png\",\n
\"tags\": [{\n
\"id\": 196254,\n
\"externalId\": \"3\"\n
}]\n
}"