Las colecciones son subconjuntos de ofertas basados en condiciones predefinidas definidas definidas por un experto en marketing, como la categoría de la oferta.
Puede ver una lista de todas las colecciones dentro de un contenedor realizando una única solicitud de GET al Offer Library API.
Formato de API
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FILTER}&{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 colecciones. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_FILTER} |
Define el esquema asociado a las colecciones. | https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1 |
{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/offer-filter;version=0.1&limit=2' \
-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 |
Limitar el número de colecciones devueltas. | limit=5 |
Respuesta
Una respuesta correcta devuelve una lista de colecciones 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/offer-filter;version=0.1",
"requestTime": "2020-10-21T21:14:19.282175Z",
"_embedded": {
"results": [
{
"instanceId": "27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-10-20T02:37:11.263718Z",
"repo:lastModifiedDate": "2020-10-20T02:37:11.263718Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:ids": [
"xcore:tag:124bd3de7f598dd8"
],
"xdm:name": "Mobile Demo",
"xdm:filterType": "anyTags",
"@id": "xcore:offer-filter:124bd44648f17ec1"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/27c92e00-127d-11eb-b9fe-5bcfb5d7ef36",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
},
{
"instanceId": "2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-09-17T14:36:29.272451Z",
"repo:lastModifiedDate": "2020-09-17T14:36:29.272451Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:ids": [
"xcore:personalized-offer:1221fbedfa4d98b0"
],
"xdm:name": "demo collection",
"xdm:filterType": "offers",
"@id": "xcore:offer-filter:1221fc71c74d98b4"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3#2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1",
"@type": "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.3"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 8,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=2c54fc90-f8f3-11ea-ad6e-775ad2c9b1a1&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/offer-filter;version=0.1&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}