Carousel API

AI Tools

Overview

Davinci Commerce Programmable Personalization API supports carousel dynamic ad creation. Our omni channel capability ensures ad formats across multiple channels are supported: Video, Banners, Mobile, Social, Native.

Method Type

Description

GET

To get all the carousel cards for a particular campaign.

If the requested card is n, then there should be n default rows in the asset source. For example, if you are requesting four cards, then you should have minimum four default rows present in your asset source.

Parameters

Name

Data Type

Requirement

Parameter Type

Description

callback

string

Mandatory

--

pass the call back function name as value

ccards

number

Mandatory

path

cards is the number of carousel cards

Sample Implementation

The function call jvxAd.getCarousel(ccards, callback); will invoke the Get Carousel wrapper API function.

Sample Request

<script> function initiate() { jvxAd.getCarousel(2, 'myCallback') } function myCallback(resp) { console.log(resp); } </script>

Sample Response

{ "trackers": {}, "data": { "Carousel-Asset": [ { "Product_Image": "http://cdn.jivox.com/files/60344/Products Test/ClifBars.jpg", "_jvxRtnGroup": "rg1", "Product_Price": "$6", "_assetKey": "Product_6", "City": "Seattle", "_jvxRtnWeight": 0, "Rotation Group": "RG1" }, { "Product_Image": "http://cdn.jivox.com/files/60344/Products Test/ChickenBroth.jpg", "_jvxRtnGroup": "rg1", "Product_Price": "$5", "_assetKey": "Product_5", "City": "Seattle", "_jvxRtnWeight": 0, "Rotation Group": "RG1" } ] }, "reporting-key": "Product_6::Product_5", "selected-rule": "_Default_", "segment-name": "_Default_", "carousel-card": [ { "icon": "http://cdn.jivox.com/files/60344/Products Test/ClifBars.jpg", "card-reporting-key": "Product_6" }, { "icon": "http://cdn.jivox.com/files/60344/Products Test/ChickenBroth.jpg", "card-reporting-key": "Product_5" } ] }


Next to read:
Cloud Services
null
On This Page
Carousel APIOverviewGET Carousel