Utvärdera och få tillgång till segmentdefinitionsresultat

Det här dokumentet innehåller en självstudiekurs för att utvärdera segmentdefinitioner och få tillgång till dessa resultat med Segmentation API.

Komma igång

Den här självstudiekursen kräver en fungerande förståelse av de olika Adobe Experience Platform-tjänster som används för att skapa målgrupper. Innan du börjar med den här självstudiekursen bör du läsa dokumentationen för följande tjänster:

Obligatoriska rubriker

Den här självstudien kräver också att du har slutfört autentiseringssjälvstudiekursen för att kunna anropa Platform API:er. När du slutför självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop, vilket visas nedan:

Alla resurser i Experience Platform är isolerade till specifika virtuella sandlådor. Begäranden till Platform API:er kräver ett huvud som anger namnet på sandlådan som åtgärden ska utföras i:

Alla förfrågningar från POST, PUT och PATCH kräver ytterligare en rubrik:

Utvärdera en segmentdefinition evaluate-a-segment

När du har utvecklat, testat och sparat din segmentdefinition kan du sedan utvärdera segmentdefinitionen genom en schemalagd utvärdering eller on-demand-utvärdering.

Schemalagd utvärdering (kallas även schemalagd segmentering) gör att du kan skapa ett återkommande schema för att köra ett exportjobb vid en viss tidpunkt, medan on demand-utvärdering innebär att du skapar ett segmentjobb för att skapa målgruppen direkt. Stegen för varje steg beskrivs nedan.

Om du ännu inte har slutfört skapa en segmentdefinition med hjälp av självstudiekursen Segmentering-API eller skapat en segmentdefinition med Segmentbyggaren gör du det innan du fortsätter med den här självstudiekursen.

Schemalagd utvärdering scheduled-evaluation

Med schemalagd utvärdering kan din organisation skapa ett återkommande schema för att automatiskt köra exportjobb.

Skapa ett schema

Genom att göra en schemaförfrågan till slutpunkten /config/schedules kan du skapa ett schema och inkludera den POST då schemat ska utlösas.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för scheman

Aktivera ett schema

Som standard är ett schema inaktivt när det skapas, såvida inte egenskapen state är inställd på active i texten för skapandebegäran (POST). Du kan aktivera ett schema (ange state till active) genom att göra en PATCH-begäran till /config/schedules-slutpunkten och inkludera ID:t för schemat i sökvägen.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för scheman

Uppdatera schematiden

Tidsplaneringen kan uppdateras genom att en PATCH-begäran görs till slutpunkten /config/schedules och med ID:t för schemat i sökvägen.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för scheman

On-demand-utvärdering

Med On-demand-utvärdering kan ni skapa ett segmentjobb för att generera en målgrupp när ni behöver det. Till skillnad från schemalagd utvärdering kommer detta endast att ske när det begärs och inte är återkommande.

Skapa ett segmentjobb

Ett segmentjobb är en asynkron process som skapar ett målgruppssegment på begäran. Den refererar till en segmentdefinition samt eventuella sammanfogningsprinciper som styr hur Real-Time Customer Profile sammanfogar överlappande attribut i dina profilfragment. När ett segmentjobb har slutförts kan du samla in olika information om segmentdefinitionen, t.ex. eventuella fel som kan ha inträffat under bearbetningen och målgruppens slutliga storlek. Ett segmentjobb måste köras varje gång du vill uppdatera målgruppen som är kvalificerad för segmentdefinitionen.

Du kan skapa ett nytt segmentjobb genom att göra en POST-förfrågan till /segment/jobs-slutpunkten i Real-Time Customer Profile API:t.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för segmentjobb

Sök efter jobbstatus för segment

Du kan använda id för ett specifikt segmentjobb för att utföra en sökbegäran (GET) för att visa jobbets aktuella status.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för segmentjobb

Tolka segmentjobbresultat

När segmentjobben har körts uppdateras kartan segmentMembership för varje profil som ingår i segmentdefinitionen. segmentMembership lagrar även alla förutvärderade målgrupper som är inkapslade i Platform, vilket möjliggör integrering med andra lösningar som Adobe Audience Manager.

