DokumentationExperience PlatformHandbuch zum Echtzeit-Kundenprofil

API-Endpunkt für berechnete Attribute

Last update: Fri Nov 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Benutzende
IMPORTANT
Der Zugriff auf die API ist eingeschränkt. Informationen zum Zugriff auf die API für berechnete Attribute erhalten Sie beim Adobe-Support.

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 mithilfe des /attributes -Endpunkt.

Um mehr über berechnete Attribute zu erfahren, lesen Sie zunächst die Übersicht über berechnete Attribute.

Erste Schritte

Der in diesem Handbuch verwendete API-Endpunkt ist Teil der Echtzeit-Kundenprofil-API.

Bevor Sie fortfahren, lesen Sie bitte die Erste Schritte mit der Profil-API für Links zur empfohlenen Dokumentation, eine Anleitung zum Lesen der in diesem Dokument angezeigten Beispiel-API-Aufrufe und wichtige Informationen zu erforderlichen Kopfzeilen, die für das erfolgreiche Aufrufen von Experience Platform-APIs erforderlich sind.

Lesen Sie außerdem die Dokumentation für den folgenden Dienst:

Liste berechneter Attribute abrufen list

Sie können eine Liste aller berechneten Attribute für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an die /attributes -Endpunkt.

API-Format

Der /attributes-Endpunkt unterstützt verschiedene Abfrageparameter, mit denen Sie Ihre Ergebnisse filtern können. Diese Parameter sind zwar optional, doch wird ihre Verwendung dringend empfohlen, um bei der Auflistung von Ressourcen den teuren Verwaltungsaufwand 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 berechneter Attribute können die folgenden Abfrageparameter verwendet werden:

Abfrageparameter
Beschreibung
Beispiel
limit
Ein Parameter, der die maximale Anzahl von Elementen angibt, die als Teil der Antwort zurückgegeben werden. Der Mindestwert dieses Parameters ist 1 und der Höchstwert 40. Wenn dieser Parameter nicht enthalten ist, werden standardmäßig 20 Elemente zurückgegeben.
limit=20
offset
Ein Parameter, der die Anzahl der Elemente angibt, die vor der Rückgabe der Elemente übersprungen werden sollen.
offset=5
sortBy
Ein Parameter, der die Reihenfolge angibt, in der die zurückgegebenen Elemente sortiert werden. Verfügbare Optionen umfassen name, status, updateEpoch, und createEpoch. Sie können auch auswählen, ob eine Sortierung in aufsteigender oder absteigender Reihenfolge erfolgen soll, indem Sie eine - vor der Sortieroption. Standardmäßig werden die Elemente nach updateEpoch in absteigender Reihenfolge.
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 aufgeführten 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

Mit der folgenden Anfrage werden die letzten drei berechneten Attribute abgerufen, die in Ihrem Unternehmen aktualisiert wurden.

Eine Beispielanfrage zum Abrufen einer Liste berechneter Attribute.
code language-shell 
curl -X GET https://platform.adobe.io/data/core/ca/attributes?limit=3 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit einer Liste der letzten 3 aktualisierten berechneten Attribute zurück, die zu Ihrer Organisation und Sandbox gehören.

