View Campaign targeting

GET /targeting
Copied
Arrow
                https://api.ocamba.com/api/v1/adex/targeting

Retrieves the details of a Campaign targeting that has previously been created if a valid identifier was provided

query Parameters
Arrow
Name
Description
campaign_idintegerrequired
Unique campaign identifier.


Example: campaign_id=1234142
Response status codes
Arrow
200 - OK
Arrow
Name
Description
targetingtargeting

Campaign Targeting
Name
Description
browserobject
Browser object.
Name
Description
idnumber
Browser id supported by the Ocamba platform.


Example: 12
opstring



Example: exact

Possible values: exact | min_version

Default: exact
versionarray
Array of browser versions supported by the Ocamba platform.


Example: 78
categoryobject
Category object.
Name
Description
itemarray
Array of category codes supported by the Ocamba platform, max 100 items.


Example: IAB1,IAB1-1,IAB1-2
listarray
Array of list ids, created on the Ocamba platform, max 10 items.


Example: 1231,3213
opstring



Example: include

Possible values: include | exclude

Default: include
connectionobject
Connection object.
Name
Description
itemarray
Array of connection ids supported by Ocamba platform. Supported connection: * Unknown (id 0) * Ethernet (id 1) * Wi-Fi (id 2) * Cellular Network – Unknown Generation (id 3) * Cellular Network – 2G (id 4) * Cellular Network – 3G (id 5) * Cellular Network – 4G (id 6)


Example: 0,1,2

Possible values: 0 | 1 | 2 | 3 | 4 | 5 | 6
opstring



Example: include

Possible values: include | exclude

Default: include
containersobject
Container object.
Name
Description
item[ string ]
Array of containers ids, maximum number of items depends on a purchased plan.
opstring



Example: include

Possible values: include | exclude

Default: include
countryobject
Country object.
Name
Description
itemarray
Array of country codes supported by the Ocamba platform (ISO 3166-1, 2 letter country codes), max 250 items.


Example: RS,US,JP
listarray
Array of list ids, created on the Ocamba platform, max 10 items.


Example: 12,131
opstring



Example: include

Possible values: include | exclude

Default: include
device_manufacturerobject
Device object.
Name
Description
itemarray
Array of devices ids supported by the Ocamba platform, max 100 items.


Example: 5,4,2
opstring



Example: include

Possible values: include | exclude

Default: include
device_trackingobject
Device tracking object.
Name
Description
is_turned_onnumber
Describes a status of device tracking.

Possible values: 0 | 1
device_typeobject
Device type object.
Name
Description
itemarray
Array of device types supported by the Ocamba platform (mobile/desktop).


Example: mobile
opstring



Example: include

Possible values: include | exclude

Default: include
has_user_dataobject
Has user data object.
Name
Description
is_turned_onnumber
Describes a status of user data.

Possible values: 0 | 1
ipobject
Ip object.
Name
Description
itemarray
Array of IPs, max 100 items. Each element must be a valid ipv4, ipv6 or a cidr format for both v4 and v6.


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
listarray
Array of list ids, created on the Ocamba platform, max 10 items.


Example: 193
opstring



Example: include

Possible values: include | exclude

