{"_id":"5601cc68fb9f160d00f29813","__v":5,"category":{"_id":"55f9dbefc7ef770d00d9bf6d","version":"5429beef1163360800ed31fd","__v":6,"pages":["55f9eec4c7ef770d00d9bf83","55f9fb8daba81f0d00a11566","5601ca6870694e0d00e3c66f","5601cb9b96e0f70d0044b0fd","56157d7af2d81d0d006c895f","5671d738c17bf90d00b95822"],"project":"5429beef1163360800ed31fa","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-16T21:15:27.664Z","from_sync":false,"order":4,"slug":"publisher-ui-setup","title":"Trafficking and Inventory"},"project":"5429beef1163360800ed31fa","parentDoc":null,"user":"55e74aae73169617001f2e78","version":{"_id":"5429beef1163360800ed31fd","__v":22,"project":"5429beef1163360800ed31fa","createdAt":"2014-09-29T20:19:59.904Z","releaseDate":"2014-09-29T20:19:59.904Z","categories":["5429beef1163360800ed31fe","55e74e1f5d36b32b002563fa","55e7500a73169617001f2e86","55e76b8196131b2f00bf4b72","55e89569cdbb8a350096df9c","55f8935eb089b71700a8364e","55f8a67d3bb4bb0d0022d093","55f9dbefc7ef770d00d9bf6d","5601c21a22ecf60d002b27b3","5601c21ff12aee0d001bb06e","5601c2256c7b610d00280db5","5601c22c22ecf60d002b27b4","5603738d0c78b00d0039af47","5626f70bfcbbc621004ebf52","566f7a1ae144ab0d00e9732f","566f85ca7820960d00c3b93d","56708ce43a32d20d00c45cbf","56708d436995210d003aad8e","5736471abe10a9200030732c","57a82c7aff9bd30e00a6f1c1","591b8500e3992319007190f4","5a3718305c66a60012d960ba"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T21:47:20.137Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":10,"body":"To create a new placement click on the **+Build Placement** button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9b6a1e8-Screen_Shot_2018-03-19_at_14.13.19.png\",\n        \"Screen Shot 2018-03-19 at 14.13.19.png\",\n        2242,\n        1124,\n        \"#082644\"\n      ]\n    }\n  ]\n}\n[/block]\nThe placement settings are divided into four broad categories. They are:\n\n  * Integration tab\n  * Design tab\n  * Configuration tab\n  * Customization\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Integration Tab\"\n}\n[/block]\nUnder the Integration tab you'll find the following settings:\n\n**Placement name:** A unique name given to the placement.\n**Web/Mobile/Email app:** Denotes whether this placement is to be used for web/mobile/email app traffic.\n**Ad Types:** Native/Banner/Video- Determines the type of ads to be rendered for the placement\n**Instructions:** Provides you with the instructions for placing the tags on the web or requesting ads through our Ads API.\n**CSS path:** The CSS path is used to determine the position on the webpage where the native placement will be rendered. \n \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/a436753-Screen_Shot_2018-03-19_at_14.57.12.png\",\n        \"Screen Shot 2018-03-19 at 14.57.12.png\",\n        2314,\n        1110,\n        \"#eaecec\"\n      ]\n    }\n  ]\n}\n[/block]\nFor email type placements below fields are seen, instead of CSS Path,\n**Email Service Providers:** List of email service providers we support\n**Email service Macro:** Macro used for the email service provider\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/42e92e0-Screen_Shot_2018-03-19_at_14.58.13.png\",\n        \"Screen Shot 2018-03-19 at 14.58.13.png\",\n        2302,\n        1104,\n        \"#eaebeb\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Design Tab\"\n}\n[/block]\nUnder the design tab you'll find two subsections 1) Layout 2)Design. The settings under the layout subsection are:\n\n**Native AdType**\n\n**Placement layout:** This denotes the look and feel of the native placement on the page. Polymorph has a set of predefined templates that you can use or you can build your own custom template.\n**Title and summary length:**  This denotes the maximum title and summary length for marketplace campaigns. Any marketplace campaign exceeding this length will be truncated to this length.\n**Image size:** This is the minimum size of the image that this native placement will accept. \n**Ad position:** Ad position in the layout. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b94852e-Screen_Shot_2018-03-19_at_15.14.50.png\",\n        \"Screen Shot 2018-03-19 at 15.14.50.png\",\n        2278,\n        1260,\n        \"#e8eaea\"\n      ]\n    }\n  ]\n}\n[/block]\nThe settings under the Design subsections are as follows:\n For Web app:\n**HTML template:** If you choose to build your custom template to denote the look and feel of the placement on the page, you'd need to place the HTML element of the template here.\n**Custom CSS:** For your custom template the additional styling that you need can be placed here.\n**Background color:** You can choose the background color for the ad placement. This will remain constant for the placement irrespective of the campaigns that are served on this.\n**Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0ace83e-Screen_Shot_2018-04-19_at_18.12.46.png\",\n        \"Screen Shot 2018-04-19 at 18.12.46.png\",\n        686,\n        810,\n        \"#eaebeb\"\n      ]\n    }\n  ]\n}\n[/block]\nFor Mobile app:\n**Fixed positions:** Fixed position of ad layout\n**Repeat Interval:** It is an SDK specific field. Used to determine the repeating position of ads in a list view\n**Ad Layout:** HTML layout of the template\n**Background color:** You can choose the background color for the ad placement. This will remain constant for the placement irrespective of the campaigns that are served on this.\n**Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/cb0a7f1-Screen_Shot_2018-03-19_at_15.44.20.png\",\n        \"Screen Shot 2018-03-19 at 15.44.20.png\",\n        1758,\n        633,\n        \"#e9eaea\"\n      ]\n    }\n  ]\n}\n[/block]\nFor email app:\n**HTML template:** If you choose to build your custom template to denote the look and feel of the placement on the page, you'd need to place the HTML element of the template here.\n**Custom CSS:** For your custom template the additional styling that you need can be placed here.\n**Email Custom Fields:** Fields like image offset, width, height and Ad width and height.\n**Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/834aa51-Screen_Shot_2018-04-19_at_18.25.09.png\",\n        \"Screen Shot 2018-04-19 at 18.25.09.png\",\n        608,\n        840,\n        \"#e4e5e6\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Configuration tab\"\n}\n[/block]\nThe setting under the configuration tab are as follows:\n\n**Site:** This denotes the site where this placement is allowed to render. Without the site mentioned here, the request will fail.\n**Category:** List of 24 IAB standard categories used for targeting ads from the marketplace. \n**Floor Price:** Campaign Rate should be greater or equal to the mentioned value for the campaign to get selected \n**Number of Ads** - Number of Ads in the placement. \nExample: If num_ads=3 in the API request, 3 creatives will be fetched.\nAPI response would be in below format\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\nstatus: \\\"OK\\\",\\ncount: 3,\\nads: - [\\n+ {... },\\n+ {... },\\n+ {... }\\n],\\nzid: \\\"5c7DeTp5371CjTzRfGXgnLIgAlWFaDAHMZUeIsZB\\\",\\nsid: \\\"e172001053c84e568128ebb5fc680981\\\",\\nuuid: \\\"bd9258e7-76b2-4419-b5c6-b8f3c7a4a721\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"API response for num_ads=3\"\n    }\n  ]\n}\n[/block]\n**Enable domains:** If you need the placement to render on multiple sites, mention the extra sites here.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9189d1f-Screen_Shot_2018-04-19_at_18.15.27.png\",\n        \"Screen Shot 2018-04-19 at 18.15.27.png\",\n        681,\n        647,\n        \"#dcdddd\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Customization\"\n}\n[/block]\nThis tab as two subtabs\nCustom Key Values - Maps the custom value required by campaign call to render it\nCustom Fields - Provision to add placement specific custom key/value\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/f4594da-Screen_Shot_2018-03-19_at_15.12.23.png\",\n        \"Screen Shot 2018-03-19 at 15.12.23.png\",\n        2314,\n        872,\n        \"#1582c3\"\n      ],\n      \"caption\": \"Custom Key Value selection\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ca07eb1-Screen_Shot_2018-03-23_at_12.43.06.png\",\n        \"Screen Shot 2018-03-23 at 12.43.06.png\",\n        1687,\n        306,\n        \"#e6e8e9\"\n      ],\n      \"caption\": \"Custom Field can be used to set placement specific custom data. This can be overridden by custom data from creatives of the campaign\"\n    }\n  ]\n}\n[/block]","excerpt":"This page describes the process of creating a new placement.","slug":"creating-placements","type":"basic","title":"Create Native Ad Placement"}

Create Native Ad Placement

This page describes the process of creating a new placement.

To create a new placement click on the **+Build Placement** button. [block:image] { "images": [ { "image": [ "https://files.readme.io/9b6a1e8-Screen_Shot_2018-03-19_at_14.13.19.png", "Screen Shot 2018-03-19 at 14.13.19.png", 2242, 1124, "#082644" ] } ] } [/block] The placement settings are divided into four broad categories. They are: * Integration tab * Design tab * Configuration tab * Customization [block:api-header] { "type": "basic", "title": "Integration Tab" } [/block] Under the Integration tab you'll find the following settings: **Placement name:** A unique name given to the placement. **Web/Mobile/Email app:** Denotes whether this placement is to be used for web/mobile/email app traffic. **Ad Types:** Native/Banner/Video- Determines the type of ads to be rendered for the placement **Instructions:** Provides you with the instructions for placing the tags on the web or requesting ads through our Ads API. **CSS path:** The CSS path is used to determine the position on the webpage where the native placement will be rendered. [block:image] { "images": [ { "image": [ "https://files.readme.io/a436753-Screen_Shot_2018-03-19_at_14.57.12.png", "Screen Shot 2018-03-19 at 14.57.12.png", 2314, 1110, "#eaecec" ] } ] } [/block] For email type placements below fields are seen, instead of CSS Path, **Email Service Providers:** List of email service providers we support **Email service Macro:** Macro used for the email service provider [block:image] { "images": [ { "image": [ "https://files.readme.io/42e92e0-Screen_Shot_2018-03-19_at_14.58.13.png", "Screen Shot 2018-03-19 at 14.58.13.png", 2302, 1104, "#eaebeb" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Design Tab" } [/block] Under the design tab you'll find two subsections 1) Layout 2)Design. The settings under the layout subsection are: **Native AdType** **Placement layout:** This denotes the look and feel of the native placement on the page. Polymorph has a set of predefined templates that you can use or you can build your own custom template. **Title and summary length:** This denotes the maximum title and summary length for marketplace campaigns. Any marketplace campaign exceeding this length will be truncated to this length. **Image size:** This is the minimum size of the image that this native placement will accept. **Ad position:** Ad position in the layout. [block:image] { "images": [ { "image": [ "https://files.readme.io/b94852e-Screen_Shot_2018-03-19_at_15.14.50.png", "Screen Shot 2018-03-19 at 15.14.50.png", 2278, 1260, "#e8eaea" ] } ] } [/block] The settings under the Design subsections are as follows: For Web app: **HTML template:** If you choose to build your custom template to denote the look and feel of the placement on the page, you'd need to place the HTML element of the template here. **Custom CSS:** For your custom template the additional styling that you need can be placed here. **Background color:** You can choose the background color for the ad placement. This will remain constant for the placement irrespective of the campaigns that are served on this. **Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content. [block:image] { "images": [ { "image": [ "https://files.readme.io/0ace83e-Screen_Shot_2018-04-19_at_18.12.46.png", "Screen Shot 2018-04-19 at 18.12.46.png", 686, 810, "#eaebeb" ] } ] } [/block] For Mobile app: **Fixed positions:** Fixed position of ad layout **Repeat Interval:** It is an SDK specific field. Used to determine the repeating position of ads in a list view **Ad Layout:** HTML layout of the template **Background color:** You can choose the background color for the ad placement. This will remain constant for the placement irrespective of the campaigns that are served on this. **Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content. [block:image] { "images": [ { "image": [ "https://files.readme.io/cb0a7f1-Screen_Shot_2018-03-19_at_15.44.20.png", "Screen Shot 2018-03-19 at 15.44.20.png", 1758, 633, "#e9eaea" ] } ] } [/block] For email app: **HTML template:** If you choose to build your custom template to denote the look and feel of the placement on the page, you'd need to place the HTML element of the template here. **Custom CSS:** For your custom template the additional styling that you need can be placed here. **Email Custom Fields:** Fields like image offset, width, height and Ad width and height. **Sponsored Label Prefix:** This is the label that will appear with your native ad denoting that this is a sponsored content. [block:image] { "images": [ { "image": [ "https://files.readme.io/834aa51-Screen_Shot_2018-04-19_at_18.25.09.png", "Screen Shot 2018-04-19 at 18.25.09.png", 608, 840, "#e4e5e6" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Configuration tab" } [/block] The setting under the configuration tab are as follows: **Site:** This denotes the site where this placement is allowed to render. Without the site mentioned here, the request will fail. **Category:** List of 24 IAB standard categories used for targeting ads from the marketplace. **Floor Price:** Campaign Rate should be greater or equal to the mentioned value for the campaign to get selected **Number of Ads** - Number of Ads in the placement. Example: If num_ads=3 in the API request, 3 creatives will be fetched. API response would be in below format [block:code] { "codes": [ { "code": "{\nstatus: \"OK\",\ncount: 3,\nads: - [\n+ {... },\n+ {... },\n+ {... }\n],\nzid: \"5c7DeTp5371CjTzRfGXgnLIgAlWFaDAHMZUeIsZB\",\nsid: \"e172001053c84e568128ebb5fc680981\",\nuuid: \"bd9258e7-76b2-4419-b5c6-b8f3c7a4a721\"\n}", "language": "json", "name": "API response for num_ads=3" } ] } [/block] **Enable domains:** If you need the placement to render on multiple sites, mention the extra sites here. [block:image] { "images": [ { "image": [ "https://files.readme.io/9189d1f-Screen_Shot_2018-04-19_at_18.15.27.png", "Screen Shot 2018-04-19 at 18.15.27.png", 681, 647, "#dcdddd" ] } ] } [/block] [block:api-header] { "title": "Customization" } [/block] This tab as two subtabs Custom Key Values - Maps the custom value required by campaign call to render it Custom Fields - Provision to add placement specific custom key/value [block:image] { "images": [ { "image": [ "https://files.readme.io/f4594da-Screen_Shot_2018-03-19_at_15.12.23.png", "Screen Shot 2018-03-19 at 15.12.23.png", 2314, 872, "#1582c3" ], "caption": "Custom Key Value selection" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/ca07eb1-Screen_Shot_2018-03-23_at_12.43.06.png", "Screen Shot 2018-03-23 at 12.43.06.png", 1687, 306, "#e6e8e9" ], "caption": "Custom Field can be used to set placement specific custom data. This can be overridden by custom data from creatives of the campaign" } ] } [/block]