Les attributs

Les attributs de profils représentent les données principales des profils. Chaque attribut est défini par une série de paramètres qui caractérisent sa nature et l'utilisation qui sera faite de lui. Pour plus d'informations sur les attributs, nous vous invitons à lire le chapitre expliquant comment "Ajouter un attribut à la table de profil".

Le corps de la réponse présentera les attributs les uns à la suite des autres avec le détail de ses paramètres. Ceux-ci se caractérisent comme suit :

• "mandatory" : Ce paramètre indique si l'attribut est obligatoire ou pas, sous format "true/false" (vrai ou faux).

• "multiValue" : Ce paramètre indique si l'attribut peut avoir plusieurs valeurs ou pas, sous format "true/false" (vrai ou faux). Dans ce cas, les valeurs de l’attribut pour un profil particulier seront représentées comme suit : ["a","b"].

• "unicity" renseigne le caractère unique ou non de l'attribut. Il peut être :

  • UNIQUE_FOR_ALL_ELEMENTS : la valeur ne pourra être présente que pour un seul profil dans toute la base de données. Ce sera le cas pour les attributs qui peuvent être utilisés comme clé (par exemple : clientId ou emailAddress)

  • NOT_UNIQUE : la valeur de cet attribut peut être identique pour plusieurs profils (par exemple, le prénom ou le pays).

  • UNIQUE_BY_ELEMENT : seulement applicable pour les attributs multi-valeurs. Cela implique que chaque valeur possible ne pourra apparaître qu'une fois pour chaque profil.

• "valueType" : Ce paramètre indique le format attendu de l'attribut (par exemple : entier, booléen, numéro de téléphone, ...)

• "possibleValues" : Ce paramètre indique les valeurs qui seront acceptées pour l'attribut. Les valeurs non-incluses dans cette restriction seront rejetées. Ce paramètre est optionnel.

• "comment" : Ceci est description de l'attribut. Elle est optionnelle.

Les abonnements

Les abonnements représentent les opt-ins de chaque profil. Pour plus d'informations sur les abonnements, nous vous invitons à lire le chapitre expliquant comment "Ajouter un abonnement à la table de profil".

Dans le corps de la réponse de la requête webservice, ils sont renseignés sous le nom de "subscription" et se composent comme tels :

• "name" : Ce paramètre indique le nom donné à l'attribut.

• "id" : Ceci est l’identifiant technique auto-généré de l'attribut, propre à chaque base de données.

Les segmentations

Les segmentations permettent de regrouper des profils qui présentent des caractéristiques communes. Pour plus d'informations sur les segmentations, nous vous invitons à lire le chapitre expliquant comment "Ajouter une segmentation à la table de profil".

Dans le corps de la réponse de la requête webservice, elles sont renseignées sous le nom de "segmentation" et se caractérisent comme suit :

• "segmentation" : Il s'agit du nom technique de la segmentation. Celui-ci est automatiquement généré à la création de la segmentation dans l'interface, sur base du nom d'affichage choisi, mais en supprimant les espaces et les caractères spéciaux. Veuillez noter que, s'il est possible de changer le nom d'affichage d''une segmentation dans l'interface, le nom technique n'est quant à lui pas modifiable et restera toujours celui d'origine.

• "exclusive" : Ce paramètre indique s'il s'agit d'une segmentation exclusive, sous format "true/false" (vrai ou faux). Une segmentation exclusive se distingue d'une segmentation simple par l'existence de sous-catégories de segments.

• "categories" :

  • Dans le cas des segmentations exclusives, ceci indique les différents segments auxquels le profil peut appartenir.

  • Pour les segmentations simples, la seule catégorie est "Member", indiquant si un profil appartient à la segmentation ou pas.

Obtenir les caractéristiques d'un profil donné

Une fois que vous avez pris connaissance de la structure de la table de profils, vous êtes en possession des éléments nécessaires pour correctement paramétrer les méthodes d'import de profils.

Cependant, il peut être utile d'obtenir des informations à propos des profils qui sont déjà présents dans votre base de données. Cela vous donnera un exemple concret des informations qui sont attendues lors des appels de création de profils, surtout en ce qui concerne les caractéristiques des attributs individuels. Par la suite, cette opération vous permettra appeler les données d'un profil, par exemple pour la consultation de leurs coordonnées dans un espace client.

Vous pouvez récupérer les détails concernant ce profil via l'opération GET/entity/{e}/table/{t}/profile/{p}

Pour ce faire, vous devrez renseigner comme paramètres :

• L'entité

• La table de profil

