{"_id":"56fd5ef0d393740e0080f2c9","project":"56c35c56c0c4630d004e864c","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"},"parentDoc":null,"user":"56c39c05bc41330d009f25d7","githubsync":"","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"},"__v":5,"updates":["5981af7e9fce1d0020866815"],"next":{"pages":[],"description":""},"createdAt":"2016-03-31T17:31:28.673Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"This document summarizes the existing Buzz [Creative Attribute](doc:creative-attributes) modules and keys.\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Module\",\n    \"h-1\": \"Key\",\n    \"h-2\": \"Input Example\",\n    \"h-3\": \"Notes\",\n    \"0-0\": \"advertiser\",\n    \"1-1\": \"advertiser_category\",\n    \"2-1\": \"advertiser_index_id\",\n    \"3-1\": \"advertiser_domain\",\n    \"5-0\": \"approval\",\n    \"6-1\": \"inventory_source\",\n    \"7-1\": \"creative_technology_vendor\",\n    \"8-0\": \"mobile\",\n    \"9-0\": \"technical\",\n    \"10-1\": \"expandable_type\",\n    \"11-1\": \"expandable_direction\",\n    \"12-1\": \"ksize\",\n    \"13-1\": \"tag_type\",\n    \"14-0\": \"video\",\n    \"16-1\": \"video_autoplay\",\n    \"17-1\": \"video_duration\",\n    \"18-1\": \"video_mime\",\n    \"19-1\": \"video_protocol\",\n    \"20-1\": \"video_bit_rate\",\n    \"21-1\": \"video_api\",\n    \"22-1\": \"video_companion_type\",\n    \"23-1\": \"video_companion_size\",\n    \"0-1\": \"advertiser_app_bundle\",\n    \"0-2\": \"`\\\"advertiser_app_bundle\\\":[\\\"my.app.for.my.watch\\\"]`\",\n    \"0-3\": \"String representation of cross-OS app bundle ID. Some ad exchanges require any ad advertising another app to declare the app bundle of the advertised app.\",\n    \"1-2\": \"`\\\"advertiser_category\\\":[\\\"IAB1\\\",\\\"IAB1_1\\\"]`\",\n    \"1-3\": \"Canonical list of categories based on the IAB's content categories.\",\n    \"2-2\": \"`\\\"advertiser_index_id\\\":[1143]`\",\n    \"2-3\": \"Canonical list of unique Advertisers based on Google's master list. Every Creative should belong to one and only one Advertiser.\",\n    \"3-2\": \"`\\\"advertiser_domain\\\":[\\\"foo.com\\\"]`\",\n    \"3-3\": \"Top-level domain of the Advertiser without any path information. Required on most exchanges.\",\n    \"5-2\": \"`\\\"vendor_id\\\":[1,2]`\",\n    \"5-1\": \"vendor_id\",\n    \"5-3\": \"List of optional [Creative Approval Queue](doc:creative-approval-queue) vendors for Creative to be submitted. Note, these vendors are distinct from the `creative_technology_vendors` below, which are just declarations of which technologies are used in the creative.\",\n    \"6-2\": \"\",\n    \"6-3\": \"DEPRECATED. Approvals for inventory are now stored in the `creative_approvals` field of the `Creative` object.\",\n    \"7-2\": \"`\\\"creative_technology_vendor\\\":[1,2,3]`\",\n    \"7-3\": \"List of technologies used by the Creative, based on Google's list. Beeswax is #632.\",\n    \"8-2\": \"`\\\"mraid_playable\\\":[true]`\",\n    \"8-3\": \"Whether the creative is a playable game in MRAID. This is required to be set when running on MoPub. Note, this is different from declaring general MRAID support, which should be accomplished using the `video.video_api` field (per OpenRTB)\",\n    \"8-1\": \"mraid_playable\",\n    \"9-1\": \"banner_mime\",\n    \"9-2\": \"`\\\"banner_mime\\\":[\\\"image/jpg\\\"]`\",\n    \"9-3\": \"The mime type of the asset within the Creative\",\n    \"10-2\": \"`\\\"expandable_type\\\":[3]`\",\n    \"10-3\": \"The type of expandable as defined by OpenRTB 5.3. Only one type may be set.\",\n    \"11-2\": \"`\\\"expandable_direction\\\":[1,3]`\",\n    \"11-3\": \"The direction the ad will expand, as defined in OpenRTB 5.5. Multiple directions may be indicated.\",\n    \"12-2\": \"`\\\"ksize\\\":[123232]`\",\n    \"12-3\": \"Size of the creative in bytes\",\n    \"13-2\": \"`\\\"tag_type\\\":[1]`\",\n    \"13-3\": \"A canonical list of banner tag types from the IAB's OpenRTB 6.2. Example 1=XHTML text ad\",\n    \"14-1\": \"skippable\",\n    \"14-2\": \"`\\\"skippable\\\":[true]`\",\n    \"14-3\": \"Boolean value to indicate whether the video may be skipped by the user\",\n    \"16-2\": \"`\\\"video_autoplay\\\":[1]`\",\n    \"16-3\": \"Value to indicate whether the ad contains autoplay video. 0=autoplay, 1=click-to-play\",\n    \"17-2\": \"`\\\"video_duration\\\":[30]`\",\n    \"17-3\": \"Duration of the video in seconds as an Integer. Default is 30.\",\n    \"18-2\": \"`\\\"video_mime\\\":[\\\"video/x-flv\\\",\\\"video/mp4\\\"]`\",\n    \"18-3\": \"Mime types of the video within the Creative. Note, this is kept separate from `banner_mime` to conform with the IAB's OpenRTB schema and a single video creative can include multiple mime declarations.\",\n    \"19-2\": \"`\\\"video_protocol\\\":[2]`\",\n    \"19-3\": \"A canonical list of video protocols from the IAB's OpenRTB 6.7. Example 2=VAST 2.0.\",\n    \"20-2\": \"`\\\"video_bit_rate\\\":[600,1200]`\",\n    \"20-3\": \"Bit rate(s) of videos within the Creative.\",\n    \"21-2\": \"`\\\"video_api\\\":[2]`\",\n    \"21-3\": \"A canonical list of video protocols from the IAB's OpenRTB 6.4. Example 2=VPAID 2.0.\",\n    \"22-2\": \"`\\\"video_companion_type\\\":[1]`\",\n    \"22-3\": \"A canonical list of video protocols from the IAB's OpenRTB 6.17. Example 2=HTML.\",\n    \"23-2\": \"`\\\"video_companion_size\\\":[\\\"468x60\\\"]`\",\n    \"23-3\": \"Size, in pixels, of the video's companion ad in the format `<width>x<height>`. Size combination is validated against the `creative_sizes` table.\",\n    \"4-1\": \"landing_page_url\",\n    \"4-2\": \"`\\\"landing_page_url\\\":[\\\"foo.com/bar/baz\\\"]`\",\n    \"4-3\": \"Complete URL where creatives will ultimately land. Required for running on Google AdX\",\n    \"15-1\": \"moat_vpaid\",\n    \"15-2\": \"`\\\"moat_vpaid\\\":[true]`\",\n    \"15-3\": \"Boolean value to indicate whether the MOAT VPaid wrapper should be served before the creative in order to measure viewability.\"\n  },\n  \"cols\": 4,\n  \"rows\": 24\n}\n[/block]","excerpt":"","slug":"list-of-creative-attribute-modules-and-keys","type":"basic","title":"List of Creative Attribute Modules and Keys"}