Eine Beispielantwort zum Abrufen einer Liste berechneter Attribute.
code language-json 
{
    "_links": {
        "last": {
            "href": "/attributes?offset=3&limit=1"
        },
        "next": {
            "href": "/attributes?offset=20&limit=20"
        },
        "prev": {
            "href": "/attributes?offset=0&limit=20"
        },
        "self": {
            "href": "/attributes?offset=0&limit=20"
        }
    },
    "computedAttributes": [
        {
            "id": "2e3bf98c-5840-4eb5-98c9-fcd7bde82188",
            "type": "ComputedAttribute",
            "name": "multipleFilterClauses19",
            "displayName": "Multiple Filter Clauses 19",
            "description": "Multiple Filter Clauses 19",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "e4f64b40-d8d9-11e9-a7ce-f3356ed0508b",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "path": "{TENANT_ID}/ComputedAttributes",
            "keepCurrent": false,
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0)",
            },
            "mergeFunction": {
                "value": "SUM"
            },
            "status": "DRAFT",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "duration": {
                "count": 7,
                "unit": "DAYS"
            },
            "lastEvaluationTs": "",
            "createEpoch": 1671223530322,
            "updateEpoch": 1673043640946,
            "createdBy": "{USER_ID}"
        },
        {
            "id": "d9fbbd3d-049a-4561-b826-adc162511950",
            "type": "ComputedAttribute",
            "name": "multipleFilterClauses20",
            "displayName": "Multiple Filter Clauses 20",
            "description": "Multiple Filter Clauses 20",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "e4f64b40-d8d9-11e9-a7ce-f3356ed0508b",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "path": "{TENANT_ID}/ComputedAttributes",
            "keepCurrent": true,
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "xEvent[eventType.equals(\"commerce.backofficeOrderPlaced\", false)].topN(timestamp, 1).map({\"timestamp\": timestamp, \"value\": producedBy}).head()"
            },
            "mergeFunction": {
                "value": "MOST_RECENT"
            },
            "status": "DRAFT",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "duration": {
                "count": 7,
                "unit": "DAYS"
            },
            "lastEvaluationTs": "",
            "createEpoch": 1671223586455,
            "updateEpoch": 1671223586455,
            "createdBy": "{USER_ID}"
        },
        {
            "id": "afedff07-9d15-4385-b181-49708229d73b",
            "type": "ComputedAttribute",
            "name": "multipleFilterClauses18",
            "displayName": "Multiple Filter Clauses 18",
            "description": "Multiple Filter Clauses 18",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxId": "e4f64b40-d8d9-11e9-a7ce-f3356ed0508b",
                "sandboxName": "prod",
                "type": "production",
                "default": true
            },
            "path": "{TENANT_ID}/ComputedAttributes",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0)",
            },
            "mergeFunction": {
                "value": "SUM"
            },
            "status": "PROCESSED",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "duration": {
                "count": 7,
                "unit": "DAYS"
            },
            "lastEvaluationTs": "2023-08-27T00:14:55.028",
            "createEpoch": 1671220358902,
            "updateEpoch": 1671220358902,
            "createdBy": "{USER_ID}"
        }
    ],
    "_page": {
        "offset": 0,
        "limit": 20,
        "count": 3,
        "totalCount": 3
    }
}
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 berechneten Attribute basierend auf Ihren Abfrageparametern enthält. Weitere Informationen zum berechneten Attribut-Array finden Sie im Abschnitt Abrufen eines bestimmten berechneten Attributabschnitts.
_page Ein Objekt, das Metadaten zu den zurückgegebenen Ergebnissen enthält. Dazu gehören Informationen zum aktuellen Versatz, zur Anzahl der zurückgegebenen berechneten Attribute, zur Gesamtanzahl der berechneten Attribute sowie zur 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 die /attributes -Endpunkt mit einem Anfragetext, der die Details des berechneten Attributs enthält, das Sie erstellen möchten.

API-Format

POST /attributes

Anfrage

Eine Beispielanfrage zum Erstellen eines neuen berechneten Attributs.
code language-shell 
curl -X POST https://platform.adobe.io/data/core/ca/attributes \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'\
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "testing",
        "displayName": "Sample Display Name",
        "description": "Sample Description",
        "expression": {
            "type": "PQL",
            "format": "pql/text",
            "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0)"
        },
        "keepCurrent": false,
        "duration": {
            "count": 4,
            "unit": "DAYS"
        },
        "status": "DRAFT"
      }'
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 Name des berechneten Attributfelds als Zeichenfolge. Der Name des berechneten Attributs darf nur aus alphanumerischen Zeichen ohne Leerzeichen oder Unterstriche bestehen. Dieser Wert must unter allen berechneten Attributen eindeutig sein. Als Best Practice sollte dieser Name eine camelCase-Version der displayName.
description Eine Beschreibung des berechneten Attributs. Dies ist besonders nützlich, wenn mehrere berechnete Attribute definiert wurden, da es anderen in Ihrer Organisation dabei hilft, das richtige berechnete Attribut zu bestimmen, das verwendet werden soll.
displayName Der Anzeigename für das berechnete Attribut. Dies ist der Name, der angezeigt wird, wenn Sie Ihre berechneten Attribute in der Adobe Experience Platform-Benutzeroberfläche auflisten.
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 bestimmt, ob der Wert des berechneten Attributs mithilfe einer schnellen Aktualisierung auf dem neuesten Stand gehalten wird. Derzeit sollte dieser Wert auf false.
duration Ein Objekt, das den Lookback-Zeitraum für das berechnete Attribut darstellt. Der Lookback-Zeitraum gibt an, wie weit zurück zum Berechnen des berechneten Attributs geguckt werden kann.
duration.count