Default: include
languageobject
Languages object
Name
Description
item[ 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 the subscription plan.
opstring



Example: include

Possible values: include | exclude
osobject
Os object.
Name
Description
idnumber
Os id supported by the Ocamba platform.


Example: 12
opstring



Example: exact

Possible values: exact | min_version

Default: exact
versionarray
Array of os versions supported by the Ocamba platform.


Example: 1.5
publisherobject
Publisher object.
Name
Description
itemarray
Array of zone ids created on the Ocamba platform, max 100 items.


Example: 123413,6242163
opstring



Example: include

Possible values: include | exclude

Default: include
referrerobject
Referrer object.
Name
Description
itemarray
Array of domains, max 100 items.


Example: 4231,5341
listarray
Array of list ids, created on the Ocamba platform, max 10 items.


Example: 193
opstring



Example: include

Possible values: include | exclude

Default: include
subidobject
Subid object.
Name
Description
itemarray
Array of subids, max 100 items.


Example: fut_t10_18-24-MULTI_GG
listarray
Array of list ids, created on the Ocamba platform, max 10 items.


Example: 193
opstring



Example: include

Possible values: include | exclude

Default: include
subscribed_ageobject
User age object.
Name
Description
fromstring
Description for from.


Example: 10
time_unitstring
Description for time unit.


Example: day

Possible values: day | hour

Default: day
tostring
Description for to.


Example: 15
tagobject
Tag object.
Name
Description
item[ string ]
Array of tag ids, maximum number of items depends on a purchased plan. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring



Example: include

Possible values: include | exclude

Default: include
timeobject
Time object.
Name
Description
item[ string ]
Array of strings, max 7 unique items, where each item must be a valid cron expression.
opstring



Example: include

Possible values: include

Default: include
trafficobject
Traffic object.
Name
Description
itemarray
Array of traffic ids supported by the Ocamba platform. Supported connection: * RON (id 0) * IAS (id 1) * INJECTION (id 2) * TOSPV (id 3) * DoubleVerify (id 4) * Forensiq (id 5) * POP (id 6) * IN APP (id 8)


Example: 1,2,3

Possible values: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
opstring



Example: include

Possible values: include | exclude

Default: include
user_dataobject
User data object.
Name
Description
itemarray
Array of strings, max 100 items.
opstring



Example: include

Default: include
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
	"targeting": {
		"country": {
			"item": ["ES", "IL", "MN"],
			"list": ["1", "10", "431"],
			"op": "exclude"
		},
		"browser": [{
				"id": 12,
				"op": "exact",
				"version": ["74.0"],
				"webview_support": "1"
			},
			{
				"id": 17,
				"op": "exact",
				"version": ["40.0", "38.0"]
			}
		],
		"os": null,
		"traffic": {
			"item": ["2", "3", "7"],
			"op": "exclude"
		},
		"referrer": null,
		"publisher": null,
		"ip": null,
		"category": null,
		"connection": null,
		"device_tracking": {
			"is_turned_on": "1"
		},
		"subid": null,
		"device_manufacturer": null,
		"user_data": null,
		"has_user_data": null,
		"device_type": {
			"item": ["mobile"],
			"op": "include"
		},
		"time": {
			"item": ["0 10,11,12 * * 5,6","0 14 1 * *"],
			"op": "include"
		},
	}
}

{
  "targeting": {
    "country": {
      "item": "RS,US,JP",
      "list": "12,131",
      "op": "include"
    },
    "category": {
      "item": "IAB1,IAB1-1,IAB1-2",
      "list": "1231,3213",
      "op": "include"
    },
    "connection": {
      "item": "0,1,2",
      "op": "include"
    },
    "device_tracking": {},
    "device_manufacturer": {
      "item": "5,4,2",
      "op": "include"
    },
    "device_type": {
      "item": "mobile",
      "op": "include"
    },
    "ip": {
      "item": "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",
      "list": "193",
      "op": "include"
    },
    "referrer": {
      "item": "4231,5341",
      "list": "193",
      "op": "include"
    },
    "subid": {
      "item": "fut_t10_18-24-MULTI_GG",
      "list": "193",
      "op": "include"
    },
    "traffic": {
      "item": "1,2,3",
      "op": "include"
    },
    "browser": {
      "id": 12,
      "version": "78",
      "op": "exact"
    },
    "os": {
      "id": 12,
      "version": "1.5",
      "op": "exact"
    },
    "publisher": {
      "item": "123413,6242163",
      "op": "include"
    },
    "has_user_data": {},
    "user_data": {
      "op": "include"
    },
    "subscribed_age": {
      "time_unit": "day",
      "from": "10",
      "to": "15"
    },
    "time": {
      "item": [
        "0 14 1 * *"
      ],
      "op": "include"
    },
    "tag": {
      "item": [
        null
      ],
      "op": "include"
    },
    "containers": {
      "item": [
        null
      ],
      "op": "include"
    },
    "language": {
      "item": [
        "sr"
      ],
      "op": "include"
    }
  }
}