I följande exempel visas hur attributet segmentMembership ser ut för varje enskild profilpost:

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}

Åtkomst till segmentjobbresultat

Resultatet av ett segmentjobb kan nås på ett av två sätt: du kan komma åt enskilda profiler eller exportera en hel publik till en datauppsättning.

I följande avsnitt beskrivs dessa alternativ mer ingående.

Söka efter en profil

Om du vet vilken profil du vill använda kan du göra det med API:t Real-Time Customer Profile. De fullständiga stegen för att komma åt enskilda profiler finns i självstudiekursen Åtkomst till kundprofildata i realtid med profils-API.

Exportera ett segment export

När ett segmenteringsjobb har slutförts (värdet för attributet status är "SUCCEEDED") kan du exportera målgruppen till en datauppsättning där den kan nås och hanteras.

Följande steg krävs för att exportera målgruppen:

Skapa en måldatauppsättning create-dataset

När du exporterar en målgrupp måste du först skapa en måldatauppsättning. Det är viktigt att datauppsättningen är korrekt konfigurerad för att exporten ska lyckas.

Ett av de viktigaste övervägandena är schemat som datauppsättningen baseras på (schemaRef.id i API-exempelbegäran nedan). Om du vill exportera en segmentdefinition måste datauppsättningen baseras på XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union). Ett unionsschema är ett systemgenererat, skrivskyddat schema som samlar in fält i scheman som delar samma klass, i det här fallet klassen XDM Individual Profile. Mer information om unionsvyscheman finns i avsnittet Kundprofil i realtid i utvecklarhandboken för schemaregister.

Det finns två sätt att skapa den nödvändiga datauppsättningen:

Om du redan har en kompatibel datauppsättning och känner till dess ID kan du fortsätta direkt till steget för att generera målgruppsprofiler.

API-format

POST /dataSets

Begäran

Följande begäran skapar en ny datauppsättning med konfigurationsparametrar i nyttolasten.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    }
}'

Svar

Ett lyckat svar returnerar en array som innehåller det skrivskyddade, systemgenererade unika ID:t för den nya datauppsättningen. Ett korrekt konfigurerat datauppsättnings-ID krävs för att målgruppsmedlemmar ska kunna exporteras.

[
  "@/datasets/5b020a27e7040801dedba61b"
]

Generera profiler för målgruppsmedlemmar generate-profiles

När du har en unionskonstanterad datauppsättning kan du skapa ett exportjobb som behåller målgruppsmedlemmarna i datauppsättningen genom att göra en POST till /export/jobs-slutpunkten i Real-Time Customer Profile API:t och ange datauppsättnings-ID:t och segmentdefinitionsinformationen för de segmentdefinitioner som du vill exportera.

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för exportjobb

Övervaka exportförlopp

Som en exportjobbsprocess kan du övervaka dess status genom att göra en GET-förfrågan till slutpunkten /export/jobs och inkludera id för exportjobbet i sökvägen. Exportjobbet slutförs när fältet status returnerar värdet "SUCCEEDED".

Mer detaljerad information om hur du använder den här slutpunkten finns i slutpunktshandboken för exportjobb

Nästa steg

När exporten har slutförts är dina data tillgängliga i Data Lake i Experience Platform. Du kan sedan använda Data Access API för att komma åt data med hjälp av batchId som är associerad med exporten. Beroende på segmentdefinitionens storlek kan data vara i segment och gruppen kan bestå av flera filer.

Följ Dataåtkomstsjälvstudiekursen om du vill ha stegvisa anvisningar om hur du använder Data Access-API:t för att få åtkomst till och hämta gruppfiler.

Du kan också komma åt exporterade segmentdefinitionsdata med Adobe Experience Platform Query Service. Med API:t UI eller RESTful kan du med Query Service skriva, validera och köra frågor på data i Data Lake.

Mer information om hur du frågar efter målgruppsdata finns i dokumentationen om Query Service.