List of Creative Attribute Modules and Keys


This document summarizes the existing Buzz [Creative Attribute](doc:creative-attributes) modules and keys. [block:parameters] { "data": { "h-0": "Module", "h-1": "Key", "h-2": "Input Example", "h-3": "Notes", "0-0": "advertiser", "1-1": "advertiser_category", "2-1": "advertiser_index_id", "3-1": "advertiser_domain", "5-0": "approval", "6-1": "inventory_source", "7-1": "creative_technology_vendor", "8-0": "mobile", "9-0": "technical", "10-1": "expandable_type", "11-1": "expandable_direction", "12-1": "ksize", "13-1": "tag_type", "14-0": "video", "16-1": "video_autoplay", "17-1": "video_duration", "18-1": "video_mime", "19-1": "video_protocol", "20-1": "video_bit_rate", "21-1": "video_api", "22-1": "video_companion_type", "23-1": "video_companion_size", "0-1": "advertiser_app_bundle", "0-2": "`\"advertiser_app_bundle\":[\"my.app.for.my.watch\"]`", "0-3": "String representation of cross-OS app bundle ID. Some ad exchanges require any ad advertising another app to declare the app bundle of the advertised app.", "1-2": "`\"advertiser_category\":[\"IAB1\",\"IAB1_1\"]`", "1-3": "Canonical list of categories based on the IAB's content categories.", "2-2": "`\"advertiser_index_id\":[1143]`", "2-3": "Canonical list of unique Advertisers based on Google's master list. Every Creative should belong to one and only one Advertiser.", "3-2": "`\"advertiser_domain\":[\"foo.com\"]`", "3-3": "Top-level domain of the Advertiser without any path information. Required on most exchanges.", "5-2": "`\"vendor_id\":[1,2]`", "5-1": "vendor_id", "5-3": "List of optional [Creative Approval Queue](doc:creative-approval-queue) vendors for Creative to be submitted. Note, these vendors are distinct from the `creative_technology_vendors` below, which are just declarations of which technologies are used in the creative.", "6-2": "", "6-3": "DEPRECATED. Approvals for inventory are now stored in the `creative_approvals` field of the `Creative` object.", "7-2": "`\"creative_technology_vendor\":[1,2,3]`", "7-3": "List of technologies used by the Creative, based on Google's list. Beeswax is #632.", "8-2": "`\"mraid_playable\":[true]`", "8-3": "Whether the creative is a playable game in MRAID. This is required to be set when running on MoPub. Note, this is different from declaring general MRAID support, which should be accomplished using the `video.video_api` field (per OpenRTB)", "8-1": "mraid_playable", "9-1": "banner_mime", "9-2": "`\"banner_mime\":[\"image/jpg\"]`", "9-3": "The mime type of the asset within the Creative", "10-2": "`\"expandable_type\":[3]`", "10-3": "The type of expandable as defined by OpenRTB 5.3. Only one type may be set.", "11-2": "`\"expandable_direction\":[1,3]`", "11-3": "The direction the ad will expand, as defined in OpenRTB 5.5. Multiple directions may be indicated.", "12-2": "`\"ksize\":[123232]`", "12-3": "Size of the creative in bytes", "13-2": "`\"tag_type\":[1]`", "13-3": "A canonical list of banner tag types from the IAB's OpenRTB 6.2. Example 1=XHTML text ad", "14-1": "skippable", "14-2": "`\"skippable\":[true]`", "14-3": "Boolean value to indicate whether the video may be skipped by the user", "16-2": "`\"video_autoplay\":[1]`", "16-3": "Value to indicate whether the ad contains autoplay video. 0=autoplay, 1=click-to-play", "17-2": "`\"video_duration\":[30]`", "17-3": "Duration of the video in seconds as an Integer. Default is 30.", "18-2": "`\"video_mime\":[\"video/x-flv\",\"video/mp4\"]`", "18-3": "Mime types of the video within the Creative. Note, this is kept separate from `banner_mime` to conform with the IAB's OpenRTB schema and a single video creative can include multiple mime declarations.", "19-2": "`\"video_protocol\":[2]`", "19-3": "A canonical list of video protocols from the IAB's OpenRTB 6.7. Example 2=VAST 2.0.", "20-2": "`\"video_bit_rate\":[600,1200]`", "20-3": "Bit rate(s) of videos within the Creative.", "21-2": "`\"video_api\":[2]`", "21-3": "A canonical list of video protocols from the IAB's OpenRTB 6.4. Example 2=VPAID 2.0.", "22-2": "`\"video_companion_type\":[1]`", "22-3": "A canonical list of video protocols from the IAB's OpenRTB 6.17. Example 2=HTML.", "23-2": "`\"video_companion_size\":[\"468x60\"]`", "23-3": "Size, in pixels, of the video's companion ad in the format `<width>x<height>`. Size combination is validated against the `creative_sizes` table.", "4-1": "landing_page_url", "4-2": "`\"landing_page_url\":[\"foo.com/bar/baz\"]`", "4-3": "Complete URL where creatives will ultimately land. Required for running on Google AdX", "15-1": "moat_vpaid", "15-2": "`\"moat_vpaid\":[true]`", "15-3": "Boolean value to indicate whether the MOAT VPaid wrapper should be served before the creative in order to measure viewability." }, "cols": 4, "rows": 24 } [/block]