Eindpunt segmenttaken
Een segmentbaan is een asynchroon proces dat tot een publiekssegment op bestelling leidt. Het verwijzingen a segmentdefinitie, evenals om het even welk samenvoegbeleidcontrolerend hoe Real-Time Customer Profile overlappende attributen over uw profielfragmenten samenvoegt. Wanneer een segmentbaan met succes voltooit, kunt u diverse informatie over het segment, zoals om het even welke fouten verzamelen die tijdens verwerking en de uiteindelijke grootte van uw publiek kunnen zijn voorgekomen.
Deze handleiding bevat informatie die u helpt segmenttaken beter te begrijpen en voorbeelden van API-aanroepen voor het uitvoeren van basishandelingen met de API.
Aan de slag
De eindpunten die in deze handleiding worden gebruikt, maken deel uit van de API van Adobe Experience Platform Segmentation Service . Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor belangrijke informatie die u moet kennen om vraag aan API met succes te maken, met inbegrip van vereiste kopballen en hoe te om voorbeeld API vraag te lezen.
Een lijst met segmenttaken ophalen retrieve-list
U kunt een lijst van alle segmentbanen voor uw organisatie terugwinnen door een GET- verzoek aan het /segment/jobs
eindpunt te doen.
API formaat
Het /segment/jobs
eindpunt steunt verscheidene vraagparameters helpen uw resultaten filtreren. Hoewel deze parameters optioneel zijn, wordt het gebruik ervan sterk aanbevolen om kostbare overhead te helpen verminderen. Het maken van een vraag aan dit eindpunt zonder parameters zal alle uitvoerbanen beschikbaar voor uw organisatie terugwinnen. De veelvoudige parameters kunnen worden omvat, die door ampersands (&
) worden gescheiden.
GET /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
de parameters van de Vraag
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
Parameter | Beschrijving | Voorbeeld |
start |
Geeft de beginverschuiving aan voor de geretourneerde segmenttaken. | start=1 |
limit |
Geeft het aantal segmenttaken op dat per pagina wordt geretourneerd. | limit=20 |
status |
Hiermee filtert u de resultaten op basis van de status. De ondersteunde waarden zijn NEW, QUEUED, PROCESSING, SUCCEEDED, FAILED, CANCELING, CANCELING | status=NEW |
sort |
Hiermee worden de geretourneerde segmenttaken gesorteerd. Wordt geschreven in de indeling `[attributeName]:[desc | asc]` . |
property |
Hiermee filtert u segmenttaken en haalt u exacte overeenkomsten op voor het opgegeven filter. Deze kan in een van de volgende indelingen worden geschreven:
|
property=segments~segmentId==workInUS |
Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met een lijst van segmentbanen voor de gespecificeerde organisatie als JSON terug. Een volledige lijst van alle segmentdefinities zal binnen het children.segments
attribuut worden getoond.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een door het systeem gegenereerde alleen-lezen-id voor de segmenttaak. |
status |
De huidige status voor de segmenttaak. Mogelijke waarden voor de status zijn 'NEW', 'PROCESSING', 'CANCELING', 'CANCELED', 'FAILED' en 'SUCCED'. |
segments |
Een voorwerp dat informatie over de segmentdefinities bevat die binnen de segmentbaan zijn teruggekeerd. |
segments.segment.id |
De id van de segmentdefinitie. |
segments.segment.expression |
Een object dat informatie bevat over de expressie van de segmentdefinitie, geschreven in PQL. |
metrics |
Een object dat diagnostische informatie bevat over de segmenttaak. |
metrics.totalTime |
Een object dat informatie bevat over de tijd waarop de segmentatietaak is gestart en beëindigd en over de totale tijd die is gevergd. |
metrics.profileSegmentationTime |
Een object dat informatie bevat over de tijd waarop de segmentatieevaluatie is gestart en beëindigd, en over de totale tijd die is verstreken. |
metrics.segmentProfileCounter |
Het aantal profielen dat per segment wordt gekwalificeerd. |
metrics.segmentedProfileByNamespaceCounter |
Het aantal profielen dat voor elke identiteitsnaamruimte op een basis van de segmentdefinitie wordt gekwalificeerd. |
metrics.segmentProfileByStatusCounter |
Het aantal profielen voor elke status. De volgende drie statussen worden ondersteund:
|
metrics.totalProfilesByMergePolicy |
Het totale aantal samengevoegde profielen op een per de beleidsbasis van de fusie. |
Een nieuwe segmenttaak maken create
U kunt een nieuwe segmentbaan tot stand brengen door een POST- verzoek aan het /segment/jobs
eindpunt en met inbegrip van IDs van de segmentdefinitie in het verzoeklichaam te doen.
API formaat
POST /segment/jobs
Verzoek
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschap | Beschrijving |
segmentId |
De id van de segmentdefinitie die u wilt evalueren. Deze segmentdefinities kunnen tot verschillende samenvoegbeleidsregels behoren. Meer informatie over segmentdefinities kan in de gids van het eindpunt van de segmentdefinitieworden gevonden. |
Reactie
Een succesvolle reactie keert status 200 van HTTP met informatie over uw pas gecreëerde segmentbaan terug.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een door het systeem gegenereerde alleen-lezen-id voor de nieuwe segmenttaak. |
status |
De huidige status voor de segmenttaak. Aangezien de segmentbaan nieuw wordt gecreeerd, zal de status altijd "NIEUW"zijn. |
segments |
Een object dat informatie bevat over de segmentdefinities waarop deze segmenttaak wordt uitgevoerd. |
segments.segment.id |
De id van de segmentdefinitie die u hebt opgegeven. |
segments.segment.expression |
Een object dat informatie bevat over de expressie van de segmentdefinitie, geschreven in PQL. |
Een specifieke segmenttaak ophalen get
U kunt gedetailleerde informatie over een specifieke segmentbaan terugwinnen door een GET- verzoek aan het /segment/jobs
eindpunt te doen en identiteitskaart van de segmentbaan te verstrekken u in de verzoekweg wenst terug te winnen.
API formaat
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
-waarde van de segmenttaak die u wilt ophalen.Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 200 van HTTP met gedetailleerde informatie over de gespecificeerde segmentbaan terug. Een volledige lijst van alle segmentdefinities zal binnen het children.segments
attribuut worden getoond.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een door het systeem gegenereerde alleen-lezen-id voor de segmenttaak. |
status |
De huidige status voor de segmenttaak. Mogelijke waarden voor de status zijn 'NEW', 'PROCESSING', 'CANCELING', 'CANCELED', 'FAILED' en 'SUCCED'. |
segments |
Een voorwerp dat informatie over de segmentdefinities bevat die binnen de segmentbaan zijn teruggekeerd. |
segments.segment.id |
De id van de segmentdefinitie. |
segments.segment.expression |
Een object dat informatie bevat over de expressie van de segmentdefinitie, geschreven in PQL. |
metrics |
Een object dat diagnostische informatie bevat over de segmenttaak. |
[!ENDTABS]
Ophaalsegmenttaken bulksgewijs opvragen bulk-get
U kunt gedetailleerde informatie over veelvoudige segmentbanen terugwinnen door een POST- verzoek aan het /segment/jobs/bulk-get
eindpunt te doen en de id
waarden van de segmentbanen in het verzoeklichaam te verstrekken.
API formaat
POST /segment/jobs/bulk-get
Verzoek
code language-shell |
---|
|
Reactie
Een succesvolle reactie keert status 207 van HTTP met de gevraagde segmentbanen terug.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een door het systeem gegenereerde alleen-lezen-id voor de segmenttaak. |
status |
De huidige status voor de segmenttaak. Mogelijke waarden voor de status zijn 'NEW', 'PROCESSING', 'CANCELING', 'CANCELED', 'FAILED' en 'SUCCED'. |
segments |
Een voorwerp dat informatie over de segmentdefinities bevat die binnen de segmentbaan zijn teruggekeerd. |
segments.segment.id |
De id van de segmentdefinitie. |
segments.segment.expression |
Een object dat informatie bevat over de expressie van de segmentdefinitie, geschreven in PQL. |
Een specifieke segmenttaak annuleren of verwijderen delete
U kunt een specifieke segmentbaan schrappen door een DELETE- verzoek aan het /segment/jobs
eindpunt te doen en identiteitskaart van de segmentbaan te verstrekken u wenst om in de verzoekweg te schrappen.
API formaat
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
-waarde van de segmenttaak die u wilt verwijderen.Verzoek
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP status 204 met een lege response body.
Volgende stappen
Na het lezen van deze gids hebt u nu een beter inzicht in hoe de segmentbanen werken.