Validera mallsidiga kundfält

Senaste uppdatering: 2023-05-16
  • Skapat för:
  • Developer
    User
    Admin
    Leader

Översikt

The /authoring/testing/template/render kan du visualisera hur mallarna kunddatafält som definierats i målkonfigurationen skulle se ut så här.

Slutpunkten genererar slumpmässiga värden för kunddatafälten och returnerar dem i svaret. Detta hjälper dig att validera den semantiska strukturen i kunddatafält, till exempel bucketnamn eller mappsökvägar.

Komma igång

Läs igenom komma igång-guide för viktig information som du behöver känna till för att kunna anropa API:t, inklusive hur du får nödvändig behörighet för målredigering och obligatoriska huvuden.

Förutsättningar

Innan du kan använda /template/render måste du se till att följande villkor uppfylls:

  • Du har ett befintligt filbaserat mål som skapas via Destinationen SDK och du kan se det i målkatalog.

  • För att kunna utföra API-begäran behöver du det målinstans-ID som motsvarar den målinstans som du ska testa. Hämta det målinstans-ID som du bör använda i API-anropet från webbadressen när du bläddrar i en anslutning till målet i plattformsgränssnittet.

    Användargränssnittsbild som visar hur du hämtar målinstans-ID från URL:en.

Återge mallsidiga kundfält

API-format

POST /authoring/testing/template/render/destination

Om du vill visa beteendet för den här API-slutpunkten ska du överväga ett filbaserat mål med följande konfiguration för kunddatafält:

"fileBasedS3Destination":{
   "bucket":{
      "templatingStrategy":"PEBBLE_V1",
      "value":"{{customerData.bucket}}"
   },
   "path":{
      "templatingStrategy":"PEBBLE_V1",
      "value":"{{customerData.path}}"
   }
}

Begäran

Begäran nedan anropar /authoring/testing/template/render slutpunkt, som returnerar ett svar med slumpmässigt genererade värden för de två kunddatafälten som nämns ovan.

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/template/render/destination' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
    "destinationId": "{DESTINATION_CONFIGURATION_ID}",
    "templates": {
        "bucket": "{{customerData.bucket}}",
        "path": "{{customerData.bucket}}/{{customerData.path}}"
    }
}'
Parametrar Beskrivning
destinationId ID för målkonfiguration som du testar.
templates De mallsidiga fältnamnen som definieras i målserverkonfiguration.

Svar

Ett godkänt svar returnerar ett HTTP 200 OK och brödtexten innehåller slumpmässigt genererade värden för de mallsidiga fälten.

Detta svar kan hjälpa er att validera den korrekta strukturen i kunddatafälten, till exempel bucketnamn eller mappsökvägar.

{
    "results": {
        "bucket": "hfWpE-bucket",
        "path": "hfWpE-bucket/ceC"
    }
}

API-felhantering

Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och fel i begäranhuvudet i felsökningsguiden för plattformen.

Nästa steg

När du har läst det här dokumentet vet du nu hur du validerar konfigurationen av kunddatafältet som definieras i målserver.

På denna sida