Advanced Bidding

Settings

Fetch data on an existing advanced bidding ad unit, enable/disable an ad unit for advanced bidding, or make updates to an ad unit’s advanced bidding settings.

JSON Representation

{
    "data": {
        "adUnitKey": "string",
        "priority": "num",
        "marketplace": "JSON",
        "networks": "JSON"
    }
}

Marketplace JSON

{
    "enabled": "boolean",
    "allowVideo": "string",
    "videoSetting": "string",
    "rewardedSettings": "string"
}

Networks JSON

[{
    "enabled": "boolean",
    "networkType": "string",
    "overrideFields": "JSON"
},
{
    "enabled": "boolean",
    "networkType": "string",
    "overrideFields": "JSON"
}]

Field Definitions

Name Description Required for Post (Create)
adUnitKey Key of the ad unit you want to edit the Advanced Bidding Settings for. yes
priority Advanced bidding will compete with everything at and below the priority you set it at. yes
marketplace (JSON) Used to enable/disable Mopub Marketplace and configure video settings. no
networks (JSON) Used to enable/disable Advanced Bidding Networks and configure the network ids. no

GET (Read)

https://api.mopub.com/v1/advanced-bidding-settings/ : returns the settings for all of the ad units that have been enbled for Advanced Bidding

https://api.mopub.com/v1/advanced-bidding-settings?[FILTER]: see supported filters below

‘https://api.mopub.com/v1/advanced-bidding-settings/[key]’: uses an explicit object ID

Filters

If no filter is used, then all objects are returned in a list format. If the filter matches multiple objects, then a list format is returned.

Support filters:

  • adUnitKey
  • name (not case-sensitive)

PUT (Update)

Usage Details The operation described here, ‘set’, will just take a dictionary in as “data” and update the object with the settings of that dictionary.

  • Uses http PUT method
  • Request body is json format (not form-data)
  • The response is the modified object

Supported Fields

  • priority
  • marketplace (JSON)
  • networks (JSON)

Example

https://api-staging.mopub.com/v1/advanced-bidding-settings/5197a8e32adc47a8beb08e3dd87c22ww

{
    "op": "set",
    "data": {
        "marketplace":
                    {
                        "enabled": "enabled",
                        "allowVideo": "true",
                        "videoSetting": "both",
                        "rewardedSettings": "string"
                    }
    }
}

Price Rules

Create a new advanced bidding price floor, fetch data or update an existing price floor by making a request to the following URL:

Disclaimer: This is a limited feature that is not generally available.

JSON Representation

{
    "key": "string",
    "enabled": "boolean",
    "name": "string",
    "priceFloor": "double",
    "targetedCountries": "list",
    "keywords": "list",
    "adUnits": "JSON"
}

Ad Units JSON

[
    {
        "appKey": "string",
        "appName": "string",
        "name": "string",
        "key": "string"
    }
]

GET (Read)

Returns all price rules: https://api.mopub.com/v1/price-rules/

Returns a subset of pricing rules based on the filter applied: https://api.mopub.com/v1/price-rules?name=zzzz

Returns the advanced bidding settings for the ad unit of the key provided: https://app.mopub.com/api/v1/price-rules/[Price-Rule-Key]

Filters

If no filter is used, then all objects are returned in a list format. If the filter matches multiple objects, then a list format is returned.

  • name
  • enabled
  • targeted_countries
  • keywords

Note: keys, targeted_countries, keywords are comma separated.

PUT (Update)

Usage Details

  • Use PUT to create price rules. https://api.mopub.com/v1/price-rules/
{
    "adUnitKey": "string",
    "name": "string",
    "priceFloor": "double",
    "targetedCountries": "list",
    "keywords": "list"
}

Last updated March 16, 2021

TWITTER, MOPUB, and the Bird logo are trademarks of Twitter, Inc. or its affiliates. All third party logos and trademarks included are the property of their respective owners.

© 2021 MoPub (a division of Twitter, Inc.)