API-Endpunkt für berechnete Attribute
Berechnete Attribute sind Funktionen, mit denen Daten auf Ereignisebene in Attribute auf Profilebene aggregiert werden. Diese Funktionen werden automatisch berechnet, sodass sie für die Segmentierung, Aktivierung und Personalisierung verwendet werden können. Dieses Handbuch enthält Beispiel-API-Aufrufe zum Ausführen grundlegender CRUD-Vorgänge mit dem /attributes
-Endpunkt.
Um mehr über berechnete Attribute zu erfahren, lesen Sie zunächst den Abschnitt Berechnete Attribute - Übersicht.
Erste Schritte
Der in diesem Handbuch verwendete API-Endpunkt ist Teil der Echtzeit-Kundenprofil-API.
Bevor Sie fortfahren, lesen Sie das Handbuch Erste Schritte mit der Profil-API mit Links zur empfohlenen Dokumentation, einer Anleitung zum Lesen der Beispiel-API-Aufrufe, die in diesem Dokument angezeigt werden, und wichtigen Informationen zu erforderlichen Kopfzeilen, die für das erfolgreiche Aufrufen einer Experience Platform-API erforderlich sind.
Lesen Sie außerdem die Dokumentation für den folgenden Service:
- Experience Data Model (XDM) System: Das standardisierte Framework, mit dem Kundenerlebnisdaten von Experience Platform organisiert werden.
- Erste Schritte mit der Schemaregistrierung: Informationen zu Ihrer
{TENANT_ID}
, die in den Antworten in diesem Handbuch enthalten sind, werden bereitgestellt.
- Erste Schritte mit der Schemaregistrierung: Informationen zu Ihrer
Abrufen einer Liste berechneter Attribute list
Sie können eine Liste aller berechneten Attribute für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den /attributes
-Endpunkt senden.
API-Format
Der /attributes
-Endpunkt unterstützt verschiedene Abfrageparameter, mit denen Sie Ihre Ergebnisse filtern können. Obwohl diese Parameter optional sind, wird ihre Verwendung dringend empfohlen, um kostspieligen Aufwand bei der Auflistung von Ressourcen zu reduzieren. Wenn Sie diesen Endpunkt ohne Parameter aufrufen, werden alle für Ihre Organisation verfügbaren berechneten Attribute abgerufen. Es können mehrere Parameter eingeschlossen werden, die durch kaufmännische Und-Zeichen (&
) voneinander getrennt werden.
GET /attributes
GET /attributes?{QUERY_PARAMETERS}
Beim Abrufen einer Liste von berechneten Attributen können die folgenden Abfrageparameter verwendet werden:
limit
limit=20
offset
offset=5
sortBy
name
, status
, updateEpoch
und createEpoch
. Sie können auch auswählen, ob in auf- oder absteigender Reihenfolge sortiert werden soll, indem Sie keine -
vor der Sortieroption einfügen oder einfügen. Standardmäßig werden die Elemente nach updateEpoch
in absteigender Reihenfolge sortiert.sortBy=name
property
Ein Parameter, mit dem Sie nach verschiedenen berechneten Attributfeldern filtern können. Zu den unterstützten Eigenschaften gehören name
, createEpoch
, mergeFunction.value
, updateEpoch
und status
. Die unterstützten Vorgänge hängen von der aufgelisteten Eigenschaft ab.
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)
Anfrage
Die folgende Anfrage ruft die letzten drei berechneten Attribute ab, die in Ihrer Organisation aktualisiert wurden.
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit einer Liste der letzten 3 aktualisierten berechneten Attribute zurückgegeben, die zu Ihrer Organisation und Sandbox gehören.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 | |
---|---|
Eigenschaft | Beschreibung |
_links |
Ein Objekt, das die Paginierungsinformationen enthält, die für den Zugriff auf die letzte Ergebnisseite, die nächste Ergebnisseite, die vorherige Ergebnisseite oder die aktuelle Ergebnisseite erforderlich sind. |
computedAttributes |
Ein Array, das die auf der Grundlage Ihrer Abfrageparameter berechneten Attribute enthält. Weitere Informationen zum Array der berechneten Attribute finden Sie im Abschnitt Abrufen eines bestimmten berechneten Attributs. |
_page |
Ein -Objekt, das Metadaten zu den zurückgegebenen Ergebnissen enthält. Dazu gehören Informationen über den aktuellen Offset, die Anzahl der zurückgegebenen berechneten Attribute, die Gesamtzahl der berechneten Attribute sowie die Beschränkung der zurückgegebenen berechneten Attribute. |
Berechnetes Attribut erstellen create
Um ein berechnetes Attribut zu erstellen, stellen Sie zunächst eine POST-Anfrage an den /attributes
-Endpunkt mit einem Anfragetext, der die Details des berechneten Attributs enthält, das Sie erstellen möchten.
API-Format
POST /attributes
Anfrage
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 | |
---|---|
Eigenschaft | Beschreibung |
name |
Der Name des berechneten Feldnamenfelds als Zeichenfolge. Der Name des berechneten Attributs darf nur aus alphanumerischen Zeichen ohne Leerzeichen oder Unterstriche bestehen. Dieser Wert muss unter allen berechneten Attributen eindeutig sein. Als Best Practice sollte dieser Name eine CamelCase-Version des displayName sein. |
description |
Eine Beschreibung des berechneten Attributs. Dies ist besonders nützlich, wenn mehrere berechnete Attribute definiert wurden, da es anderen in Ihrer Organisation helfen kann, das richtige zu verwendende berechnete Attribut zu ermitteln. |
displayName |
Der Anzeigename für das berechnete Attribut. Dies ist der Name, der angezeigt wird, wenn Ihre berechneten Attribute in der Adobe Experience Platform-Benutzeroberfläche aufgelistet werden. |
expression |
Ein -Objekt, das den Abfrageausdruck des berechneten Attributs darstellt, das Sie erstellen möchten. |
expression.type |
Der Typ des Ausdrucks. Derzeit wird nur PQL unterstützt. |
expression.format |
Das Format des Ausdrucks. Derzeit wird nur pql/text unterstützt. |
expression.value |
Der Wert des Ausdrucks. |
keepCurrent |
Ein boolescher Wert, der darüber bestimmt, ob der Wert des berechneten Attributs durch schnelle Aktualisierung auf dem neuesten Stand gehalten wird oder nicht. Derzeit sollte dieser Wert auf false gesetzt werden. |
duration |
Ein -Objekt, das den Lookback-Zeitraum für das berechnete Attribut darstellt. Der Lookback-Zeitraum gibt an, wie weit das berechnete Attribut zurückgeschaut werden kann. |
duration.count |
Eine Zahl, die die Dauer für den Lookback-Zeitraum darstellt. Die möglichen Werte hängen vom Wert des
|
duration.unit |
Eine Zeichenfolge, die die Zeiteinheit darstellt, die für den Lookback-Zeitraum verwendet wird. Mögliche Werte sind: HOURS , DAYS , WEEKS und MONTHS . |
status |
Der Status des berechneten Attributs. Mögliche Werte sind DRAFT und NEW . |
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Informationen zu Ihrem neu erstellten berechneten Attribut zurückgegeben.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Die systemgenerierte ID Ihres neu erstellten berechneten Attributs. |
status |
Der Status des berechneten Attributs. Dies kann entweder DRAFT oder NEW sein. |
createEpoch |
Der Zeitpunkt, zu dem das berechnete Attribut erstellt wurde, in Sekunden. |
updateEpoch |
Der Zeitpunkt, zu dem das berechnete Attribut zuletzt aktualisiert wurde, in Sekunden. |
createdBy |
Die ID des Benutzers, der das berechnete Attribut erstellt hat. |
Abrufen eines bestimmten berechneten Attributs get
Sie können detaillierte Informationen zu einem bestimmten berechneten Attribut abrufen, indem Sie eine GET-Anfrage an den /attributes
-Endpunkt senden und im Anfragepfad die ID des berechneten Attributs angeben, das Sie abrufen möchten.
API-Format
GET /attributes/{ATTRIBUTE_ID}
Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit detaillierten Informationen zum angegebenen berechneten Attribut zurück.
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 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine eindeutige, schreibgeschützte, systemgenerierte ID, die bei anderen API-Vorgängen zum Verweisen auf das berechnete Attribut genutzt werden kann. |
type |
Eine Zeichenfolge, die anzeigt, dass das zurückgegebene -Objekt ein berechnetes Attribut ist. |
name |
Der Name für das berechnete Attribut. |
displayName |
Der Anzeigename für das berechnete Attribut. Dies ist der Name, der angezeigt wird, wenn Ihre berechneten Attribute in der Adobe Experience Platform-Benutzeroberfläche aufgelistet werden. |
description |
Eine Beschreibung des berechneten Attributs. Dies ist besonders nützlich, wenn mehrere berechnete Attribute definiert wurden, da es anderen in Ihrer Organisation helfen kann, das richtige zu verwendende berechnete Attribut zu ermitteln. |
imsOrgId |
Die ID der Organisation, zu der das berechnete Attribut gehört. |
sandbox |
Das Sandbox-Objekt enthält Details zur Sandbox, in der das berechnete Attribut konfiguriert wurde. Diese Daten werden aus der in der Anfrage gesendeten Sandbox-Kopfzeile extrahiert. Weiterführende Informationen dazu finden Sie in der Sandbox-Übersicht. |
path |
Die path zum berechneten Attribut. |
keepCurrent |
Ein boolescher Wert, der darüber bestimmt, ob der Wert des berechneten Attributs durch schnelle Aktualisierung auf dem neuesten Stand gehalten wird oder nicht. |
expression |
Ein -Objekt, das den Ausdruck des berechneten Attributs enthält. |
mergeFunction |
Ein Objekt, das die Zusammenführungsfunktion für das berechnete Attribut enthält. Dieser Wert basiert auf dem entsprechenden Aggregationsparameter im Ausdruck des berechneten Attributs. Zu den möglichen Werten gehören SUM , MIN , MAX und MOST_RECENT . |
status |
Der Status des berechneten Attributs. Dies kann einer der folgenden Werte sein: DRAFT , NEW , INITIALIZING , PROCESSING , PROCESSED , FAILED oder DISABLED . |
schema |
Ein Objekt, das Informationen zum Schema enthält, in dem der Ausdruck ausgewertet wird. Derzeit wird nur _xdm.context.profile unterstützt. |
lastEvaluationTs |
Ein Zeitstempel, der angibt, wann das berechnete Attribut zuletzt ausgewertet wurde. |
createEpoch |
Der Zeitpunkt, zu dem das berechnete Attribut erstellt wurde, in Sekunden. |
updateEpoch |
Der Zeitpunkt, zu dem das berechnete Attribut zuletzt aktualisiert wurde, in Sekunden. |
createdBy |
Die ID des Benutzers, der das berechnete Attribut erstellt hat. |
Bestimmtes berechnetes Attribut löschen delete
Sie können ein bestimmtes berechnetes DELETE löschen, indem Sie eine Attributanfrage an den /attributes
-Endpunkt stellen und im Anfragepfad die Kennung des berechneten Attributs angeben, das Sie löschen möchten.
DRAFT
) verwendet werden. Dieser Endpunkt kann nicht verwendet werden, um berechnete Attribute in einem anderen Status zu löschen.API-Format
DELETE /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}
id
des berechneten Attributs, das Sie löschen möchten.Anfrage
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 202 mit Details zum gelöschten berechneten Attribut zurückgegeben.
code language-json |
---|
|
Spezifisches berechnetes Attribut aktualisieren
Sie können ein bestimmtes berechnetes Attribut aktualisieren, indem Sie eine PATCH-Anfrage an den /attributes
-Endpunkt senden und im Anfragepfad die ID des berechneten Attributs angeben, das Sie aktualisieren möchten.
- Wenn der aktuelle Status
NEW
ist, kann der Status nur inDISABLED
geändert werden. - Wenn der aktuelle Status
DRAFT
ist, können Sie die Werte der folgenden Felder ändern:name
,description
,keepCurrent
,expression
undduration
. Sie können auch den Status vonDRAFT
inNEW
ändern. Alle Änderungen an systemgenerierten Feldern wiemergeFunction
oderpath
geben einen Fehler zurück. - Wenn der aktuelle Status entweder
PROCESSING
oderPROCESSED
ist, kann der Status nur inDISABLED
geändert werden.
API-Format
PATCH /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}
id
des berechneten Attributs, das Sie aktualisieren möchten.Anfrage
Die folgende Anfrage aktualisiert den Status des berechneten Attributs von DRAFT
auf NEW
.
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit Informationen zu Ihrem neu aktualisierten berechneten Attribut zurück.
code language-json |
---|
|
Nächste Schritte
Nachdem Sie nun die Grundlagen von berechneten Attributen gelernt haben, können Sie damit beginnen, sie für Ihr Unternehmen zu definieren. Informationen zur Verwendung berechneter Attribute in der Experience Platform-Benutzeroberfläche finden Sie im Handbuch zur Benutzeroberfläche für berechnete Attribute.