View Bid modifier

GET /bid-modifiers/{id}
Copied
Arrow
                https://api.ocamba.com/v2/adex/bid-modifiers/{id}

Retrieves the details of a Bid modfier that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-09-29 15:40:10
descriptionstring
Description of a bid modifier. Maximum of 2000 characters.


Example: My first bid modifier
idstring
A unique identifier generated by the Ocamba platform.


Example: 12344
ignore_bid_strategynumber (integer)
Describes if strategy will be ignored or not. Possible values are 0 and 1.


Example: 1

Possible values: 0 | 1
is_defaultnumber (integer)
Specifying default status of bid modifier.

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


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


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


Example: 12.55
pricing_modelstring
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-targeting
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
update_timedateTime
Timezone: GMT.


Example: 2021-11-21 12:33:51
valuefloat
Value of the bid modifier. Minimum value is -100, maximum value is 100.


Example: 87.32
tip
1 If you don't know the bid modifier id, list the bid modifiers to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "id": "12344",
  "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"
    },
    "tags": {
      "items": [
        "1010"
      ],
      "op": "in"
    },
    "containers": {
      "items": [
        "1020"
      ],
      "op": "in"
    },
    "ip": {
      "items": [
        null
      ],
      "lists": [
        "2691"
      ],
      "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"
    },
    "has_user_data": 1,
    "device_tracking": 1,
    "is_webview": 1
  },
  "create_time": "2021-09-29 15:40:10",
  "update_time": "2021-11-21 12:33:51"
}