{"_id":"5a8c9d4b50b7dd003d709488","project":"56c35c56c0c4630d004e864c","version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"category":{"_id":"56fd3956caad892200847bce","__v":0,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-31T14:51:02.977Z","from_sync":false,"order":1,"slug":"buzz-json-objects","title":"Buzz JSON Objects"},"user":"56c39c05bc41330d009f25d7","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-20T22:12:27.455Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"Like [Targeting Modules](doc:targeting), Buzz allows you to create lists of criteria for [Bid Modifiers](doc:bid-modifier-overview) according to various targeting modules and keys. For example, you can indicate that when the browser is `Safari` the bid should be multiplied by `1.5`. \n\nA list of valid keys and values can be found here: [List of Targeting Modules and Keys](doc:list-of-targeting-modules-and-keys) and can be retrieved dynamically by making a request to `/view?view_name=targeting_keys`.\n\nA list of Bid Modifier Terms is used as part of a POST or PUT to the [Bid Modifiers](doc:bid-modifier-overview) endpoint. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Bid Modifier Terms JSON\"\n}\n[/block]\nBid Modifier Terms are expressed as a JSON list of objects. Each object must contain the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"0-0\": \"`targeting_module`\",\n    \"1-0\": \"`targeting_key`\",\n    \"2-0\": \"`modifier_type`\",\n    \"3-0\": \"`value`\",\n    \"4-0\": \"`modifier`\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Notes\",\n    \"0-1\": \"The targeting module, e.g. `geo`\",\n    \"1-1\": \"The targeting key within the module, e.g. `country`\",\n    \"2-1\": \"The matching method for the modifier, default is `INCLUDE`\",\n    \"2-2\": \"See explanation below\",\n    \"3-1\": \"The value to match, e.g. `USA`\",\n    \"3-2\": \"Must always be a string, even if value is an integer or array\",\n    \"4-1\": \"Amount to multiply the bid\",\n    \"4-2\": \"Min=0 (don't bid)\\nMax = 10\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\nAn example of a Bid Modifier Term list is shown below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\n\\t\\t\\\"targeting_module\\\": \\\"geo\\\",\\n\\t\\t\\\"targeting_key\\\": \\\"country\\\",\\n\\t\\t\\\"value\\\": \\\"USA\\\",\\n\\t\\t\\\"modifier\\\": 0.8,\\n\\t\\t\\\"modifier_type\\\": \\\"include\\\"\\n\\t},\\n\\t{\\n\\t\\t\\\"targeting_module\\\": \\\"geo\\\",\\n\\t\\t\\\"targeting_key\\\": \\\"country\\\",\\n\\t\\t\\\"value\\\": \\\"CAN\\\",\\n\\t\\t\\\"modifier\\\": 2.3,\\n\\t\\t\\\"modifier_type\\\": \\\"include\\\"\\n\\t},\\n\\t{\\n\\t\\t\\\"targeting_module\\\": \\\"platform\\\",\\n\\t\\t\\\"targeting_key\\\": \\\"browser\\\",\\n\\t\\t\\\"value\\\": \\\"Safari\\\",\\n\\t\\t\\\"modifier\\\": 1.3,\\n\\t\\t\\\"modifier_type\\\": \\\"include\\\"\\n\\t}\\n]\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Modifier Types\"\n}\n[/block]\nThere are four `modifier_types` associated with any Bid Modifier Term. These types determine how the modifier is matched with a bid request. Note, although `exclude` is available as a targeting criteria, it is not allowed for bid modification since it would never match.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Modifier Type\",\n    \"h-1\": \"Matching Logic\",\n    \"h-2\": \"Notes\",\n    \"3-0\": \"dynamic\",\n    \"3-1\": \"The multiplier provided in the Bid Modifier Term is a default, the actual modifier is provided by the association of the user and the segment or the custom list item.\",\n    \"3-2\": \"Available for segment targeting as well as all [Custom Lists](doc:custom-lists)  types.\",\n    \"0-0\": \"include\",\n    \"0-1\": \"Targeting criteria much match the `value` field exactly.\",\n    \"0-2\": \"Default modifier type\",\n    \"1-0\": \"include_range\",\n    \"1-1\": \"Targeting criteria must be within range of values, for example a start and end time\",\n    \"1-2\": \"Only available on `time` and `ip_address` targeting modules.\",\n    \"2-0\": \"boolean\",\n    \"2-1\": \"The `value` field is passed as a string in a boolean expression\",\n    \"2-2\": \"Only available for segment targeting\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"bid-modifier-terms","type":"basic","title":"Bid Modifier Terms"}

