API: Managing Bids (Technical Overview)
You need to use your Mintegral token to manage your offers. For more details, please check Token.
Request address
https://ss-api.mintegral.com/api/open/v1/offer/bid_rate
Request method
PUT
Request example
PUT /api/open/v1/offer/bid_rate
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
// Normal Bidding (regardless of region, regardless of mtgid)
{
"offer_id": 123,
"bid_rate":3.2
}
// Bidding by region:
{
"offer_id": 123,
"bid_rate":3.2,
"bid_rate_by_location": [
{"country_code":"CN,AE","bid_rate":0.5},
{"country_code":"CN","bid_rate":0.6}
]
}
// Bidding by mtgid:
{
"offer_id": 123,
"bid_rate":3.2,
"bid_rate_by_mtgid": [
{"country_code":"CN,AE","bid_rate":0.5,"mtgid":"mtg123456"},
{"country_code":"CN","bid_rate":0.6,"mtgid":"mtg654321"}
]
}Request Parameter
| Fields | Type | Explanations | Default Value | Examples |
|---|---|---|---|---|
| offer_id | int | Unique id for offer | — | 123 |
bid_rate Optional |
float | Default bidding price value for all offer target geos and will apply only when no specific geo or application bid is set. Float with 3 decimal places greater than 0 is allowed. For CPE/CPI/CPM bid type, value must be greater than 0.01. For CPC bid type, value must be greater than 0.001. | — | 5.22 |
bid_rate_by_location Optional |
array<json> | Bidding price value for specific geos. Note:Please submit all geo that require bids, geos not in the request will be set as default bids. | — | If you want to cancel bids for specific geo, set this field empty, for example: bid_rate_by_location = [] |
| country_code | string | Targeted geos for bid setting. Targeting geo must be in offer geos. | — | "CN,US" |
| bid_rate | float | Bidding price value for specific geos. | — | 3.21 |
bid_rate_by_mtgid Optional |
array<json> | Bidding price value for specific publishers.Note: 1.It’s an advanced feature, if returns “permission denied”，please contact AM to get access. 2.If you want to cancel bids for specific publisher, set this field empty. 3. Please submit all mtgid that require bids, mtgids not in the request will be set as default bids. | — | If you want to cancel bids for specific publishers, set this field empty, for example: bid_rate_by_mtgid = [] |
| country_code | float | Targeted geos | — | "CN" |
| bid_rate | float | Bidding price value for specific publisher in specific geos | — | 3.21 |
| mtgid | float | Unique id for publisher | — | "mtg123456" |
Notes：
1 the precision for bid_rate is 0.001。
2 Minimum value of Bid rate is ralated to the bid_type.
> A) Offer’s bid type is in "CPI" or "CPE" or "CPM" ，minimum bid rate is 0.01
> B) Offer’s bid type is "CPC" ，minimum bid rate is 0.001。
3 bid_rate and bid_rate_by_location can’t be leave null at the same time.
4 You can change the value of bid_rate to update default price for offer
5 You can change the value of bid_rate_by_location to update price for specific area
6 if you need to delete price for specific area, just leave "bid_rate_by_location" as null, for example, bid_rate_by_location = [].
7 This api uses the full update method. When submitting bids by geo or mtgid, please submit the complete settings.
Response
| Fields | Type | Explanations |
|---|---|---|
| code | int | 200 code, is success. Others, are fail. |
| msg | string | If success, return to "success". If fail, return to detailed wrong info. |
| data | json | If success, return offer id. If fail, return to detailed wrong info. |
Response Example
{
"msg": "success",
"code": 200,
"data": {
"id": 123
}
}