Una oferta personalizada es un mensaje de marketing personalizable basado en reglas de elegibilidad y restricciones.
Puede crear una oferta personalizada realizando una solicitud de POST a Offer Library API, al tiempo que proporciona su ID de contenedor.
La siguiente tabla muestra los valores válidos que componen la variable Content-Type y Aceptar campos en el encabezado de la solicitud:
Nombre del encabezado | Valor |
---|---|
Accept | application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1 |
Content-Type | application/schema-instance+json; version=1; schema="https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5" |
Formato de API
POST /{ENDPOINT_PATH}/{CONTAINER_ID}/instances
Parámetro | Descripción | Ejemplo |
---|---|---|
{ENDPOINT_PATH} |
Ruta de extremo para las API del repositorio. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
El contenedor donde se encuentran las ofertas personalizadas. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
Solicitud
curl -X POST \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances' \
-H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
-H 'Content-Type: application/schema-instance+json; version=1; schema="https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"' \
-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}' \
-d '{
"xdm:name": "Sale offer",
"xdm:status": "draft",
"xdm:representations": [
{
"xdm:components": [
{
"dc:language": [
"en"
],
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
"dc:format": "text/html"
}
],
"xdm:placement": "xcore:offer-placement:124e0be5699743d3"
}
],
"xdm:selectionConstraint": {
"xdm:startDate": "2020-10-01T16:00:00Z",
"xdm:endDate": "2021-12-13T16:00:00Z",
"xdm:eligibilityRule": "xcore:eligibility-rule:124e0faf5b8ee89b"
},
"xdm:rank": {
"xdm:priority": 1
},
"xdm:cappingConstraint": {
"xdm:globalCap": 150
},
"xdm:tags": [
"xcore:tag:124e147572cd7866"
]
}'
Respuesta
Una respuesta correcta devuelve información sobre la oferta personalizada recién creada, incluido su ID de instancia y ubicación únicos @id
. Puede utilizar el ID de instancia en pasos posteriores para actualizar o eliminar la oferta personalizada.
{
"instanceId": "0f4bc230-13df-11eb-bc55-c11be7252432",
"@id": "xcore:personalized-offer:124e181c8b0d7878",
"repo:etag": 1,
"repo:createdDate": "2020-10-21T20:50:32.018624Z",
"repo:lastModifiedDate": "2020-10-21T20:50:32.018624Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}
Actualmente, las representaciones de oferta y algunas restricciones de oferta no son compatibles con Mobile Experience Edge flujos de trabajo, por ejemplo Capping
. El Capping
el valor del campo especifica el número de veces que se puede presentar una oferta entre todos los usuarios. Para obtener más información, consulte Documentación de restricciones y reglas de idoneidad de ofertas.