Use this API to create mediation groups. This API allows you to create multiple groups with a single API call. Use the “instances” parameter to determine each instance to include/exclude in a group. The instance ID value is reachable using the Instances API.
This API allows you to create multiple groups with a single API call.
The Group Id value is reachable using Get call to this API
The instance ID value is reachable using the Instances API.
The newly created group's name Length should be in range 1 to 32.
✓
Tier 1
adFormat
String
rewarded, interstitial, banner, native
✓
interstitial
mediationAdUnitId
String
ID of the ad unit to which the group belongs Mandatory if multiple ad units exist for the ad format
x
fgx25t56dq201bd2
position
Number
The position of group in the list of groups Should be between 1 to maximum groups at the list (except allCountries group)
✓
2
abTest
String
The AB test group it is related to. "A", "B"
x
B
floorPrice
Number
The minimum bid per impression, expressed as a CPM
x
15
countries
Array of String
An array of country codes which is defined by a 2 letter country code as per ISO 3166-1 Alpha-2. If not specified, the default will include allCountries
x
US, GB
segments
Array of String
An array of segments names
x
under30, femaleOnly
instances
Array
List of instances to update. If not specified, the default will include all instances configured to the ad format
x
These are the following instance fields in the ‘instances' array
id
Number
Instance ID as sent in LevelPlay Instances API
✓
124526
groupRate
Number
Used to prioritize the instance in your waterfall. Should be in the range 0.01-3000. Refer to Mediation management.
x
0.6
countriesRate
Array
List of country rate to update
x
These are the following countryRate fields in the ‘countriesRate' array
The newly created group's name Length should be in range 1 to 32
x
Speaking English
position
Number
The position of group in the list of groups Should be between 1 to maximum groups at the list (except allCountries group)
x
2
floorPrice
Number
The minimum bid per impression, expressed as CPM
x
15
countries
Array of String
An array of country codes which is defined by a 2 letter country code as per ISO 3166-1 Alpha-2. If not specified, the default will include allCountries
x
US, GB
segments
Array of String
An array of segment names
x
under30, femaleOnly
instances
Array
List of instances to update. If not specified, the default will include all instances configured to the ad format
x
These are the following instance fields in the ‘instances' array
id
Number
Instance ID as sent in LevelPlay Instances API
✓
123658
groupRate
Number
Used only to prioritize the instance in your waterfall. Should be in the range 0.01-3000. Refer to Mediation management.
x
0.6
countriesRate
Array
List of countryRate to update
x
These are the following countryRate fields in the ‘countriesRate' array
A successful response will be sent with HTTP code 200.
Errors
If one of the groups sent in the request is failing, an error array will be sent with HTTP code 400 and will cause the whole request to be rejected.Each error will be followed with an error message.
Example
{
"errorsArray": [
{
"code": ERR-208,
"errorMessage": "Group name value is required",
"params": {
"[0].groupName": ""
}
},
{
"code": ERR-311,
"errorMessage": "Group position value is not valid",
"params": {
"[0].position": ""
}
}
],
"code": 400
}