RTB API

Using merchenta.io for real-time bidding

Site targeting campaign 

Using the RTB API, we can select specific sites to run campaigns against. For this to work, we will need to specify transparent inventory (otherwise we don’t see the site name) as well as a list of one or more sites to target. In this example, we’re going to target 3 sites - google.com, yahoo.co.uk and ebay.co.uk - with a daily budget and a frequency cap of 12 ads per consumer per day.

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"
            }
        }

Upload creative file 

/v3/creatives/upload/push
  • Curl
  • Copy
    curl -i \ -X POST \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ -F creative=@[YOUR_FILENAME_HERE] \ https://sandbox.rtbapi.io/v3/creatives/upload/push
  • Request
  • Headers
    Authorization: Bearer {YOUR_TOKEN_HERE}
    Content-Type: multipart/form-data
    Content-Disposition: form-data; name="creative"; filename="[YOUR_FILENAME_HERE]"
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success",
            "data": {
                "id": "MERCHENTA-b021a5e27751d90f56803375d4329d9a33e72bad.jpg",
                "location": "https://cdn3.merchenta.com/static/assets/MERCHENTA-b021a5e27751d90f56803375d4329d9a33e72bad.jpg"
            }
        }

Create site targeting ad campaign 

/v3/campaigns/{ADVERTISER_CODE}-site

Campaign with:

  • no geo-targeting settings, but site white list for sites:
    • google.com
    • yahoo.co.uk
    • ebay.co.uk
  • transparent inventory
  • all ad placement types
  • frequency cap of 12 ads/day
  • budget of $20/daily
  • Curl
  • Copy
    curl -i \ -X PUT \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ -H 'Content-Type: application/json' \ -d '{ "creatives":[ { "code":"{ADVERTISER_CODE}-site", "creativeId":"MERCHENTA-afed737deeedbc6e21f3b2148c9f2865cbdba68b.jpg", "dimensions":{ "width":728, "height":90 }, "clickthroughUrl":"http://merchenta.com", "type":"IMAGE" }, { "code":"{ADVERTISER_CODE}-site", "creativeId":"MERCHENTA-b021a5e27751d90f56803375d4329d9a33e72bad.jpg", "dimensions":{ "width":300, "height":250 }, "clickthroughUrl":"http://merchenta.com", "type":"IMAGE" } ], "inventorySettings":{ "inventoryType":"TRANSPARENT", "placementType":[ "ATF", "BTF", "UNKNOWN" ], "exchangeBlockList": ["GD", "BS"], "publisherWhiteList": [ "google.com", "yahoo.co.uk", "ebay.co.uk" ] }, "biddingSettings":{ "frequencyCap" : 12, "biddingStrategy":{ "strategy":"CPMCappedBiddingStrategy", "maxBid":2 }, "budget":{ "daily":20 }, "pacingType":"ACCELERATED" } }' \ https://sandbox.rtbapi.io/v3/campaigns/{ADVERTISER_CODE}-site
  • Request
  • Headers
    Authorization: Bearer {YOUR_TOKEN_HERE}
    Content-Type: application/json
    Example body
    {
        "creatives":[
            {
                "code":"{ADVERTISER_CODE}-site",
                "creativeId":"MERCHENTA-afed737deeedbc6e21f3b2148c9f2865cbdba68b.jpg",
                "dimensions":{
                    "width":728,
                    "height":90
                },
                "clickthroughUrl":"http://merchenta.com",
                "type":"IMAGE"
            },
            {
                "code":"{ADVERTISER_CODE}-site",
                "creativeId":"MERCHENTA-b021a5e27751d90f56803375d4329d9a33e72bad.jpg",
                "dimensions":{
                    "width":300,
                    "height":250
                },
                "clickthroughUrl":"http://merchenta.com",
                "type":"IMAGE"
            }
        ],
        "inventorySettings":{
            "inventoryType":"TRANSPARENT",
            "placementType":[
                "ATF",
                "BTF",
                "UNKNOWN"
            ],
            "exchangeBlockList": ["GD", "BS"],
            "publisherWhiteList": [
                "google.com",
                "yahoo.co.uk",
                "ebay.co.uk"
            ]
        },
        "biddingSettings":{
            "frequencyCap" : 12,
            "biddingStrategy":{
                "strategy":"CPMCappedBiddingStrategy",
                "maxBid":2
            },
            "budget":{
                "daily":20
            },
            "pacingType":"ACCELERATED"
        }
    }
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
            "status": "success"
        }
Next page  Previous page