Ad Response
AD RESPONSE & TRACKING AD EVENTS 1 - Ad Response
The Ad response contains data of maximum 02 ads. The first ad has higher priority and is expected to be displayed. In case that any product of this ad is out of stock, the second ad (back-up ad) will be displayed instead.
Each ad contains an array named “products” which has data of 03 products, and array named “properties” which has data of the advertising brand.
You can see an ad response example by clicking here. Description for important data in ad response:
Param | Description | Sample Data |
data.admp.products | Contains advertising products information used for ad rendering, and urls to call for brand ad tracking | |
sku | Sku of advertising product | |
product_id | Id of advertising product | |
clickUrl | Contains the url to call when trigger a click log. (mobile app only) after calling this url, client will receive a response which contains “click_bc” (a unique identifier used to collect shopper’s activities data after clicking the ad). This data should be saved in local device storage and inserted in ANTS Analytics “click_bc” param | { "click_bc": "10487538601-1572232924", } |
data.admp.ad.properties | Contains advertising brand information used for ad rendering, and urls to call for brand ad tracking | |
headline | Content for headline text to be displayed | |
logo | Link to image to be displayed as brand logo | |
brand_name | Content for brand name text to be displayed | |
impUrl | Contains the url to call when trigger an impression log | |
trueImpUrl | Contains the url to call when trigger a viewable impression log | |
clickUrl | Contains the url to call when trigger a click log. (mobile app only) after calling this url, client will receive a response which contains “click_bc” (a unique identifier used to collect shopper’s activities data after clicking the ad). This data should be saved in local device storage and inserted in ANTS Analytics “click_bc” param | { "click_bc": "10487538601-1572232924", } |
2 - Tracking Impression
Ad Impression: Trigger when the ad is completely rendered. Call to the url in “impUrl” of array “properties”.
3 - Tracking Viewable Impression
Ad Viewable Impression: Trigger at the same time with Ad Impression (as this ad zone is placed on top of the page/screen, so it’s automatically viewable). Call to the url in “trueImpUrl” of array “properties”.
4 - Tracking Click
Ad Click: Trigger when a shopper click on any area OTHER THAN three products of the ad. Trigger when a shoppers click on any product of the ad. Call to the urls in “clickUrl” of array “properties”.
Product Click: Trigger when a shopper click on any product of the ad. Call to the urls in “clickUrl” of array “products”.
Last updated