API-eindpunt van berekende kenmerken
Berekende kenmerken zijn functies die worden gebruikt om gegevens op gebeurtenisniveau samen te voegen tot kenmerken op profielniveau. Deze functies worden automatisch berekend zodat zij over segmentatie, activering, en verpersoonlijking kunnen worden gebruikt. Deze handleiding bevat voorbeeld-API-aanroepen voor het uitvoeren van standaard-CRUD-bewerkingen met behulp van het /attributes
-eindpunt.
Meer over gegevens verwerkte attributen leren, gelieve te beginnen door gegevens verwerkt attributenoverzichtte lezen.
Aan de slag
Het API eindpunt dat in deze gids wordt gebruikt maakt deel uit van Real-Time API van het Profiel van de Klant.
Alvorens verder te gaan, te herzien gelieve Profiel API die begonnen gidsvoor verbindingen aan geadviseerde documentatie wordt begonnen, een gids aan het lezen van de steekproefAPI vraag die in dit document verschijnen, en belangrijke informatie betreffende vereiste kopballen die nodig zijn om met succes vraag aan om het even welk Experience Platform API te maken.
Raadpleeg ook de documentatie bij de volgende service:
- Experience Data Model (XDM) System: Het gestandaardiseerde framework waarmee Experience Platform gegevens voor de klantervaring indeelt.
- {de Registratie van 0} Schema die begonnen gids 🔗 wordt: De informatie over uw
{TENANT_ID}
, die in reacties door deze gids verschijnt, wordt verstrekt.
- {de Registratie van 0} Schema die begonnen gids 🔗 wordt: De informatie over uw
Een lijst met berekende kenmerken ophalen list
U kunt een lijst van alle gegevens verwerkte attributen voor uw organisatie terugwinnen door een verzoek van de GET aan het /attributes
eindpunt te doen.
API formaat
Het /attributes
eindpunt steunt verscheidene vraagparameters helpen uw resultaten filtreren. Hoewel deze parameters optioneel zijn, wordt het gebruik ervan sterk aanbevolen om kostbare overhead te verminderen wanneer resources worden vermeld. Als u een vraag aan dit eindpunt zonder parameters maakt, zullen alle gegevens verwerkte attributen beschikbaar voor uw organisatie worden teruggewonnen. De veelvoudige parameters kunnen worden omvat, die door ampersands (&
) worden gescheiden.
GET /attributes
GET /attributes?{QUERY_PARAMETERS}
De volgende queryparameters kunnen worden gebruikt bij het ophalen van een lijst met berekende kenmerken:
limit
limit=20
offset
offset=5
sortBy
name
, status
, updateEpoch
en createEpoch
. U kunt ook kiezen of u in oplopende of aflopende volgorde wilt sorteren door geen -
vóór de sorteeroptie op te nemen of op te nemen. Standaard worden de items door updateEpoch
in aflopende volgorde gesorteerd.sortBy=name
property
Een parameter waarmee u op verschillende berekende kenmerkvelden kunt filteren. Tot de ondersteunde eigenschappen behoren name
, createEpoch
, mergeFunction.value
, updateEpoch
en status
. De ondersteunde bewerkingen zijn afhankelijk van de vermelde eigenschap.
name
:EQUAL
(=),NOT_EQUAL
(!=),CONTAINS
(=contains()),NOT_CONTAINS
(=!contains())createEpoch
:GREATER_THAN_OR_EQUALS
(<=),LESS_THAN_OR_EQUALS
(>=)mergeFunction.value
:EQUAL
(=),NOT_EQUAL
(!=),CONTAINS
(=contains()),NOT_CONTAINS
(=!contains())updateEpoch
:GREATER_THAN_OR_EQUALS
(<=),LESS_THAN_OR_EQUALS
(>=)status
:EQUAL
(=),NOT_EQUAL
(!=),CONTAINS
(=contains()),NOT_CONTAINS
(=!contains())
property=updateEpoch>=1683669114845
property=name!=testingrelease
property=status=contains(new,processing,disabled)
Verzoek
Het volgende verzoek wint de laatste drie gegevens verwerkte attributen terug die in uw organisatie werden bijgewerkt.
code language-shell |
---|
|
Reactie
Een succesvolle reactie retourneert HTTP-status 200 met een lijst van de laatste 3 bijgewerkte berekende kenmerken die bij uw organisatie en sandbox horen.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Eigenschap | Beschrijving |
_links |
Een object dat de pagineringsinformatie bevat die nodig is voor toegang tot de laatste pagina met resultaten, de volgende pagina met resultaten, de vorige pagina met resultaten of de huidige pagina met resultaten. |
computedAttributes |
Een array die de berekende kenmerken bevat op basis van de queryparameters. Meer informatie over de gegevens verwerkte attributenserie kan in worden gevonden wint een specifieke gegevens verwerkte attributensectieterug. |
_page |
Een object dat metagegevens bevat over de geretourneerde resultaten. Dit omvat informatie over de huidige verschuiving, het aantal geretourneerde berekende kenmerken, het totale aantal berekende kenmerken en de limiet van geretourneerde berekende kenmerken. |
Een berekend kenmerk maken create
Om een gegevens verwerkt attribuut tot stand te brengen, begin door een verzoek van de POST aan het /attributes
eindpunt met een verzoeklichaam te doen dat de details van het gegevens verwerkte attribuut bevat dat u wenst om tot stand te brengen.
API formaat
POST /attributes
Verzoek
code language-shell |
---|
|
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 |
name |
De naam van het berekende kenmerkveld, als een tekenreeks. De naam van het berekende kenmerk kan alleen bestaan uit alfanumerieke tekens zonder spaties of onderstrepingstekens. Deze waarde moet onder alle gegevens verwerkte attributen uniek zijn. Deze naam is de beste manier om een camelCase-versie van de instructie displayName te gebruiken. |
description |
Een beschrijving van het berekende kenmerk. Dit is vooral handig als er meerdere berekende kenmerken zijn gedefinieerd, omdat dit anderen binnen uw organisatie helpt te bepalen welk kenmerk correct moet worden berekend. |
displayName |
De weergavenaam voor het berekende kenmerk. Dit is de naam die wordt weergegeven wanneer u uw berekende kenmerken weergeeft in de gebruikersinterface van Adobe Experience Platform. |
expression |
Een object dat de query-expressie vertegenwoordigt van het berekende kenmerk dat u probeert te maken. |
expression.type |
Het type van de expressie. Momenteel wordt alleen PQL ondersteund. |
expression.format |
De indeling van de expressie. Momenteel wordt alleen pql/text ondersteund. |
expression.value |
De waarde van de expressie. |
keepCurrent |
Een Booleaanse waarde die bepaalt of de waarde van het berekende kenmerk up-to-date wordt gehouden met de functie voor snel vernieuwen. Deze waarde moet momenteel worden ingesteld op false . |
duration |
Een object dat de terugzoekperiode voor het berekende kenmerk vertegenwoordigt. De terugkijkperiode vertegenwoordigt hoe ver terug kan worden gezocht om de gegevens verwerkte attributen te berekenen. |
duration.count |
Een getal dat de duur van de terugzoekperiode vertegenwoordigt. De mogelijke waarden zijn afhankelijk van de waarde van het veld
|
duration.unit |
Een tekenreeks die de tijdseenheid vertegenwoordigt die voor de terugzoekperiode wordt gebruikt. Mogelijke waarden zijn: HOURS , DAYS , WEEKS en MONTHS . |
status |
De status van het berekende kenmerk. Mogelijke waarden zijn DRAFT en NEW . |
Reactie
Een geslaagde reactie retourneert HTTP status 200 met informatie over het nieuwe berekende kenmerk.
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 |
De door het systeem gegenereerde id van het nieuwe berekende kenmerk. |
status |
De status van het berekende kenmerk. Dit kan DRAFT of NEW zijn. |
createEpoch |
De tijd waarop het berekende attribuut werd gecreeerd, in seconden. |
updateEpoch |
Het tijdstip waarop het berekende kenmerk voor het laatst is bijgewerkt, in seconden. |
createdBy |
De id van de gebruiker die het berekende kenmerk heeft gemaakt. |
Hiermee wordt een specifiek berekend kenmerk opgehaald get
U kunt gedetailleerde informatie over een specifiek gegevens verwerkt attribuut terugwinnen door een verzoek van de GET aan het /attributes
eindpunt te doen en identiteitskaart van de gegevens verwerkte attributen te verstrekken u in de verzoekweg wenst terug te winnen.
API formaat
GET /attributes/{ATTRIBUTE_ID}
Verzoek
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP-status 200 met gedetailleerde informatie over het opgegeven berekende kenmerk.
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 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 | |
---|---|
Eigenschap | Beschrijving |
id |
Een unieke, alleen-lezen, door het systeem gegenereerde id die kan worden gebruikt voor het verwijzen naar het berekende kenmerk tijdens andere API-bewerkingen. |
type |
Een tekenreeks die aangeeft dat het geretourneerde object een berekend kenmerk is. |
name |
The name for the computed attribute. |
displayName |
De weergavenaam voor het berekende kenmerk. Dit is de naam die wordt weergegeven wanneer u uw berekende kenmerken weergeeft in de gebruikersinterface van Adobe Experience Platform. |
description |
Een beschrijving van het berekende kenmerk. Dit is vooral handig als er meerdere berekende kenmerken zijn gedefinieerd, omdat dit anderen binnen uw organisatie helpt te bepalen welk kenmerk correct moet worden berekend. |
imsOrgId |
De id van de organisatie waartoe het berekende kenmerk behoort. |
sandbox |
Het sandboxobject bevat details van de sandbox waarin het berekende kenmerk is geconfigureerd. Deze informatie wordt getekend vanuit de sandboxheader die in de aanvraag wordt verzonden. Voor meer informatie, te zien gelieve het overzicht van zandbakken. |
path |
The path to the computed attribute. |
keepCurrent |
Een Booleaanse waarde die bepaalt of de waarde van het berekende kenmerk up-to-date wordt gehouden met de functie voor snel vernieuwen. |
expression |
Een object dat de expressie van het berekende kenmerk bevat. |
mergeFunction |
Een object dat de samenvoegfunctie voor het berekende kenmerk bevat. Deze waarde is gebaseerd op de corresponderende aggregatieparameter binnen de berekende expressie van het kenmerk. Mogelijke waarden zijn SUM , MIN , MAX en MOST_RECENT . |
status |
De status van het berekende kenmerk. Dit kan een van de volgende waarden zijn: DRAFT , NEW , INITIALIZING , PROCESSING , PROCESSED , FAILED of DISABLED . |
schema |
Een object dat informatie bevat over het schema waarin de expressie wordt geëvalueerd. Momenteel wordt alleen _xdm.context.profile ondersteund. |
lastEvaluationTs |
Een tijdstempel die aangeeft wanneer het berekende kenmerk voor het laatst is geëvalueerd. |
createEpoch |
De tijd waarop het berekende attribuut werd gecreeerd, in seconden. |
updateEpoch |
Het tijdstip waarop het berekende kenmerk voor het laatst is bijgewerkt, in seconden. |
createdBy |
De id van de gebruiker die het berekende kenmerk heeft gemaakt. |
Een specifiek berekend kenmerk verwijderen delete
U kunt een specifiek gegevens verwerkt attribuut schrappen door een verzoek van DELETE aan het /attributes
eindpunt te doen en identiteitskaart van de gegevens verwerkte attributen te verstrekken u in de verzoekweg wenst te schrappen.
DRAFT
) hebben. Dit eindpunt kan niet worden gebruikt om gegevens verwerkte attributen in een andere staat te schrappen.API formaat
DELETE /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}
id
-waarde van het berekende kenmerk dat u wilt verwijderen.Verzoek
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP status 202 met details van het verwijderde berekende kenmerk.
code language-json |
---|
|
Een specifiek berekend kenmerk bijwerken
U kunt een specifiek gegevens verwerkt attribuut bijwerken door een verzoek van PATCH aan het /attributes
eindpunt te doen en identiteitskaart van de gegevens verwerkte attributen te verstrekken u wenst om in de verzoekweg bij te werken.
- Als de huidige status
NEW
is, kan de status alleen worden gewijzigd inDISABLED
. - Als de huidige status
DRAFT
is, kunt u de waarden van de volgende velden wijzigen:name
,description
,keepCurrent
,expression
enduration
. U kunt de status ook wijzigen vanDRAFT
inNEW
. Wijzigingen in door het systeem gegenereerde velden, zoalsmergeFunction
ofpath
, retourneren een fout. - Als de huidige status
PROCESSING
ofPROCESSED
is, kan de status alleen worden gewijzigd inDISABLED
.
API formaat
PATCH /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}
id
-waarde van het berekende kenmerk dat u wilt bijwerken.Verzoek
In de volgende aanvraag wordt de status van het berekende kenmerk van DRAFT
tot NEW
bijgewerkt.
code language-shell |
---|
|
Reactie
Een geslaagde reactie retourneert HTTP status 200 met informatie over het zojuist bijgewerkte berekende kenmerk.
code language-json |
---|
|
Volgende stappen
Nu u de grondbeginselen van berekende attributen hebt geleerd, bent u klaar om te beginnen bepalend hen voor uw organisatie. Leren hoe te om gegevens verwerkte attributen in het Experience Platform UI te gebruiken, te lezen gelieve de gegevens verwerkte gids UI van attributen.