Rankings by UI section

In the future, Cardlytics plans to provide support for ranking ads by shopping category. When supported, these
section-specific ad rankings will be returned as a Map titled "sections".

{
    "all": ["adId-123", "adId-456"],
    "sections": {
        "Landing": {
            "all": ["adId-234"]
        },
        "Summary": {
            "all": ["adId-789"]
        }
    }
}

In the example above, there are two Section rankings titled "Landing" and "Summary", so the "sections" Map is populated with these two keys.

Each of these "sections" Map entries will include, at minimum, a catch-all "all" property containing adIds that are deemed to be relevant to their respective section.

The semantics here are similar to that of the top-level Ad Rankings response, which also contains at minimum an "all"property.

Rankings by Ad category

Support for ranking ads by shopping category works like this:

For example, a customer was targeted for ads ranked within a newly-supported Grocery category with a ranking
ID of "grocery". This is an attractive ad category is intended to be promoted in UI sections with maximum visibility to drive a lot of engagement. In this hypothetical case, the response would look something like this:

{
    "all": ["adId-123", "adId-456", "adId-789"],
    "categories": {
        "grocery": ["adId-456"]
    },
    "sections": {
        "Landing": {
            "all": ["adId-234", "adId-456"],
            "categories": {
                "grocery": ["adId-456"]
            }
        },
        "Summary": {
            "all": ["adId-789"]
        }
    }
}

Note that the Grocery category in this example is also included in the top-level rankings object for convenience, so that it may be referenced anywhere regardless of UI placement.