Skapa ett segment med hjälp av segmenteringstjänstens API

Det här dokumentet innehåller en självstudiekurs för att utveckla, testa, förhandsgranska och spara en segmentdefinition med Adobe Experience Platform Segmentation Service API.

Mer information om hur du skapar segment med användargränssnittet finns i Segment Builder Guide.

Komma igång

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

Följande avsnitt innehåller ytterligare information som du behöver känna till för att kunna ringa samtal till Platform API:er.

Läser exempel-API-anrop

I den här självstudiekursen finns exempel-API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om konventionerna som används i dokumentationen för exempel-API-anrop finns i avsnittet om läsa exempel-API-anrop i Experience Platform felsökningsguide.

Samla in värden för obligatoriska rubriker

För att ringa Platform API:er måste du först slutföra självstudiekurs om autentisering. När du är klar med självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop enligt nedan:

  • Behörighet: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Alla resurser i Experience Platform isoleras till specifika virtuella sandlådor. Alla förfrågningar till Platform API:er kräver en rubrik som anger namnet på sandlådan som åtgärden ska utföras i:

  • x-sandbox-name: {SANDBOX_NAME}
OBSERVERA

Mer information om sandlådor i Platform, se översiktsdokumentation för sandlåda.

Alla begäranden som innehåller en nyttolast (POST, PUT, PATCH) kräver ytterligare en rubrik:

  • Innehållstyp: application/json

Utveckla en segmentdefinition

Det första steget i segmenteringen är att definiera ett segment, som representeras i en konstruktion som kallas segmentdefinition. En segmentdefinition är ett objekt som kapslar in en fråga skriven i Profile Query Language (PQL). Det här objektet kallas även för ett PQL-predikat. PQL-predikat definierar reglerna för segmentet baserat på villkor som relaterar till data från post- eller tidsserier som du skickar till Real-time Customer Profile. Se PQL-guide om du vill ha mer information om hur du skriver PQL-frågor.

Du kan skapa en ny segmentdefinition genom att göra en POST-förfrågan till /segment/definitions slutpunkt i Segmentation API. Följande exempel visar hur du formaterar en definitionsbegäran, inklusive vilken information som krävs för att ett segment ska kunna definieras korrekt.

Mer information om hur du definierar ett segment finns i Utvecklarhandbok för segmentdefinition.

Beräkna och förhandsgranska en målgrupp

När du utvecklar segmentdefinitionen kan du använda verktygen för uppskattning och förhandsgranskning i Real-time Customer Profile för att se information på sammanfattningsnivå för att säkerställa att ni isolerar den förväntade målgruppen. Uppskattningar ger statistisk information om en segmentdefinition, t.ex. förväntad målgruppsstorlek och konfidensintervall. Förhandsvisningar innehåller sidnumrerade listor med kvalificeringsprofiler för en segmentdefinition, så att du kan jämföra resultaten med vad du förväntar dig.

Genom att uppskatta och förhandsgranska målgruppen kan ni testa och optimera PQL-predikaten tills de ger önskat resultat, där de sedan kan användas i en uppdaterad segmentdefinition.

Du måste utföra två steg för att förhandsgranska eller få en uppskattning av ditt segment:

  1. Skapa ett förhandsgranskningsjobb
  2. Visa uppskattning eller förhandsgranskning med ID:t för förhandsgranskningsjobbet

Hur uppskattningar genereras

Dataprover används för att utvärdera segment och uppskatta antalet kvalificerade profiler. Nya data läses in i minnet varje morgon (mellan 12AM-2AM PT, som är 7-9AM UTC), och alla segmenteringsfrågor beräknas med hjälp av den dagens exempeldata. Alla nya fält som läggs till eller ytterligare uppgifter som samlas in kommer därför att återspeglas i beräkningarna följande dag.

Samplingsstorleken beror på det totala antalet enheter i din profilbutik. De här exempelstorlekarna visas i följande tabell:

Enheter i profilarkivet Samplingsstorlek
Mindre än 1 miljon Fullständig datauppsättning
1 till 20 miljoner 1 miljon
Över 20 miljoner 5 % av det totala

Uppskattningar körs i allmänhet över 10-15 sekunder, med början med en grov uppskattning och förfining när fler poster läses.

Skapa ett förhandsgranskningsjobb

Du kan skapa ett nytt förhandsgranskningsjobb genom att göra en POST-förfrågan till /preview slutpunkt.

Detaljerade anvisningar om hur du skapar ett förhandsgranskningsjobb finns i guide för förhandsgranskningar och uppskattningar av slutpunkter.

Visa en uppskattning eller förhandsgranskning

Uppskattnings- och förhandsgranskningsprocesserna körs asynkront eftersom olika frågor kan ta olika lång tid att slutföra. När en fråga har initierats kan du använda API-anrop för att hämta (GET) det aktuella läget för uppskattningen eller förhandsgranskningen medan den fortlöper.

Använda Segmentation Service API, du kan söka efter ett förhandsgranskningsjobbs aktuella tillstånd med hjälp av dess ID. Om läget är "RESULT_READY" kan du visa resultatet. Om du vill söka efter ett förhandsgranskningsjobbs aktuella tillstånd kan du läsa avsnittet om hämta ett förhandsgranskningsjobbavsnitt i förhandsgransknings- och uppskattningsguiden för slutpunkter. Om du vill söka efter ett uppskattningsjobbs aktuella tillstånd kan du läsa avsnittet om hämta ett uppskattningsjobb i förhandsgransknings- och uppskattningsguiden för slutpunkter.

Nästa steg

När du har utvecklat, testat och sparat segmentdefinitionen kan du skapa ett segmentjobb för att skapa en målgrupp med Segmentation Service API. Se självstudiekursen om utvärdera och komma åt segmentresultat för detaljerade steg om hur du uppnår detta.

På denna sida