Bidding API

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 ID

The authentication is done using an authentication ID. Follow the below steps to generate it:

  1. Log into the ironSource dashboard.
  2. Click on your profile in the top right corner of the dashboard select ‘My Account’.
  3. Find your username under the ‘User info’ tab and your secret key under the ‘Reporting API’ tab.
  4. Encode the string username: secret_key in base64 format to retrieve your Authentication ID.
  5. In the header of each request add an Authorization header with the value Basic [my_authenticationID].

Get Bids

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

Method: Get

Endpoint: https://api.ironsrc.com/advertisers/v1/multibid

Parameters

Name Mandatory Data type Description
campaign_id 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/v1/multibid?campaign_id=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",
            "application_id": 2222,
            "bid": 0.18
        },       
        {
            "country": "CA",
            "application_id": 1212,
            "bid": 0.35
        }
    ]
   "paging":{
         "next":"https://api.ironsrc.com/advertisers/v1/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/v1/multibid

Parameters

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

Request example

body:

{
    "campaign_id": 123456,
    "bids": [
        {
            "country": "AU",
            "bid": 0.8
        },
        {
            "country": "AU",
            "application_id": 3333,
            "bid": 1.5
        },
        {
            "country": "AU",
            "application_id": 1234,
            "bid": 2
        }
    ]
}
  • For all application in AU the bid will be $0.8, except for app_id 3333 that will be $1.5, and app_id 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/v1/multibid

Parameters

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

Request example

body:

{
    "campaign_id": 123456,
    "bids": [
        {
            "country": "AU"
        },
        {
            "country": "AU",
            "application_id": 1234
        }
    ]
}