Ein number -Wert, der die Dauer des Lookback-Zeitraums darstellt. Die möglichen Werte hängen vom Wert der duration.unit -Feld.

  • HOURS: 1-24
  • DAYS: 1-7
  • WEEKS: 1-4
  • MONTHS: 1-6
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

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Informationen zu Ihrem neu erstellten berechneten Attribut zurück.

Eine Beispielantwort beim Erstellen eines neuen berechneten Attributs.
code language-json 
{
    "id": "1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631",
    "type": "ComputedAttribute",
    "name": "testing",
    "displayName": "Sample Display Name",
    "description": "Sample Description",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "02dd69f0-da73-11e9-9ea1-af59ce7c24e8",
        "sandboxName": "prod",
        "type": "production",
        "isDefault": true
    },
    "path": "{TENANT_ID}/ComputedAttributes",
    "keepCurrent": false,
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0) and (timestamp occurs <= 7 days before now)].sum(commerce.order.priceTotal)"
    },
    "mergeFunction": {
        "value": "SUM"
    },
    "status": "DRAFT",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "lastEvaluationTs": "",
    "createEpoch": 1680070188696,
    "updateEpoch": 1680070188696,
    "createdBy": "{USER_ID}"
}
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.
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 die /attributes -Endpunkt und die Kennung des berechneten Attributs angeben, das Sie im Anfragepfad abrufen möchten.

API-Format

GET /attributes/{ATTRIBUTE_ID}

Anfrage

Eine Beispielanfrage zum Abrufen eines bestimmten berechneten Attributs.
code language-shell 
curl -X GET 'https://platform.adobe.io/data/core/ca/attributes/1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit detaillierten Informationen zum angegebenen berechneten Attribut zurück.

Eine Beispielantwort beim Abrufen eines bestimmten berechneten Attributs.
code language-json 
{
    "id": "1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631",
    "type": "ComputedAttribute",
    "name": "testing",
    "displayName": "Sample Display Name",
    "description": "Sample Description",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "02dd69f0-da73-11e9-9ea1-af59ce7c24e8",
        "sandboxName": "prod",
        "type": "production",
        "isDefault": true
    },
    "path": "{TENANT_ID}/ComputedAttributes",
    "keepCurrent": false,
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0) and (timestamp occurs <= 7 days before now)].sum(commerce.order.priceTotal)"
    },
    "mergeFunction": {
        "value": "SUM"
    },
    "status": "DRAFT",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "lastEvaluationTs": "",
    "createEpoch": 1680070188696,
    "updateEpoch": 1680070188696,
    "createdBy": "{USER_ID}"
}
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 des berechneten Attributs.
displayName Der Anzeigename für das berechnete Attribut. Dies ist der Name, der angezeigt wird, wenn Sie Ihre berechneten Attribute in der Adobe Experience Platform-Benutzeroberfläche auflisten.
description Eine Beschreibung des berechneten Attributs. Dies ist besonders nützlich, wenn mehrere berechnete Attribute definiert wurden, da es anderen in Ihrer Organisation dabei hilft, das richtige berechnete Attribut zu bestimmen, das verwendet werden soll.
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 hinzu.
keepCurrent Ein boolescher Wert, der bestimmt, ob der Wert des berechneten Attributs mithilfe einer schnellen Aktualisierung auf dem neuesten Stand gehalten wird.
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 innerhalb des Ausdrucks des berechneten Attributs. Mögliche Werte sind SUM, MIN, MAX, und MOST_RECENT.
status Der Status des berechneten Attributs. Dies kann einer der folgenden Werte sein: DRAFT, NEW, INITIALIZING, PROCESSING, PROCESSED, FAILEDoder 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.

Löschen eines bestimmten berechneten Attributs delete

Sie können ein bestimmtes berechnetes Attribut löschen, indem Sie eine DELETE-Anfrage an die /attributes -Endpunkt und die Kennung des berechneten Attributs angeben, das Sie im Anfragepfad löschen möchten.

IMPORTANT
Die Löschanfrage kann nur zum Löschen berechneter Attribute mit dem Status Entwurf (DRAFT). Dieser Endpunkt cannot verwendet werden, um berechnete Attribute in einem anderen Status zu löschen.

API-Format

DELETE /attributes/{ATTRIBUTE_ID}
Parameter
Beschreibung
{ATTRIBUTE_ID}
Die id des berechneten Attributs, das Sie löschen möchten.

Anfrage