• Le profil que vous voulez chercher : pour cela vous pouvez utiliser soit l'ID technique du profil (l'identifiant fourni par ACTITO à la création du profil, sous forme de "profileId") ou tout autre attribut que vous avez défini comme clé unique (par exemple : le numéro de client, l'adresse e-mail, ...). Dans le deuxième cas, il convient d'utiliser le format attributClé=valeur (par exemple, emailAddress=mailtest@actito.com). Pour connaître l'attribut servant de clé, référez-vous à la page "Accéder à la fiche d'un profil".

Exemple de requête et de réponse pour cette opération : (Téléchargez cet exemple)

Veuillez noter que certains attributs techniques sont automatiquement renseignés dans la réponse. Ces attributs ne sont pas modifiables. Il s'agit de :

• "profileId" : L'identifiant technique auto-généré, que vous avez pu utiliser comme clé

• "creationMoment" : La date et l'heure de création

• "updateMoment" : La date et l'heure de la dernière mise à jour

Les abonnements et les segmentations affichés sont uniquement ceux actuellement associés au profil. Si ce dernier ne fait pas partie d'une segmentation ou d'un abonnement, il ne sera pas affiché.

Utiliser des paramètres de requête

Si vous ne connaissez pas le "profileId" ni les autres attributs clés d'un profil donné, ou si vous voulez obtenir une liste de profils sur base de critères spécifique, vous avez la possibilité d'utiliser des paramètres de requête (query parameters) via l'opération GET/entity/{e}/table{t}/profile

Ces paramètres de recherche sont :

• "search" : Critère de recherche, pouvant être composé de plusieurs critères séparés par le signe ";". Ce critère doit être composé du nom technique d'un attribut, suivi de l'opérateur "=" et d'une valeur.

• "dateFilter" : Critères de recherche concernant une date, pouvant être composé de plusieurs critères séparés par le signe ";". Ce critère doit porter sur les attributs "creationMoment" ou "updateMoment", suivi d'un opérateur (">", "<", ">=" ou "<="), puis d'une valeur de date.

• "number" : Ce paramètre limite le nombre de résultats affichés (200 maximum et par défaut).

Imaginons que vous vouliez obtenir les détails d'un profil, n'importe lequel, afin de prendre connaissance de la structure d'une fiche profil, comme à l'étape précédente. Vous pouvez définir le filtre "number" à 1.

Obtenir les interactions d'un profil

Vous avez la possibilité d'obtenir les interactions d'un profil via l'opération GET/entity/{e}/table{t}/profile{p}/interactions

Les paramètres à renseigner dans ce cas sont l'entité, la table de profils et l'identifiant du profil. Ils seront accompagnés des critères suivants :

• "dateFilter" : Il s'agit d'un filtre de date basé sur l'attribut "creationMoment"

• "typeFilter" : Ceci est un filtre concernant le type d'interaction. Laissez ce champ vide pour inclure toutes les interactions. Un seul type d'interaction peut être ciblé à la fois. Si vous voulez cibler les interactions liées aux Custom Tables, il convient de choisir le filtre "UserDefined".

• "includeTest" : Ce filtre permet d'inclure ou d'exclure les interactions de test.

Exemple de requête visant les interactions de type e-mail et sa réponse : (Téléchargez cet exemple)

Obtenir les abonnements d'un profil

Vous avez la possibilité d'obtenir la liste des abonnements auxquels est souscrit un profil via l'opération GET/entity{e}/table{t}/profile{p}/subscription

Les paramètres à renseigner dans ce cas sont l'entité, la table de profils et l'identifiant du profil ("profileId" ou couple "attributClé=Valeur").

Exemple de requête et de réponse pour cette méthode : (Téléchargez cet exemple)

Les abonnements affichés en réponse sont uniquement ceux auxquels le profil a souscrit actuellement. Si ce dernier n'est pas abonné à un abonnement, il ne sera pas affiché.

Obtenir les segmentations d'un profil

Vous avez la possibilité d'obtenir la liste des segmentations auxquelles un profil appartient via l'opération GET/entity{e}/table{t}/profile{p}/segmentation

Les paramètres à renseigner dans ce cas sont l'entité, la table de profils et l'identifiant du profil ("profileId" ou couple "attributClé=Valeur").

Exemple de requête et de réponse pour cette méthode : (Téléchargez cet exemple)

Les segmentations affichées en réponse sont uniquement celles dont le profil fait partie. Si ce dernier ne fait pas partie d'une segmentation, elle ne sera pas affichée.

Créer ou mettre à jour un seul profil

De nombreuses opérations permettent de créer ou de mettre à jour les profils un par un. Un des avantages de cette manière de procéder est qu'il existe des opérations pré-paramétrées pour mettre à jour certains éléments spécifique d'une table de profils, comme les abonnements ou les segmentations.

Pour une explication détaillée concernant ces opérations, nous vous invitons à lire la page "Créer ou mettre à jour un seul profil".

Créer ou mettre à jour des profils en masse

Les imports de masse vont se faire sur base de fichiers contenant les données. Si certaines lignes de données tombent en erreur lors de la tentative d'import, elles seront détaillées afin de vous permettre de remédier au problème.

Pour découvrir le fonctionnement de cette méthode, nous vous dirigeons vers la page "Créer ou mettre à jour des profils en masse".