Een bron oproepen met een samengestelde identificatiesleutel calling-a-resource-using-a-composite-identification-key
In sommige gevallen moet u voor een resource mogelijk een identificatiesleutel definiëren die uit twee velden bestaat. Zodra de identificatiesleutel wordt gevormd, moet u een filterdefinitie vormen om het middel met deze identificatiesleutel, of van de interface van het Campaign Standard of APIs te kunnen roepen.
In dit geval wordt de Profiel resource is uitgebreid met aangepaste "CRM-ID" en "categorie" velden. We maken een identificatiesleutel voor de profielbron, die uit deze twee velden zal bestaan. Vervolgens configureren we een filterdefinitie, zodat we toegang hebben tot de profielbron met behulp van de identificatietoets.
De belangrijkste stappen voor dit gebruiksgeval zijn:
- Vorm de identificatiesleutel voor het middel van het Profiel, dat op de twee gebieden wordt gebaseerd.
- Vorm de filterdefinitie, om het middel van het Profiel te kunnen roepen gebruikend zijn identificatiecode.
- Roep het middel van het Profiel van de interface of van APis aan.
Verwante onderwerpen:
Stap 1: De identificatietoets configureren step-1-configure-the-identification-key
-
Voordat u de identificatiesleutel configureert, moet u controleren of de bron is uitgebreid met de gewenste velden en of deze is gepubliceerd. Raadpleeg deze sectie voor meer informatie.
-
Ga naar de Administration / Development / Custom resources en open vervolgens het menu Profile resource.
-
In de Identification keys klikt u op de Create element knop.
-
Voeg de twee aangepaste velden CRM-id en Categorie toe en klik vervolgens op Confirm.
note note NOTE Als u de twee aangepaste velden in de interface van het profiel wilt weergeven, configureert u de Screen definition tab. Raadpleeg deze sectie voor meer informatie. -
U kunt de filterdefinitie nu configureren om de bron aan te roepen met behulp van de id-sleutel.
Stap 2: Vorm de filterdefinitie step-2-configure-the-filter-definition
-
In de Filter definition tabblad, klikt u op Add an element Voer vervolgens het label en de id van de filterdefinitie in.
-
Bewerk de eigenschappen van de filterdefinitie om de regels ervan te configureren.
-
Sleep de tabel met de velden in de identificatietoets naar de werkruimte.
-
Selecteer het eerste veld dat wordt gebruikt in de identificatiecode ("CRM-id") en activeer vervolgens het veld Switch to parameters -optie.
-
In de Filter conditions de Equal , definieert u vervolgens de naam van de parameter en klikt u op het plusteken om deze te maken.
note note NOTE Nadat u op de knop + wordt de naam van de parameter automatisch gegenereerd. Let op deze informatie omdat u deze nodig hebt om het filter van de API's te gebruiken. -
Herhaal bovenstaande stappen met alle velden waaruit de identificatiesleutel bestaat ("categorie") en sla uw wijzigingen op.
-
De filterdefinitie is nu geconfigureerd. U kunt de bron publiceren zodat het filter beschikbaar is.
Stap 3: Roep de bron op basis van de identificatiesleutel step-3-call-the-resource-based-on-its-identification-key
Zodra de identificatiesleutel en zijn filterdefinitie worden gevormd, kunt u hen gebruiken om het middel, of van de standaardinterface van de Campagne of REST APIs te roepen.
Als u de filterdefinitie van de interface wilt gebruiken, gebruikt u een Query activiteit in een werkstroom (zie deze sectie). Het filter is vervolgens beschikbaar in het linkerdeelvenster.
Gebruik de onderstaande syntaxis om de filterdefinitie van Campaign Standard REST API's te gebruiken:
GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>
In ons geval zou de syntaxis om een profiel op te halen uit de categorie "spring" met de CRM-id "123456" als volgt zijn:
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456
Raadpleeg voor meer informatie Documentatie voor REST API's van Campaign Standard.