Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

Creating a Bid Modifier

(Fig. 1A) Modifier Rules

Each object within the modifer_rules array needs to contain the following keys:

KeyData TypeRequiredExamples
source_typestringTrue"values", "list"
multiplierstringTrue"1.05" (5% increment), "0.95" (5% decrement)

modifier_rule_object

stringTrue*See Fig. 1B, "Modifier Rule Object" column
*Values Key Name*, which depends on the value for source_typevariesTrue*See Fig. 1B, "Values Key Name" column


(Fig. 1B) List of Modifier Rule Objects


if source_type =  "values"if source_type = "list"
Modifier Rule ObjectValues Key NameData TypeValues Key NameData Type
DeviceTypeuser_agent_devicesstring arrayN/AN/A
OperatingSystemuser_agent_operating_systemsstring arrayN/AN/A
DealIdListmodifier_rule_valuesstring arraydeal_id_list_idsinteger
PublisherIdListmodifier_rule_valuesstring arraypublisher_id_list_idsinteger
DomainListmodifier_rule_valuesstring arraydomain_list_idsinteger
AppBundleListmodifier_rule_valuesstring arrayapp_bundle_list_idsinteger
AppNameListmodifier_rule_valuesstring arrayapp_name_list_idsinteger
Countrycountry_codesstring arraycountry_list_idsinteger
Dmadma_codesstring arraydma_list_idsinteger
Statestate_codesstring arraystate_list_idsinteger
Citycity_codesstring arraycity_list_idsinteger
PostalCodepostal_codesstring arraypostal_code_list_idsinteger

REST API

Method: POST

Endpoint: /api/v0/bid_modifiers

FieldsWhat can be included in the request body:

Field
KeyData TypeRequiredNotes
namestringTrueModifier title
descriptionstringFalseAdd your own description
activeboolFalseDefault = true
modifier_rulesobject arrayTrueAt least one rule object required in array, see Fig. 1A


Headers

Code Block
languagebash
themeRDark
Content-Type application/json
Authorization "yourAuthToken"

...