Bid Delivery Modifiers can be created, edited and viewed using the API. When you have created a Bid Modifier Delivery Modifier, you can use that list in the Settings > Bid > Delivery Modifiers section on a Demand Tag.
This feature is available for ClearLine account types.
Table of Contents
Creating a Delivery Modifier
(Fig. 1A) Modifier Rules
Each object within the modifer_rules array needs to contain the following keys:
...
...
modifier_rule_object
...
(Fig. 1B) List of Modifier Rule Objects
...
REST API
Method: POST
Endpoint: /api/v0/delivery_modifiers
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"id": 2,
"account_id": 10,
"name": "Delivery Modifier - Test",
"description": null,
"active": true,
"created_at": "2023-11-16T18:41:20.330Z",
"updated_at": "2023-11-16T18:41:20.330Z",
"modifier_rules": [
{
"id": 1702,
"source_type": "values",
"multiplier": "1.05",
"modifier_rule_object": "DealIdList",
"modifier_rule_values": [
"deal_id_1",
"deal_id_2"
]
}
]
} |
Creating a Delivery Modifier
(Fig. 1A) Modifier Rules
Each object within the modifer_rules array needs to contain the following keys:
| Key | Data Type | Required | Examples |
|---|---|---|---|
| source_type | string | True | "values", "list" |
| multiplier | string | True | "1.05" (5% increment), "0.95" (5% decrement) |
modifier_rule_object | string | True | *See Fig. 1B, "Modifier Rule Object" column |
| *Values Key Name*, which depends on the value for source_type | varies | True | *See Fig. 1B, "Values Key Name" column |
(Fig. 1B) List of Modifier Rule Objects
| if source_type = "values" | if source_type = "list" | |||
| Modifier Rule Object | Values Key Name | Data Type | Values Key Name | Data Type |
|---|---|---|---|---|
| DeviceType | user_agent_devices | string array | N/A | N/A |
| OperatingSystem | user_agent_operating_systems | string array | N/A | N/A |
| DealIdList | modifier_rule_values | string array | deal_id_list_ids | integer |
| PublisherIdList | modifier_rule_values | string array | publisher_id_list_ids | integer |
| DomainList | modifier_rule_values | string array | domain_list_ids | integer |
| AppBundleList | modifier_rule_values | string array | app_bundle_list_ids | integer |
| AppNameList | modifier_rule_values | string array | app_name_list_ids | integer |
| Country | country_codes | string array | country_list_ids | integer |
| Dma | dma_codes | string array | dma_list_ids | integer |
| State | state_codes | string array | state_list_ids | integer |
| City | city_codes | string array | city_list_ids | integer |
| PostalCode | postal_codes | string array | postal_code_list_ids | integer |
Get a Delivery Modifier
REST API
...