DokumentationJourney OptimizerHandbuch für Journey Optimizer

Auflisten personalisierter Angebote list-personalized-offers

Last update: Fri Dec 29 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Experte
  • Entwickler

Ein personalisiertes Angebot ist eine anpassbare Marketing-Nachricht, die auf Eignungsregeln und Einschränkungen basiert.

Durch Ausführung einer einzelnen GET-Anfrage an die Offer Library-API können Sie eine Liste aller personalisierten Angebote anzeigen.

API-Format

GET /{ENDPOINT_PATH}/offers?offer-type=personalized&{QUERY_PARAMS}
Parameter
Beschreibung
Beispiel
{ENDPOINT_PATH}
Der Endpunktpfad für persistente APIs.
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
Optionale Abfrageparameter zum Filtern der Ergebnisse.
limit=2

Anfrage

curl -X GET 'https://platform.adobe.io/data/core/dps/offers?offer-type=personalized&limit=2' \
-H 'Accept: *,application/json' \
-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}'

Verwenden von Abfrageparametern using-query-parameters

Beim Auflisten von Ressourcen können Sie Abfrageparameter nutzen, um Ergebnisse zu sortieren und zu filtern.

Paging paging

Zu den häufigsten Abfrageparametern für das Paging gehören:

Parameter
Beschreibung
Beispiel
property

Ein optionaler Eigenschaftenfilter:

  • Die Eigenschaften werden nach UND-Vorgang gruppiert.
  • Parameter können wie folgt wiederholt werden: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] oder property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
  • Eigenschaftenausdrücke haben das Format [!]field[op]value, mit op in [==,!=,<=,>=,<,>,~], wobei reguläre Ausdrücke unterstützt werden.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
Sortieren Sie die Ergebnisse nach einer bestimmten Eigenschaft. Durch Hinzufügen eines „-“ vor dem Namen (orderby=-name) werden Elemente nach Namen in absteigender Reihenfolge sortiert (Z–A). Pfadausdrücke haben die Form von durch Punkte getrennten Pfaden. Dieser Parameter kann wie folgt wiederholt werden: orderby=field1[,-fields2,field3,...]
orderby=id,-name
limit
Einschränken der Anzahl der zurückgegebenen Platzierungen.
limit=5

Antwort

Bei einer erfolgreichen Antwort wird eine Liste mit personalisierten Angeboten zurückgegeben, die vorhanden sind, sowie den Angeboten, auf die Sie Zugriff haben.

{
    "results": [
        {
            "created": "2023-05-15T14:35:16.781+00:00",
            "modified": "2023-05-15T14:38:26.691+00:00",
            "etag": 2,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.15"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "personalizedOffer1234",
            "name": "Test personalized offer with frequency constraint",
            "status": "draft",
            "representations": [
                {
                    "channel": "https://ns.adobe.com/xdm/channel-types/web",
                    "placement": "offerPlacement1234",
                    "components": [
                        {
                            "type": "html",
                            "format": "text/html",
                            "language": [
                                "en-us"
                            ],
                            "content": "Hello You qualify for our Discount of 60%"
                        }
                    ]
                }
            ],
            "selectionConstraint": {
                "startDate": "2022-07-27T05:00:00.000+00:00",
                "endDate": "2023-07-29T05:00:00.000+00:00",
                "profileConstraintType": "none"
            },
            "rank": {
                "priority": 0
            },
            "cappingConstraint": {},
            "frequencyCappingConstraints": [
                {
                    "enabled": false,
                    "limit": 1,
                    "startDate": "2023-05-15T14:25:49.622+00:00",
                    "endDate": "2023-05-25T14:25:49.622+00:00",
                    "scope": "global",
                    "entity": "offer",
                    "repeat": {
                        "enabled": false,
                        "unit": "month",
                        "unitCount": 1
                    }
                }
            ]
        }
    ],
    "count": 1,
    "total": 1,
    "_links": {
        "self": {
            "href": "/offers?offer-type=personalized&href={SELF_HREF}",
            "type": "application/json"
        }
    }
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76