Skapa en segmentdefinition 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 segmentdefinitioner med användargränssnittet finns i guiden för segmentbyggaren.

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 segmentdefinitioner. Innan du börjar med den här självstudiekursen bör du läsa dokumentationen för följande tjänster:

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna anropa API:erna för Platform.

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 de konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i felsökningsguiden för Experience Platform.

Samla in värden för obligatoriska rubriker

För att kunna anropa Platform API:er måste du först slutföra autentiseringssjälvstudiekursen. 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. Alla begäranden till Platform API:er kräver en rubrik som anger namnet på sandlådan som åtgärden ska utföras i:

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

Utveckla en segmentdefinition

Det första steget i segmenteringen är att definiera en 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 förutsäger regler för segmentdefinitionen baserat på villkor som relaterar till alla post- eller tidsseriedata som du skickar till Real-Time Customer Profile. Mer information om hur du skriver PQL-frågor finns i PQL-handboken.

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

En detaljerad förklaring om hur du definierar en segmentdefinition finns i utvecklarhandboken för segmentdefinitioner.

Beräkna och förhandsgranska en målgrupp estimate-and-preview-an-audience

När du utvecklar din segmentdefinition kan du använda verktygen för uppskattning och förhandsgranskning i Real-Time Customer Profile för att visa information på sammanfattningsnivå för att säkerställa att du 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 era era PQL-predikat tills de ger önskat resultat, där de sedan kan användas i en uppdaterad segmentdefinition.

Det finns två nödvändiga steg för att förhandsgranska eller få en uppskattning av din segmentdefinition:

Hur uppskattningar genereras

När data som är aktiverade för kundprofilen i realtid hämtas till plattformen lagras de i profildatalagret. När inmatningen av poster i profilarkivet ökar eller minskar det totala antalet profiler med mer än 5 %, utlöses ett samplingsjobb för att uppdatera antalet. Om profilantalet inte ändras med mer än 5 % körs provtagningsjobbet automatiskt varje vecka.

Hur provet utlöses beror på vilken typ av intag som används:

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

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 slutpunkten /preview.

Detaljerade instruktioner om hur du skapar ett förhandsgranskningsjobb finns i guiden för förhandsvisningar 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 allt eftersom den fortskrider.

Med API:t Segmentation Service kan du slå upp ett förhandsgranskningsjobbs aktuella tillstånd med dess ID. Om läget är "RESULT_READY" kan du visa resultatet. Läs avsnittet Hämta ett förhandsgranskningsjobbavsnitt i guiden för förhandsgranskningar och uppskattningar om du vill söka efter ett förhandsgranskningsjobbs aktuella tillstånd. Läs avsnittet Hämta ett uppskattningsjobb i guiden för förhandsgranskningar och uppskattningar av slutpunkter om du vill söka efter ett uppskattningsjobbs aktuella tillstånd.

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 hjälp av Segmentation Service-API:t. I självstudiekursen Utvärderar och får åtkomst till segmentresultat finns detaljerade anvisningar om hur du gör detta.