DocumentatieJourney OptimizerHandleiding voor Journey Optimizer

Persoonlijke aanbiedingen weergeven list-personalized-offers

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Ervaren
  • Ontwikkelaar

Een gepersonaliseerd aanbod is een aanpasbaar marketingbericht op basis van geschiktheidsregels en -beperkingen.

U kunt een lijst met alle gepersonaliseerde aanbiedingen weergeven door één GET-aanvraag uit te voeren voor de Offer Library API.

API formaat

GET /{ENDPOINT_PATH}/offers?offer-type=personalized&{QUERY_PARAMS}
Parameter
Beschrijving
Voorbeeld
{ENDPOINT_PATH}
Het eindpuntpad voor persistentie-API's.
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
Optionele queryparameters om resultaten te filteren op.
limit=2

Verzoek

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}'

Query-parameters gebruiken using-query-parameters

U kunt queryparameters gebruiken om de resultaten te filteren en te pagineren wanneer u bronnen weergeeft.

Paginering paging

De gemeenschappelijkste vraagparameters voor het pagineren omvatten:

Parameter
Beschrijving
Voorbeeld
property

Een optioneel eigenschapsfilter:

  • De eigenschappen worden gegroepeerd door EN-bewerking.
  • De parameters kunnen als zo worden herhaald: property= {PROPERTY_EXPR} [ &property= {PROPERTY_EXPR2}… ] of property= {PROPERTY_EXPR1} [, {PROPERTY_EXPR2}…]
  • Eigenschapexpressies hebben de notatie [ !]field[op]value en ondersteunen op in [==,!=,<=,>=,<,>,~] reguliere expressies.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
Resultaten sorteren op een bepaalde eigenschap. Als u de naam a - before toevoegt (orderby=-name), worden de items op naam gesorteerd in aflopende volgorde (Z-A). Padexpressies hebben de vorm van door punten gescheiden paden. Deze parameter kan als volgt worden herhaald: orderby=field1[,-fields2,field3,...]
orderby=id, -name
limit
Beperk het aantal geretourneerde plaatsen.
limit=5

Reactie

Een succesvolle reactie keert een lijst van gepersonaliseerde aanbiedingen terug die samen met die aanwezig zijn die u toegang tot hebt.

{
    "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"
        }
    }
}

Voer paginering uit als de veelvoudige gepersonaliseerde aanbiedingen van de reactie missen.

Reactie

{
    "results": [...],
    "count": 2,
    "total": 43,
    "_links": {
        "self": {
        "href": "/offers?orderby=-modified&limit=2&offer-type=PERSONALIZED",
        "type": "application/json"
        },
        "next": {
        "href": "/offers?orderby=-modified&limit=2&start={TIMESTAMP}&offer-type=PERSONALIZED",
        "type": "application/json"
        }
    }
    }
Metrisch
Beschrijving
total
Het aantal persoonlijke aanbiedingen.
count
Het aantal voorstellen dat in dit antwoord wordt geretourneerd.

Haal het eindpunt op van _links.next.href zoals /offers?orderby=-modified&limit=2&start={TIMESTAMP}&offer-type=PERSONALIZED en voeg het toe aan de API.

API Formaat

GET /{ENDPOINT_PATH}/offers?orderby=-modified&limit=2&start={TIMESTAMP}&offer-type=PERSONALIZED

{
    "results": [...],
    "count": 2,
    "total": 43,
    "_links": {
        "self": {...},
        "next": {
        "href": "/offers?orderby=-modified&limit=2&start={TIMESTAMP}&offer-type=PERSONALIZED",
        "type": "application/json"
        }
    }
}

Als u zich niet op de eerste pagina bevindt en de vorige pagina met gepersonaliseerde aanbiedingen moet ophalen, gebruikt u de waarde href van _links.prev . Vraag de URL om de vorige resultatenset, zoals in het onderstaande voorbeeld wordt getoond.

Reactie

{
    "results": [...],
    "count": 2,
    "total": 43,
    "_links": {
        "self": {...},
        "next": {...},
        "prev": {
        "href": "/offers?orderby=-modified&limit=2&start={TIMESTAMP}&offer-type=PERSONALIZED",
        "type": "application/json"
        }
    }
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76