Enumerar ofertas personalizadas

Última actualización: 2023-10-18
  • Creado para:
  • Experienced
    Developer

Una oferta personalizada es un mensaje de marketing personalizable basado en reglas de elegibilidad y restricciones.

Puede ver una lista de todas las ofertas personalizadas realizando una única solicitud de GET a Offer Library API.

Formato de API

GET /{ENDPOINT_PATH}/offers?offer-type=personalized&{QUERY_PARAMS}
Parámetro Descripción Ejemplo
{ENDPOINT_PATH} Ruta de extremo para las API de persistencia. https://platform.adobe.io/data/core/dps
{QUERY_PARAMS} Parámetros de consulta opcionales por los que filtrar los resultados. limit=2

Solicitud

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

Uso de parámetros de consulta

Puede utilizar parámetros de consulta para paginar y filtrar los resultados al enumerar recursos.

Paginación

Los parámetros de consulta más comunes para la paginación incluyen:

Parámetro Descripción Ejemplo
property Un filtro de propiedad opcional:
  • Las propiedades se agrupan por operación AND.
  • Los parámetros se pueden repetir como se indica a continuación: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] o property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
  • Las expresiones de propiedad tienen el formato [ !]field[op]value, con op in [==,!=,<=,>=,<,>,~], que admiten expresiones regulares.
 property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy Ordene los resultados por una propiedad específica. Si se agrega un - antes del nombre (orderby=-name), los elementos se ordenarán por nombre en orden descendente (Z-A). Las expresiones de ruta tienen la forma de rutas separadas por puntos. Este parámetro se puede repetir de esta manera: orderby=field1[,-fields2,field3,...] orderby=id,-name
limit Limite el número de ubicaciones devueltas. limit=5

Respuesta

Una respuesta correcta devuelve una lista de ofertas personalizadas que están presentes junto con las que tiene acceso a.

{
    "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"
        }
    }
}
Página anterior
Next page

En esta página