Show Menu
SUJETS×

Appel d'une ressource à l'aide d'une clé d'identification composite

Dans certains cas, il est possible que vous deviez définir pour une ressource une clé d'identification constituée de deux champs. Une fois la clé d'identification configurée, vous devez configurer une définition de filtre afin de pouvoir appeler la ressource avec cette clé d'identification à partir de l'interface de Campaign Standard ou des API.
Dans ce cas pratique, la ressource Profil a été étendue avec les champs personnalisés "Identifiant CRM" et "catégorie" . Nous allons créer une clé d'identification pour la ressource Profil qui sera composée de ces deux champs. Nous configurerons ensuite une définition de filtre afin de pouvoir accéder à la ressource Profil à l'aide de la clé d'identification.
Les étapes principales de ce cas pratique sont les suivantes :
  1. Configurer la clé d'identification pour la ressource Profil en fonction des deux champs
  2. Configurer la définition de filtre pour pouvoir appeler la ressource Profil à l'aide de sa clé d'identification
  3. Appeler la ressource Profil depuis l'interface ou les API
Rubriques connexes :

Etape 1 : configurer la clé d'identification

Les concepts globaux lors de la configuration des clés d'identification sont présentés dans cette section .
  1. Avant de configurer la clé d'identification, vérifiez que la ressource a été étendue avec les champs souhaités et qu'elle a été publiée. Voir à ce propos cette section .
  2. Accédez au menu Administration / Développement / Ressources personnalisées , puis ouvrez la ressource Profil .
  3. Dans la section Clés d'identification , cliquez sur le bouton Créer un élément .
  4. Ajoutez les deux champs personnalisés "Identifiant CRM" et "Catégorie", puis cliquez sur Confirmer .
    Si vous souhaitez afficher les deux champs personnalisés dans l'interface du profil, configurez l'onglet Définition des écrans . Voir à ce propos cette section .
  5. Vous pouvez maintenant configurer la définition de filtre pour pouvoir appeler la ressource à l'aide de sa clé d'identification.

Etape 2 : configurer la définition de filtre

Les concepts globaux lors de la configuration des définitions de filtre sont présentés dans cette section .
  1. Dans l'onglet Définition des filtres , cliquez sur Ajouter un élément , puis saisissez le libellé et l'identifiant de la définition de filtre.
  2. Editez les propriétés de la définition de filtre pour configurer ses règles.
  3. Placez dans l'espace de travail le tableau contenant les champs utilisés dans la clé d'identification.
  4. Sélectionnez le premier champ utilisé dans la clé d'identification ("Identifiant CRM"), puis activez l'option Définir des paramètres .
  5. Dans la section Conditions de filtrage , conservez l'opérateur Egal , puis définissez le nom du paramètre et cliquez sur le signe plus pour le créer.
    Une fois que vous avez cliqué sur le bouton plus, le nom du paramètre est généré automatiquement. Notez ces informations, car vous devrez les utiliser pour utiliser le filtre des API.
  6. Répétez les étapes ci-dessus avec tous les champs qui composent la clé d'identification ("catégorie"), puis enregistrez vos modifications.
  7. La définition de filtre est maintenant configurée. Vous pouvez publier la ressource afin que le filtre soit disponible.

Etape 3 : appeler la ressource en fonction de sa clé d'identification

Une fois la clé d'identification et sa définition de filtre configurées, vous pouvez les utiliser pour appeler la ressource à partir de l'interface de Campaign standard ou des API REST.
Pour utiliser la définition de filtre depuis l'interface, employez une activité Requête dans un workflow (voir cette section ). Le filtre devient ensuite disponible dans le volet gauche.
Pour utiliser la définition de filtre depuis les API REST de Campaign Standard, utilisez la syntaxe suivante :
GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>

Pour appeler un filtre client, utilisez le préfixe "par" suivi du nom du filtre défini lors de la configuration de la définition du filtre à l' étape 2 .
Dans notre cas, la syntaxe permettant de récupérer un profil de la catégorie "printemps" avec l'identifiant CRM "123456" est la suivante :
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456

Pour plus d'informations, consultez la documentation des API REST Campaign Standard .