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 dentro de un contenedor realizando una única solicitud de GET a Offer Library API.
Formato de API
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_PERSONALIZED_OFFER}&{QUERY_PARAMS}
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 |
{SCHEMA_PERSONALIZED_OFFER} |
Define el esquema asociado a las ofertas personalizadas. | https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5 |
{QUERY_PARAMS} |
Parámetros de consulta opcionales por los que filtrar los resultados. | limit=1 |
Solicitud
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/personalized-offer;version=0.5&limit=1' \
-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}'
Puede utilizar parámetros de consulta para paginar y filtrar los resultados al enumerar recursos.
Los parámetros de consulta más comunes para la paginación incluyen:
Parámetro | Descripción | Ejemplo |
---|---|---|
q |
Una cadena de consulta opcional para buscar en los campos seleccionados. La cadena de consulta debe estar en minúsculas y puede estar rodeada de comillas dobles para evitar que se muestre con tokens y para que salga de los caracteres especiales. Los caracteres `+ - = && | |
qop |
Aplica el operador AND u OR a los valores del parámetro de cadena de consulta q. | AND / OR |
field |
Lista opcional de campos para limitar la búsqueda. Este parámetro se puede repetir como se indica a continuación: field=field1[,field=field2,…] y (las expresiones de ruta tienen la forma de rutas separadas por puntos, como _instance.xdm:name) | _instance.xdm:name |
orderBy |
Ordene los resultados por una propiedad específica. Adición de un - antes del título (orderby=-title ) ordenará los elementos por título en orden descendente (Z-A). |
-repo:createdDate |
limit |
Limite el número de ofertas personalizadas devueltas. | limit=5 |
Respuesta
Una respuesta correcta devuelve una lista de ofertas personalizadas que están presentes dentro del contenedor al que tiene acceso.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5",
"requestTime": "2020-10-22T20:36:50.408105Z",
"_embedded": {
"results": [
{
"instanceId": "2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"schemas": [
"https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2020-10-22T19:38:35.489354Z",
"repo:lastModifiedDate": "2020-10-22T19:45:43.839088Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "Checking Advanced",
"xdm:representations": [
{
"xdm:components": [
{
"dc:format": "image/png",
"repo:id": "urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51",
"repo:resolveURL": "https://platform-cs-va6.adobe.io/content/storage/id/urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51/:rendition;size=300",
"repo:name": "mobile-check-deposit.png",
"dc:language": [
"en-us"
],
"@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
"xdm:deliveryURL": ""
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/offline",
"xdm:placement": "xcore:offer-placement:124f4e33724bb15f"
},
{
"xdm:components": [
{
"dc:format": "text/html",
"repo:name": "my content",
"dc:language": [
"en-us"
],
"xdm:content": "{\n\"foo\": \"bar\"\n}",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:124e0be5699743d3"
}
],
"xdm:rank": {
"xdm:priority": 10
},
"xdm:characteristics": {
"PROD": "checking",
"offer_code": "CHECK200",
"region": "NA"
},
"xdm:selectionConstraint": {
"xdm:startDate": "2020-10-22T07:00:00.000Z",
"xdm:endDate": "2020-12-31T08:00:00.000Z",
"xdm:eligibilityRule": "xcore:eligibility-rule:124f4f57259caba5"
},
"xdm:status": "draft",
"xdm:cappingConstraint": {
"xdm:globalCap": 1000
},
"xdm:tags": [
"xcore:tag:124f4e5c8a00cd92",
"xcore:tag:1229cf47455177b1"
],
"@id": "xcore:personalized-offer:124f513c290bb16e"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5#2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"@type": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 15,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo:createdDate&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=1603395515489%2C2cdb4d10-149e-11eb-b1a9-a779d2fe8690&schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo%3AcreatedDate%2CinstanceId&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}