Bid Modifier Terms


Like [Targeting Modules](doc:targeting), Buzz allows you to create lists of criteria for [Bid Modifiers](doc:bid-modifier-overview) according to various targeting modules and keys. For example, you can indicate that when the browser is `Safari` the bid should be multiplied by `1.5`. A list of valid keys and values can be found here: [List of Targeting Modules and Keys](doc:list-of-targeting-modules-and-keys) and can be retrieved dynamically by making a request to `/view?view_name=targeting_keys`. A list of Bid Modifier Terms is used as part of a POST or PUT to the [Bid Modifiers](doc:bid-modifier-overview) endpoint. [block:api-header] { "type": "basic", "title": "Bid Modifier Terms JSON" } [/block] Bid Modifier Terms are expressed as a JSON list of objects. Each object must contain the following fields: [block:parameters] { "data": { "h-0": "Field", "0-0": "`targeting_module`", "1-0": "`targeting_key`", "2-0": "`modifier_type`", "3-0": "`value`", "4-0": "`modifier`", "h-1": "Description", "h-2": "Notes", "0-1": "The targeting module, e.g. `geo`", "1-1": "The targeting key within the module, e.g. `country`", "2-1": "The matching method for the modifier, default is `INCLUDE`", "2-2": "See explanation below", "3-1": "The value to match, e.g. `USA`", "3-2": "Must always be a string, even if value is an integer or array", "4-1": "Amount to multiply the bid", "4-2": "Min=0 (don't bid)\nMax = 10" }, "cols": 3, "rows": 5 } [/block] An example of a Bid Modifier Term list is shown below: [block:code] { "codes": [ { "code": "[\n {\n\t\t\"targeting_module\": \"geo\",\n\t\t\"targeting_key\": \"country\",\n\t\t\"value\": \"USA\",\n\t\t\"modifier\": 0.8,\n\t\t\"modifier_type\": \"include\"\n\t},\n\t{\n\t\t\"targeting_module\": \"geo\",\n\t\t\"targeting_key\": \"country\",\n\t\t\"value\": \"CAN\",\n\t\t\"modifier\": 2.3,\n\t\t\"modifier_type\": \"include\"\n\t},\n\t{\n\t\t\"targeting_module\": \"platform\",\n\t\t\"targeting_key\": \"browser\",\n\t\t\"value\": \"Safari\",\n\t\t\"modifier\": 1.3,\n\t\t\"modifier_type\": \"include\"\n\t}\n]", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Modifier Types" } [/block] There are four `modifier_types` associated with any Bid Modifier Term. These types determine how the modifier is matched with a bid request. Note, although `exclude` is available as a targeting criteria, it is not allowed for bid modification since it would never match. [block:parameters] { "data": { "h-0": "Modifier Type", "h-1": "Matching Logic", "h-2": "Notes", "3-0": "dynamic", "3-1": "The multiplier provided in the Bid Modifier Term is a default, the actual modifier is provided by the association of the user and the segment or the custom list item.", "3-2": "Available for segment targeting as well as all [Custom Lists](doc:custom-lists) types.", "0-0": "include", "0-1": "Targeting criteria much match the `value` field exactly.", "0-2": "Default modifier type", "1-0": "include_range", "1-1": "Targeting criteria must be within range of values, for example a start and end time", "1-2": "Only available on `time` and `ip_address` targeting modules.", "2-0": "boolean", "2-1": "The `value` field is passed as a string in a boolean expression", "2-2": "Only available for segment targeting" }, "cols": 3, "rows": 4 } [/block]