Eine Beispielanfrage zum Löschen eines berechneten Attributs.
code language-shell 
curl -X DELETE https://platform.adobe.io/data/core/ca/attributes/1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 202 mit Details zum gelöschten berechneten Attribut zurück.

Eine Beispielantwort beim Löschen eines berechneten Attributs.
code language-json 
{
    "id": "03ae581b-5f7b-48da-a9eb-4ef0daf4bc3c",
    "type": "ComputedAttribute",
    "name": "testdemopd2",
    "displayName": "testdemopd2",
    "description": "testdemopd2",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "02dd69f0-da73-11e9-9ea1-af59ce7c24e8",
        "sandboxName": "prod",
        "type": "production",
        "isDefault": true
    },
    "path": "{TENANT_ID}/ComputedAttributes",
    "keepCurrent": false,
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "xEvent[(commerce.shipping.shipDate occurs <= 1 days before now) and (timestamp occurs <= 1 days before now)].min(commerce.shipping.shipDate)"
    },
    "mergeFunction": {
        "value": "MIN"
    },
    "status": "DRAFT",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "lastEvaluationTs": "",
    "createEpoch": 1681365690928,
    "updateEpoch": 1681365690928,
    "createdBy": "{USER_ID}"
}

Aktualisieren eines bestimmten berechneten Attributs

Sie können ein bestimmtes berechnetes Attribut aktualisieren, indem Sie eine PATCH-Anfrage an die /attributes -Endpunkt und die Kennung des berechneten Attributs angeben, das Sie im Anfragepfad aktualisieren möchten.

IMPORTANT
Beim Aktualisieren eines berechneten Attributs können nur die folgenden Felder aktualisiert werden:
  • Wenn der aktuelle Status NEW, kann der Status nur in DISABLED.
  • Wenn der aktuelle Status DRAFTkönnen Sie die Werte der folgenden Felder ändern: name, description, keepCurrent, expression, und duration. Sie können den Status auch von DRAFT nach NEW. Alle Änderungen an systemgenerierten Feldern, z. B. mergeFunction oder path gibt einen Fehler zurück.
  • Wenn der aktuelle Status PROCESSING oder PROCESSED, kann der Status nur in DISABLED.

API-Format

PATCH /attributes/{ATTRIBUTE_ID}
Parameter
Beschreibung
{ATTRIBUTE_ID}
Die id des berechneten Attributs, das Sie aktualisieren möchten.

Anfrage

Die folgende Anfrage aktualisiert den Status des berechneten Attributs von DRAFT nach NEW.

Eine Beispielanfrage zum Aktualisieren eines berechneten Attributs.
code language-shell 
curl -X PATCH https://platform.adobe.io/data/core/ca/attributes/1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
    "description": "Sample Description",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0) and (timestamp occurs <= 7 days before now)].sum(commerce.order.priceTotal)"
    },
    "status": "NEW"
 }'

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Informationen zu Ihrem neu aktualisierten berechneten Attribut zurück.

Eine Beispielantwort beim Aktualisieren eines berechneten Attributs.
code language-json 
{
    "id": "1e8d0d77-b2bb-4b17-bbe6-2dbc08c1a631",
    "type": "ComputedAttribute",
    "name": "testing123",
    "displayName": "Sample Display Name",
    "description": "Sample Description",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "02dd69f0-da73-11e9-9ea1-af59ce7c24e8",
        "sandboxName": "prod",
        "type": "production",
        "isDefault": true
    },
    "path": "{TENANT_ID}/ComputedAttributes",
    "keepCurrent": false,
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "xEvent[(commerce.checkouts.value > 0.0 or commerce.purchases.value > 1.0 or commerce.order.priceTotal >= 10.0) and (timestamp occurs <= 7 days before now)].sum(commerce.order.priceTotal)"
    },
    "mergeFunction": {
        "value": "SUM"
    },
    "status": "NEW",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "lastEvaluationTs": "",
    "createEpoch": 1680071726825,
    "updateEpoch": 1680074429192,
    "createdBy": "{USER_ID}"
}

Nächste Schritte

Nachdem Sie sich mit den Grundlagen berechneter Attribute vertraut gemacht haben, können Sie nun mit der Definition berechneter Attribute für Ihre Organisation beginnen. Informationen zur Verwendung berechneter Attribute in der Experience Platform-Benutzeroberfläche finden Sie in der UI-Handbuch für berechnete Attribute.

recommendation-more-help
54550d5b-f1a1-4065-a394-eb0f23a2c38b