DocumentaciónJourney OptimizerGuía de Journey Optimizer

Enumerar colecciones list-collections

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Experimentado
  • Desarrollador

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 realizando una única solicitud de GET a la API Offer Library.

Formato de API

GET /{ENDPOINT_PATH}/offer-collections?{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/offer-collections?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 using-query-parameters

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

Paginación paging

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 están en el formato [ !]field[op]value, con op en [==,!=,<=,>=,<,>,~], que admite 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 entidades devueltas.
limit=5

Respuesta

Una respuesta correcta devuelve una lista de colecciones que están presentes dentro del contenedor al que tiene acceso.

{
    "results": [
        {
            "created": "2022-09-16T18:59:23.063+00:00",
            "modified": "2022-09-16T18:59:23.063+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerCollection1234",
            "name": "Test Collection with tags",
            "filterType": "any-tags",
            "ids": [
                "tag1234"
            ],
            "labels": [
                "core/C5",
                "custom/myLabel"
            ]
        },
        {
            "created": "2023-05-15T12:50:49.887+00:00",
            "modified": "2023-05-15T12:50:49.887+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerCollection5678",
            "name": "Test Collection with offers",
            "filterType": "offers",
            "ids": [
                "personalizedOffer1234",
                "personalizedOffer5678"
            ]
        }
    ],
    "count": 2,
    "total": 9,
    "_links": {
        "self": {
            "href": "/offer-collections?href={SELF_HREF}&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/offer-collections?href={NEXT_HREF}&limit=2",
            "type": "application/json"
        }
    }
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76