Generera exempelprofiler baserat på ett källschema

Det första steget för att testa det filbaserade målet är att använda /sample-profiles slutpunkt för att generera en exempelprofil baserat på ditt befintliga källschema.

Exempelprofiler kan hjälpa dig att förstå JSON-strukturen för en profil. Dessutom får du ett standardvärde som du kan anpassa med dina egna profildata för ytterligare destinationstestning.

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 /sample-profiles 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.

  • Du har skapat minst ett aktiveringsflöde för destinationen i användargränssnittet i Experience Platform. The /sample-profiles slutpunkten skapar profilerna baserat på det källschema som du definierade i aktiveringsflödet. Se självstudiekurs om aktivering om du vill veta hur du skapar ett aktiveringsflöde.

  • 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.

Generera exempelprofiler för måltestning

Du kan generera exempelprofiler baserat på ditt källschema genom att göra en GET-förfrågan till /sample-profiles slutpunkten med målinstans-ID:t för målet som du vill testa.

API-format

GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}
Frågeparametrar Beskrivning
destinationInstanceId ID:t för målinstansen som du genererar exempelprofiler för. Se krav om du vill ha mer information om hur du får detta ID.
count Valfritt. Antalet exempelprofiler som du vill generera. Parametern kan ha värden mellan 1 - 1000. Om den här egenskapen inte definieras genererar API:t en enda exempelprofil.

Begäran

Följande begäran genererar en exempelprofil baserad på det källschema som definierats i målinstansen med motsvarande destinationInstanceId.

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={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}' \

Svar

Ett lyckat svar returnerar HTTP-status 200 med det angivna antalet exempelprofiler, med målgruppsmedlemskap, identiteter och profilattribut som motsvarar XDM-källschemat.

OBSERVERA

Svaret returnerar endast målgruppsmedlemskap, identiteter och profilattribut som används i målinstansen. Även om källschemat innehåller andra fält ignoreras dessa.

[
   {
      "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"
         }
      }
   }
]

Bild som visar mappningen från användargränssnittet till fälten från API-svaret.

Egenskap Beskrivning
segmentMembership Ett kartobjekt som beskriver personens målgruppsmedlemskap. Mer information om segmentMembership, läsa Information om målgruppsmedlemskap.
lastQualificationTime En tidsstämpel från den senaste gången profilen kvalificerades för segmentet.
status Ett strängfält som anger om målgruppsmedlemskapet har realiserats som en del av den aktuella begäran. Följande värden accepteras:
  • realized: Profilen är en del av segmentet.
  • exited: Profilen avslutar publiken som en del av den aktuella begäran.
identityMap Ett mappningsfält som beskriver de olika identitetsvärdena för en individ, tillsammans med deras associerade namnutrymmen. Mer information om identityMap, se grund för schemakomposition.

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 genererar exempelprofiler baserat på källschemat som du konfigurerade i målet aktiveringsflöde.

Du kan nu anpassa de här profilerna eller använda dem som de returneras av API:t för att testa din filbaserade destinationskonfiguration.

På denna sida