{"_id":"56fd4425896b2c0e007160da","parentDoc":null,"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":2,"project":"56c35c56c0c4630d004e864c","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T15:37:09.669Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"Creative Attributes describe the [Creative](doc:creatives) object such as which [Advertiser](doc:advertisers) it belongs to, whether it is uses Flash, whether it has objectionable content, etc. These attributes are important because they are used by the ad server/bidder to better match creatives with available inventory. \n\nLike Targeting Modules, Buzz supports a flexible approach to defining Creative Attributes to be used in filtering valid creatives for a given impression. Creative Attributes are stored as JSON within the `creative_attributes` field of the Creative object. A list of valid Creative Attribute modules and keys is here: [List of Creative Attribute Modules and Keys](doc:list-of-creative-attribute-modules-and-keys).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Setting Creative Attributes\"\n}\n[/block]\nAs you read the Buzz documentation you may notice that many different objects include either `creative_attributes` or `attributes` fields, This is because Creative Attributes within the Creative object are actually set in many ways within Buzz, often without any direct setting by the API. The table below summarizes the ways in which Creative Attributes are set:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Object\",\n    \"h-1\": \"Effect on Attributes\",\n    \"0-0\": \"Advertiser\",\n    \"0-1\": \"The `attributes` field will be automatically inherited by the Creative object unless the same module/key combinations are explicitly set in the Creative. Used for attributes about the Advertiser such as the advertiser's homepage or their industry categorization.\",\n    \"1-0\": \"Creative\",\n    \"1-1\": \"Creative Attributes can be set manually on the Creative when submitted through the API.\",\n    \"2-0\": \"Creative Asset\",\n    \"2-1\": \"Several Creative Attributes will be automatically set within the Creative when associated with the asset. The attributes will vary depending on the rendering type of the Creative Template used. For example, if the template is set for VAST, the `video_mime` and `video_bit_rate` keys will be set, if the template is set for IMAGE, the `banner_mime` will be set.\",\n    \"3-0\": \"Creative Template\",\n    \"3-1\": \"The `creative_attributes` field from this object will be merged with the setting of the Creative. Useful for attributes about the rendering of the creative, such as VAST version or tag type.\",\n    \"4-0\": \"Video Asset\",\n    \"4-1\": \"When uploading a Video Asset the `video_encoding_profile` field is determined. This field will also determine creative attributes when the video is associated with a creative, typically for `bit_rate`.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"JSON Structure\"\n}\n[/block]\nThe Creative metadata JSON has the following fields:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Example value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"module_name\",\n    \"0-1\": \"`\\\"advertiser\\\": {\\\"key\\\": … }`\",\n    \"0-2\": \"The overall statement can include any number of modules, but each module may only appear once\",\n    \"2-0\": \"values\",\n    \"2-1\": \"`[1,2,3]`\",\n    \"2-2\": \"A list of values corresponding to the key.\",\n    \"1-0\": \"key\",\n    \"1-1\": \"`\\\"advertiser_index_id\\\": [ … ]`\",\n    \"1-2\": \"Keys are defined in the modules. For a list of modules and keys, see [List of Creative Attribute Modules and Keys](doc:list-of-creative-attribute-modules-and-keys).\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example JSON\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n \\\"advertiser\\\": {\\n\\t \\\"advertiser_category_id\\\": [6]\\n },\\n \\\"technical_attribute\\\": {\\n \\t\\\"ksize\\\": [6]\\n }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"creative-attributes","type":"basic","title":"Creative Attributes"}

Creative Attributes


Creative Attributes describe the [Creative](doc:creatives) object such as which [Advertiser](doc:advertisers) it belongs to, whether it is uses Flash, whether it has objectionable content, etc. These attributes are important because they are used by the ad server/bidder to better match creatives with available inventory. Like Targeting Modules, Buzz supports a flexible approach to defining Creative Attributes to be used in filtering valid creatives for a given impression. Creative Attributes are stored as JSON within the `creative_attributes` field of the Creative object. A list of valid Creative Attribute modules and keys is here: [List of Creative Attribute Modules and Keys](doc:list-of-creative-attribute-modules-and-keys). [block:api-header] { "type": "basic", "title": "Setting Creative Attributes" } [/block] As you read the Buzz documentation you may notice that many different objects include either `creative_attributes` or `attributes` fields, This is because Creative Attributes within the Creative object are actually set in many ways within Buzz, often without any direct setting by the API. The table below summarizes the ways in which Creative Attributes are set: [block:parameters] { "data": { "h-0": "Object", "h-1": "Effect on Attributes", "0-0": "Advertiser", "0-1": "The `attributes` field will be automatically inherited by the Creative object unless the same module/key combinations are explicitly set in the Creative. Used for attributes about the Advertiser such as the advertiser's homepage or their industry categorization.", "1-0": "Creative", "1-1": "Creative Attributes can be set manually on the Creative when submitted through the API.", "2-0": "Creative Asset", "2-1": "Several Creative Attributes will be automatically set within the Creative when associated with the asset. The attributes will vary depending on the rendering type of the Creative Template used. For example, if the template is set for VAST, the `video_mime` and `video_bit_rate` keys will be set, if the template is set for IMAGE, the `banner_mime` will be set.", "3-0": "Creative Template", "3-1": "The `creative_attributes` field from this object will be merged with the setting of the Creative. Useful for attributes about the rendering of the creative, such as VAST version or tag type.", "4-0": "Video Asset", "4-1": "When uploading a Video Asset the `video_encoding_profile` field is determined. This field will also determine creative attributes when the video is associated with a creative, typically for `bit_rate`." }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "JSON Structure" } [/block] The Creative metadata JSON has the following fields: [block:parameters] { "data": { "h-0": "Key", "h-1": "Example value", "h-2": "Description", "0-0": "module_name", "0-1": "`\"advertiser\": {\"key\": … }`", "0-2": "The overall statement can include any number of modules, but each module may only appear once", "2-0": "values", "2-1": "`[1,2,3]`", "2-2": "A list of values corresponding to the key.", "1-0": "key", "1-1": "`\"advertiser_index_id\": [ … ]`", "1-2": "Keys are defined in the modules. For a list of modules and keys, see [List of Creative Attribute Modules and Keys](doc:list-of-creative-attribute-modules-and-keys)." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Example JSON" } [/block] [block:code] { "codes": [ { "code": "{\n \"advertiser\": {\n\t \"advertiser_category_id\": [6]\n },\n \"technical_attribute\": {\n \t\"ksize\": [6]\n }\n}", "language": "json" } ] } [/block]