RTB API

Using merchenta.io for real-time bidding

IntelliAd campaign 

Merchenta IntelliAds are our dynamic, behaviourally personalised ad format. They have been proven to deliver stronger conversion outcomes for eCommerce clients than traditional media types. Intelliads are available in Flash, Facebook and HTML5 variants.

This example shows a skeleton of how to setup a campaign using a Flash-based IntelliAd.

For further details of IntelliAds and how they can be used in retargeting and prospecting campaigns, please contact your Sales or your Account Manager.

Generate authentication token 

/v3/oauth/accessToken?username={username}&password={password}&advertiser={advertiser}
  • Parameters
  • username
    string (required) Example: username

    username

    password
    string (required) Example: password

    password

    advertiser
    string (required) Example: MERCHENTA

    advertiser code

  • Curl
  • Copy
    curl -i \ -X GET \ https://sandbox.rtbapi.io/v3/oauth/accessToken?username=username&password=password&advertiser=MERCHENTA
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhZHYiOiJNRVJDSEVOVEEiLCJleHAiOiIyMDE0LTEwLTA3VDEwOjIwOjEyLjQ4OSIsInJsbSI6IkFETUlOIiwidXNyIjoidGVzdEBtZXJjaGVudGEuY29tIiwiaWF0IjoiMjAxNC0xMC0wN1QwOToyMDoxMi40NTAifQ.7fb8007c49abb7e083f4aca024512ef3c9d32ea1ab0502d2603f4c2c92545b80"
            }
        }

Create Intelliad campaign 

/v3/campaigns/{ADVERTISER_CODE}-intelliad

Display campaign using an IntelliAd with:

  • an audience segment (retargeting) for segment ID: ‘uDVvnEvjqR’
  • transparent inventory
  • daily budget $100
  • all placement types: ATF/BTF/UNKNOWN
  • 1x IMU IntelliAd
  • Curl
  • Copy
    curl -i \ -X PUT \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ -H 'Content-Type: application/json' \ -d '{ "creatives":[ { "code":"{ADVERTISER_CODE}-intelliad-1", "creativeId":"intelliad11.swf", "dimensions":{ "width":728, "height":90 }, "clickthroughUrl":"http://merchenta.com", "type":"INTELLIAD", "intelliad": { "xml": "<structure> <productView></productView> <background></background> </structure>" } } ], "inventorySettings":{ "inventoryType":"TRANSPARENT", "placementType":[ "ATF", "BTF", "UNKNOWN" ], "exchangeBlockList": ["GD", "BS"] }, "biddingSettings":{ "biddingStrategy":{ "strategy":"CPMCappedBiddingStrategy", "maxBid":2 }, "budget":{ "daily":100 }, "pacingType":"ACCELERATED" }, "targetingSettings": { "retargetingSettings" : { "firstPartySegments": "uDVvnEvjqR" } }, "productSettings": { "recommendationStrategy": "RecentlyViewedProductsRecommenderStrategy" } }' \ https://sandbox.rtbapi.io/v3/campaigns/{ADVERTISER_CODE}-intelliad
  • Request
  • Headers
    Authorization: Bearer {YOUR_TOKEN_HERE}
    Content-Type: application/json
    Example body
    {
        "creatives":[
            {
                "code":"{ADVERTISER_CODE}-intelliad-1",
                "creativeId":"intelliad11.swf",
                "dimensions":{
                    "width":728,
                    "height":90
                },
                "clickthroughUrl":"http://merchenta.com",
                "type":"INTELLIAD",
                "intelliad": {
                    "xml": "<structure> <productView></productView> <background></background> </structure>"
                }
            }
        ],
        "inventorySettings":{
            "inventoryType":"TRANSPARENT",
            "placementType":[
                "ATF",
                "BTF",
                "UNKNOWN"
            ],
            "exchangeBlockList": ["GD", "BS"]
        },
        "biddingSettings":{
            "biddingStrategy":{
                "strategy":"CPMCappedBiddingStrategy",
                "maxBid":2
            },
            "budget":{
                "daily":100
            },
            "pacingType":"ACCELERATED"
        },
        "targetingSettings": {
            "retargetingSettings" : {
                "firstPartySegments": "uDVvnEvjqR"
            }
        },
        "productSettings": {
            "recommendationStrategy": "RecentlyViewedProductsRecommenderStrategy"
        }
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success"
        }
Next page  Previous page