List Bid modifiers

Copied

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

Returns a list of Bid modifiers

query Parameters

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

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/adex/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/adex/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/adex/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

max_valuefloat

Maximum value of the bid modifier.

Example: max_value=1.00

is_defaultnumber (integer)

Specifying default status of bid modifier.

Example: is_default=1

pricing_modelstring

Assigning the wanted pricing model to bid modifier.

Example: pricing_model=cpc

Response status codes

200 - OK

Name

Description

items[ bid-modifiers ]

An array of all created items.

Bid Modifier

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

Browsers object

Name

Description

items[ object ]

Array of browser items, maximum length limited by subscription plan.

categoriesobject

Categories object

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

Containers object.

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

Countries object

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

Device manufacturers object

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

Device types object

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

Ip object.

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

Languages object

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

Os object

Name

Description

items[ object ]

Array of os items, maximum length limited by subscription plan.

pagesobject

Pages object

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

Regions object

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

Subids object

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

Tags object

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

Time object

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

Zones object

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

totalinteger

A total number of items.

Example: 92

tip

1 Searchable fields are name and id.

2 Sortable fields are: name, max_value, is_default, create_time and pricing_model.

3 Filterable fields are: id, name, pricing_model, value, percent_value, max_value, is_default, create_time and update_time.

Response examples

Copied

200

{
  "total": 92,
  "items": [
    {
      "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"
    }
  ]
}

List Bid modifiers

GET /bid-modifiersCopied https://api.ocamba.com/v2/adex/bid-modifiers

GET /bid-modifiers
Copied
`https://api.ocamba.com/v2/adex/bid-modifiers`