Bidding API v2

The Bidding API allows you to manage campaign bids for specific countries and applications. Each request gets or updates bids for a single campaign.

Bid Logic

  • The default campaign bid (set through the Campaign Generator) will take place when no specific Country or Country-Application bid was set.
  • The country bid will take place where no specific Country-Application bid was set.
  • Bids can be set with a maximum of 2 decimal points.
  • The minimum bid is $0.01.

Authentication

Bearer API authentication

Get Bids

Description: Get a list of bids for a single campaign.

Method: Get

Endpoint: https://api.ironsrc.com/advertisers/v2/multibid?

Parameters

Name Mandatory Data type Description
campaignId Yes Integer
count No Integer The maximum number of records to return in the response. The default is 10000

Request example
Get   https://api.ironsrc.com/advertisers/v2/multibid?campaignId=123456

Response

In case of additional data that exceeds the count parameter passed in the request, the response will contain a “next” link that will retrieve the next batch of records.

Response example

{
    "bids": [
        {
            "country": "US",
            "bid": 0.25
        },
        {
            "country": "US",
            "applicationId": 2222,
            "bid": 0.18
        },       
        {
            "country": "CA",
            "applicationId": 1212,
            "bid": 0.35
        }
    ]
   "paging":{
         "next":"https://api.ironsrc.com/advertisers/v2/multibid?campaign_id=123456&count=6000&cursur=oZSOyox"
 }
}

Insert/Update Bids

Description: Apply a list of bids per country and application for a single campaign.

Update bid logic

  • Define Country bid with only country and bid values
  • Define Country-Application bid with both country and application values 

Method: PUT

Endpoint: https://api.ironsrc.com/advertisers/v2/multibid?

Parameters

Name Mandatory Data type Description
campaignId Yes Integer
country Yes String ISO 3166 2-letter country code (e.g. GB)
applicationId No integer
bid Yes Decimal You can insert/update up to 10000 bids per request

Request example

body:

{
    "campaignId": 123456,
    "bids": [
        {
            "country": "AU",
            "bid": 0.8
        },
        {
            "country": "AU",
            "applicationId": 3333,
            "bid": 1.5
        },
        {
            "country": "AU",
            "applicationId": 1234,
            "bid": 2
        }
    ]
}
  • For all application in AU the bid will be $0.8, except for appId 3333 that will be $1.5, and appId 1234 that it will be $2.

Delete Bids

Description: Delete a list of bids per country or per country-application.

Deleting Country bid will set the country bid to be as the campaign default bid, and will not have an effect on Country-Application bids.

You can delete up to 10000 bids per request

Method: DELETE

Endpoint:https://api.ironsrc.com/advertisers/v2/multibid?

Parameters

Name Mandatory Data type Description
campaignId Yes Integer
country Yes String ISO 3166 2-letter country code (e.g. GB)
applicationId No integer

Request example

body:

{
    "campaignId": 123456,
    "bids": [
        {
            "country": "AU"
        },
        {
            "country": "AU",
            "applicationId": 1234
        }
    ]
}

 

Changes from V1

Authentication– changed to Bearer

Field names – change to camelCase

Old documentation – Bidding API v1 (OLD)