Create Bid modifier

POST /bid-modifiers
Copied
Arrow
                https://api.ocamba.com/v2/adex/bid-modifiers

Creates a new Bid modifier object

Request Body Schema
Arrow
Name
Description
descriptionstring
Description of a bid modifier. Maximum of 2000 characters.


Example: My first bid modifier
ignore_bid_strategynumber (integer)required
Describes if strategy will be ignored or not. Possible values are 0 and 1.


Example: 1

Possible values: 0 | 1
max_valuefloat
Maximum value of the bid modifier. Minimum value is 0, maximum value is 100.


Example: 11.03
namestringrequired
Name of the bid modifier. Maximum of 100 characters.


Example: DemoBidModifiers
percent_valuefloatrequired
Percentage value of the bid modifier. Minimum value is -100, maximum value is 1000.


Example: 12.55
pricing_modelstringrequired
Assigning the wanted pricing model to bid modifier. Can be one of cpc, cpm or cpc-cpm.


Example: cpc

Possible values: cpc | cpm | cpc-cpm
targetingbid-modifier-targetingrequired
Bid targeting object.
Bid Modifier Targeting
Name
Description
browsersobject

Name
Description
items[ object ]
Array of browser items, maximum length limited by subscription plan.
categoriesobject

Name
Description
items[ string ]
Array of strings containing category ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
containersobject

Name
Description
items[ string ]
Array of strings containing containers ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
countriesobject

Name
Description
items[ string ]
Array of strings containing 2 letter country codes. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
device_manufacturersobject

Name
Description
items[ string ]
Array of strings containing device manufacturer ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
device_trackingnumber (integer)
Is device tracking enabled. Possible values are 0 and 1.


Example: 1
device_typesobject

Name
Description
items[ string ]
Array of strings containing device types. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
has_user_datanumber (integer)
Is user data enabled. Possible values are 0 and 1.


Example: 1
ipobject

Name
Description
items[ string ]
Array of ips, each element must be a valid ipv4, ipv6 or cidr format for both v4 and v6, maximum length limited by subscription plan. Required if lists is not present.


Example: 123.523.123.4,123.523.123.4/12,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type ip, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
is_webviewnumber (integer)
Describes status of the webview. Possible values are 0 and 1.


Example: 1
languagesobject

Name
Description
items[ string ]
Array of unique strings. Each element must be a valid 2-letter language code supported by Ocamba platform, maximum number of items limited by subscription plan.
opstring



Example: in

Possible values: in
osobject

Name
Description
items[ object ]
Array of os items, maximum length limited by subscription plan.
pagesobject

Name
Description
items[ string ]
Array of strings, each element must be a valid url or hostname. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
regionsobject

Name
Description
items[ string ]
Array of strings containing region ids supported by Ocamba. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
subidsobject

Name
Description
items[ string ]
Array of strings containing subids. Subid must not contain whitespace (space, tab, newline, etc.). Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
tagsobject

Name
Description
items[ string ]
Array of strings containing tag ids. Maximum length limited by subscription plan. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring
String describing operation.


Example: in

Possible values: in
timeobject

Name
Description
items[ string ]
Array of strings containing time in format of cron expression. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
zonesobject

Name
Description
items[ string ]
Array of strings containing zone ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
valuefloatrequired
Value of the bid modifier. Minimum value is -100, maximum value is 100.


Example: 87.32
Response status codes
Arrow
201 - Created
Arrow

tip
1 Fields percent_value and value are mutually exclusive.
note
1 We recommend using containers instead of tags, as tags are deprecated. If both parameters are sent, containers will take priority.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "id": "100123",
  "name": "DemoBidModifiers",
  "description": "My first bid modifier",
  "pricing_model": "cpc",
  "ignore_bid_strategy": 1,
  "percent_value": 12.55,
  "value": 87.32,
  "max_value": 11.03,
  "targeting": {
    "countries": {
      "items": [
        "AF"
      ],
      "op": "in"
    },
    "regions": {
      "items": [
        "114223412"
      ],
      "op": "in"
    },
    "os": {
      "items": [
        {
          "id": "12"
        }
      ]
    },
    "browsers": {
      "items": [
        {
          "id": "10"
        }
      ]
    },
    "subids": {
      "items": [
        "sub_id"
      ],
      "op": "in"
    },
    "categories": {
      "items": [
        "IAB1"
      ],
      "op": "in"
    },
    "containers": {
      "items": [
        "1010"
      ],
      "op": "in"
    },
    "ip": {
      "items": [
        "192.168.0.1"
      ],
      "op": "in"
    },
    "zones": {
      "items": [
        "1003444"
      ],
      "op": "in"
    },
    "pages": {
      "items": [
        "google.com"
      ],
      "op": "in"
    },
    "device_types": {
      "items": [
        "mobile"
      ],
      "op": "in"
    },
    "device_manufacturers": {
      "items": [
        "4"
      ],
      "op": "in"
    },
    "time": {
      "items": [
        "12,13 * 2,3,4 * 0,4,5"
      ],
      "op": "in"
    },
    "languages": {
      "items": [
        "sr"
      ],
      "op": "in"
    },
    "device_tracking": 1,
    "is_webview": 1,
    "has_user_data": 1
  }
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "100123",
  "company_id": "2321414",
  "name": "DemoBidModifiers",
  "description": "My first bid modifier",
  "pricing_model": "cpc",
  "ignore_bid_strategy": 1,
  "percent_value": 12.55,
  "value": 87.32,
  "max_value": 11.03,
  "targeting": {
    "countries": {
      "items": [
        "AF"
      ],
      "op": "in"
    },
    "regions": {
      "items": [
        "114223412"
      ],
      "op": "in"
    },
    "os": {
      "items": [
        {
          "id": "12"
        }
      ]
    },
    "browsers": {
      "items": [
        {
          "id": "10"
        }
      ]
    },
    "subids": {
      "items": [
        "sub_id"
      ],
      "op": "in"
    },
    "categories": {
      "items": [
        "IAB1"
      ],
      "op": "in"
    },
    "containers": {
      "items": [
        "1010"
      ],
      "op": "in"
    },
    "ip": {
      "items": [
        "192.168.0.1"
      ],
      "op": "in"
    },
    "zones": {
      "items": [
        "1003444"
      ],
      "op": "in"
    },
    "pages": {
      "items": [
        "google.com"
      ],
      "op": "in"
    },
    "device_types": {
      "items": [
        "mobile"
      ],
      "op": "in"
    },
    "device_manufacturers": {
      "items": [
        "4"
      ],
      "op": "in"
    },
    "time": {
      "items": [
        "12,13 * 2,3,4 * 0,4,5"
      ],
      "op": "in"
    },
    "languages": {
      "items": [
        "sr"
      ],
      "op": "in"
    },
    "device_tracking": 1,
    "is_webview": 1,
    "has_user_data": 1,
    "create_time": "2023-07-04 07:12:47",
    "update_time": "2023-07-28 12:18:06"
  }
}