Dokumentation Experience Platform Användarhandbok om destinationer

Testa ditt filbaserade mål med exempelprofiler

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Destinationer

Skapat för:

Administratör
Användare

Översikt overview

Den här sidan förklarar hur du använder API-slutpunkten /testing/destinationInstance för att testa om ditt filbaserade mål är korrekt konfigurerat och för att verifiera dataflödenas integritet till det konfigurerade målet.

Du kan göra förfrågningar till testslutpunkten med eller utan att lägga till exempelprofiler i anropet. Om du inte skickar några profiler på begäran genererar API:t en exempelprofil automatiskt och lägger till den i begäran.

De automatiskt genererade exempelprofilerna innehåller generiska data. Om du vill testa ditt mål med anpassade, mer intuitiva profildata använder du API:t för generering av exempelprofiler för att generera en exempelprofil, anpassar sedan dess svar och inkluderar det i begäran till /testing/destinationInstance-slutpunkten.

Komma igång getting-started

Innan du fortsätter bör du läsa igenom kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive hur du får nödvändig behörighet för målredigering och nödvändiga rubriker.

Förhandskrav prerequisites

Innan du kan använda slutpunkten /testing/destinationInstance måste du kontrollera att följande villkor uppfylls:

Du har ett befintligt filbaserat mål som skapats via Destinationen SDK och du kan se det i din målkatalog.
Du har skapat minst ett aktiveringsflöde för destinationen i användargränssnittet i Experience Platform.
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.
Valfritt: Om du vill testa målkonfigurationen med en exempelprofil som lagts till i API-anropet använder du slutpunkten /sample-profiles för att generera en exempelprofil baserat på ditt befintliga källschema. Om du inte anger någon exempelprofil genererar API:t en och returnerar den i svaret.

Testa målkonfigurationen utan att lägga till profiler till samtalet test-without-adding-profiles

API-format

POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Begäran

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
 -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}' \

Sökvägsparametrar

Beskrivning

{DESTINATION_INSTANCE_ID}

ID:t för målinstansen som du genererar exempelprofiler för. I avsnittet Krav finns mer information om hur du får detta ID.

Svar

Ett lyckat svar returnerar HTTP-status 200 tillsammans med svarsnyttolasten.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"crmid-P1A7l"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string",
               "lastName":"string"
            }
         }
      }
   ]
}

Egenskap

Beskrivning

activations

Returnerar målgrupps-ID och flödeskörnings-ID för varje aktiverad målgrupp. Antalet aktiveringsposter (och associerade genererade filer) är lika med antalet målgrupper som mappas på målinstansen.

Exempel: Om du har mappat två målgrupper till målinstansen innehåller arrayen activations två poster. Varje aktiverad målgrupp motsvarar en exporterad fil.

results

Returnerar målinstans-ID:t och det flödes-ID som du kan använda för att anropa results-API:t, för att ytterligare testa integreringen.

inputProfiles

Returnerar de exempelprofiler som har genererats automatiskt av API:t.

Testa målkonfigurationen med profiler som lagts till i samtalet test-with-added-profiles

Om du vill testa målet med anpassade, mer intuitiva profildata kan du anpassa svaret från slutpunkten /sample-profiles med valfria värden och inkludera den anpassade profilen i begäran till slutpunkten /testing/destinationInstance.

API-format

POST  /testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Begäran

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
 -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 '
 {
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}'

Parameter

Beskrivning

{DESTINATION_INSTANCE_ID}

Målinstans-ID:t för målet som du testar. ID:t för målinstansen som du genererar exempelprofiler för. I avsnittet Krav finns mer information om hur du får detta ID.

profiles

Array som kan innehålla en eller flera profiler. Använd API-slutpunkten för exempelprofiler för att generera profiler som ska användas i detta API-anrop.

Svar

Ett lyckat svar returnerar HTTP-status 200 tillsammans med svarsnyttolasten.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}

Egenskap

Beskrivning

activations

results

Returnerar målinstans-ID:t och det flödes-ID som du kan använda för att anropa results-API:t, för att ytterligare testa integreringen.

inputProfiles

Returnerar de anpassade exempelprofilerna som du skickade i API-begäran.

API-felhantering api-error-handling

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

Nästa steg

När du har läst det här dokumentet vet du nu hur du testar din filbaserade målkonfiguration.

Om du har fått ett giltigt API-svar fungerar målet korrekt. Om du vill se mer detaljerad information om aktiveringsflödet kan du använda egenskapen results från svaret för att visa detaljerade aktiveringsresultat.

Om du skapar ett offentligt mål kan du nu skicka målkonfigurationen till Adobe för granskning.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6