Dokumentation Journey Optimizer Handbuch für Journey Optimizer

Auflisten von Entscheidungen

6. November 2023

Erstellt für:

Experte
Entwickler

Eine Entscheidung enthält die Logik, die über die Auswahl eines Angebots bestimmt.

Durch Ausführung einer einzelnen GET-Anfrage an die Offer Library-API können Sie eine Liste aller Entscheidungen in einem Container anzeigen.

API-Format

GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_ACTIVITIES}&{QUERY_PARAMS}

Parameter	Beschreibung	Beispiel
`{ENDPOINT_PATH}`	Der Endpunktpfad für Repository-APIs.	`https://platform.adobe.io/data/core/xcore/`
`{CONTAINER_ID}`	Der Container, in dem sich die Entscheidungen befinden.	`e0bd8463-0913-4ca1-bd84-6309134ca1f6`
`{SCHEMA_ACTIVITIES}`	Definiert das mit Entscheidungen verknüpfte Schema.	`https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5`
`{QUERY_PARAMS}`	Optionale Abfrageparameter zum Filtern der Ergebnisse.	`limit=2`

Anfrage

curl -X GET \
  'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-activity;version=0.5&limit=2' \
  -H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'

Parameter

Beschreibung

Beispiel

q

Eine optionale Abfragezeichenfolge, nach der in ausgewählten Feldern gesucht werden soll. Die Abfragezeichenfolge sollte in Kleinbuchstaben verfasst werden und kann von doppelten Anführungszeichen umgeben sein, um eine Tokenisierung zu verhindern und Sonderzeichen zu umgehen (Escape). Die Zeichen + - = && || > < ! ( ) { } [ ] ^ \" ~ * ? : \ / haben eine besondere Bedeutung und sollten bei der Darstellung in der Abfragezeichenfolge mit einem umgekehrten Schrägstrich als Escape-Zeichen versehen werden.

default

qop

Wendet den AND- oder OR-Operator auf Werte im Abfragezeichenfolgen-Parameter an.

AND / OR

field

Optionale Liste der Felder, auf die die Suche beschränkt werden soll. Dieser Parameter kann wie folgt wiederholt werden: field=field1[,field=field2,…] und (Pfadausdrücke haben die Form von durch Punkte getrennten Pfaden wie _instance.xdm:name)

_instance.xdm:name

orderBy

Sortieren Sie die Ergebnisse nach einer bestimmten Eigenschaft. Das Hinzufügen von - vor dem Titel (orderby=-title) sortiert die Ergebnisse nach Titel in absteigender Reihenfolge (Z-A).

-repo:createdDate

limit

Schränkt die Anzahl der zurückgegebenen Entscheidungen ein.

limit=5

Antwort

Bei einer erfolgreichen Antwort wird eine Liste von Entscheidungen zurückgegeben, die in dem Container vorhanden sind, auf den Sie Zugriff haben.

{
    "results": [
        {
            "created": "2022-07-05T09:02:02.835+00:00",
            "modified": "2022-08-16T21:40:58.573+00:00",
            "etag": 12,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.8"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerDecision1234",
            "name": "Test Decision One",
            "status": "live",
            "startDate": "2022-05-18T00:09:57.706+00:00",
            "endDate": "2032-08-13T21:40:58.235+00:00",
            "fallback": "fallbackOffer1234",
            "criteria": [
                {
                    "placements": [
                        "offerPlacement1234",
                        "offerPlacement5678"
                    ],
                    "rank": {
                        "priority": 0,
                        "order": {
                            "orderEvaluationType": "ranking-strategy",
                            "rankingStrategy": "123456789123"
                        }
                    },
                    "profileConstraint": {
                        "profileConstraintType": "none"
                    },
                    "optionSelection": {
                        "filter": "offerCollection1234"
                    }
                }
            ]
        },
        {
            "created": "2022-09-05T14:12:13.773+00:00",
            "modified": "2022-09-05T14:12:13.773+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-activity;version=0.8"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerDecision5678",
            "name": "Test Decision Two",
            "status": "live",
            "startDate": "2022-08-31T21:00:00.000+00:00",
            "endDate": "2023-02-03T22:00:00.000+00:00",
            "fallback": "fallbackOffer5678",
            "criteria": [
                {
                    "placements": [
                        "offerPlacement1234"
                    ],
                    "rank": {
                        "priority": 2
                    },
                    "optionSelection": {
                        "filter": "offerCollection5678"
                    }
                },
                {
                    "placements": [
                        "offerPlacement5678"
                    ],
                    "rank": {
                        "priority": 1
                    },
                    "optionSelection": {
                        "filter": "offerCollection1234"
                    }
                }
            ]
        }
    ],
    "count": 2,
    "total": 21,
    "_links": {
        "self": {
            "href": "/offer-decisions?href={SELF_HREF}&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/offer-decisions?href={NEXT_HREF}&limit=2",
            "type": "application/json"
        }
    }
}

recommendation-more-help