Dynamic Creative Feed Schema

Dynamic Creative Ad Builder accesses website product and promotion data by means of an XML feed. Ad Builder has built-in direct integration for a number of  popular website platforms. If you use one of these platforms, your best option is to connect using the built-in support. However, if you do not use one of our supported platforms you will need to build your own feed.

The following instructions are for integrating with retail websites. Schemas exist for other verticals as well, please contact support@dynamiccreative.com for details.

Inventory Feed

An inventory feed is an XML document described by the Dynamic Creative Retail Standard Vertical schema that contains a list of all applicable inventory items and promotions currently available on a website.

The schema XSD to validate against can be found at  http://verticals.dynamiccreative.com/v1/retail_standard.xsd

Inventory Item

An inventory item represents a single product (for example ‘iPod Touch’) that is for sale on a website. Each variant of a product is a separate inventory item and should have a unique SKU.

Example

The text content of the XML elements in the feed is used to generate relevant keywords and ad copy. E.g.

<items>
  <item>
    <sku>123456</sku>
    <first_category url_value=”suits”>Suits</first_category>
    <second_category url_value=”suits/formal”>Formal Suits</second_category>
    <brand url_value=”brand=123”>Hugo Boss</first_category>
    <price>1999</price>
  </item>
</items>
  • Ad
    • Hugo Boss Formal Suits - From $1999
    • Look the part this summer in Hugo Boss. Free returns!
  • KeyWord
    • hugo boss formal suits online

The url_value attributes are used to construct relevant landing pages for the ads. E.g. 

Inventory Item Feed Elements

Element Description Required URL Value
Product Description
SKU The unique ID (or equivalent) within the website for a given inventory item Yes
Product The name of a given inventory item Yes
Description The description of the given inventory item Yes
Image URL The url value for the image for the given inventory item Yes
URL The url value for the given inventory item within your website Yes
Product Categorisation
First Category The primary (root) category within the website for a given inventory item Yes Yes
Second Category The secondary category within the website for a given inventory item If present If present
Third Category The tertiary category within the website for a given inventory item If present If present
Fourth Category The fourth level category within the website for a given inventory item If present If present
Fifth Category The fifth level category within the website for a given inventory item If present If present
Filter (Variant Group) The filter attribute for a given inventory item within the website; unique within a given category hierarchy. Up to four variant groups can be added per item, eg: variant_group_one, variant_group_two etc. If present  If present
Product Attributes
Brand The manufacturer brand for a given inventory item. If unbranded provide the website brand instead. Yes If present
Sub Brand The manufacturer sub brand for a given inventory item If present If present
Model The manufacturer part number (MPN) for a given inventory item If present If present
GTIN Global Trade Item Numbers (GTINs) for a given inventory item If present
Condition The condition within the website for a given inventory item Yes
Stock Amount The number of units available in stock for a given inventory item If present
Stock Availability Indicates whether or not there is stock available for a given inventory item. Yes
Size The nominated size for a given inventory item If present
Colour The nominated colour for a given inventory item  If present If present
Warranty Period The time period of the warranty on the given inventory item if any If present
Pricing Attributes
Price The non-promotional list price, within the website, for a given inventory item Yes
RRP The RRP (recommended retail price) for a given inventory item If present
Save Percent The amount saved, as a percentage, for a given inventory item – between the appropriate price attributes If present
Save Amount The amount saved, as a dollar, for a given inventory item – between the appropriate price attributes If present
Promotion Attributes
On Promotion A true or false indication, if a given inventory item is on promotion (sale) within the website If present
Promotion Price The promotional list price, within the website, for a given inventory item If present
Promotion Start Data The nominated start date for when a promotion is running for a given inventory item If present
Promotion End Date The nominated end date for a when a promotion is running for a given inventory item If present
Flat Rate Shipping (provide this value or relevant values in the Variable Shipping Attributes)
Shipping Price The shipping price associated with a given inventory item If present
Variable Shipping Attributes
Shipping Weight The shipping weight associated with a given inventory item If present
Shipping Service The shipping service class associated with a given inventory item If present
Shipping State The geographical area (state) for which the shipping rate applies If present
Shipping Country The country to which an item will be delivered If present
Length The length of the inventory item If present
Width The width of the inventory item If present
Height The height of the inventory item If present
Other Google Shopping Attributes
Is Bundle Indicates a product is a merchant-defined custom group of different products featuring one main product If relevant
Unit Amount The measure and dimension of your product as it is sold If relevant
Unit Per Base Price The product’s base measure for pricing (e.g. 100ml means the price is calculated based on a 100ml units) If relevant
Parent SKU The parent SKU if this product is parent of a group or multipack If relevant
Multipack Amount The number of identical products sold within a merchant-defined multipack If relevant
Preorder Availability Date The date a pre-ordered product becomes available for delivery If relevant
Expiration Date The date that your product should stop showing If relevant
Mobile URL Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic If relevant
Other
Product Popularity The relative popularity of a given inventory item. If present
User Rating The average user rating for a given inventory item. If present
Product Margin The margin between your cost price and sale price for a given inventory item If present

Inventory Promotion

An inventory promotion represents a special offer available for use on your website. Promotions often include a coupon code that can be entered at checkout to access the promotion. They may apply to all products, or may only apply to specific SKUs or when a certain cart value is reached. You need only include promotions that are available to all customers or that you want to advertise.

Example

<items>
  <item>
    <sku>123456</sku>
  </item>

  <promotion>
    <offer_id>Summer Sale 2017</offer_id>
    <offer_type>GENERIC_CODE</offer_type>
    <generic_redemption_code>SUMMER-2017</generic_redemption_code>
    <percent_off>10</percent_off>
    <skus>
      <sku>123456</sku>
    </skus>
  </promotion>
</items>

Inventory Promotion Attributes

Offer Id A unique identifier for this promotions Yes
Product Applicability Whether this promotion applies to all products or only selected products. Yes
Offer Type Whether this promotion requires a code to access. Yes
Redemption Channel Where the offer is available. Yes
Generic Redemption Code Code entered by your customer at checkout to access the promotion. If relevant
Minimum Purchase Amount If your promotion is of the form, "Save $10 for orders over $100" or "Get 5% off orders over $100" this should be 100. If relevant
Percent Off If your promotion is of the form, "Get 5% off" this should be 5. If relevant
Money Off Amount If your promotion is of the form, "Get $10 off orders over $100" this should be 10. If relevant
Buy This Quantity If your promotion is of the form "Buy 2 get 1 free" this should be 2. If relevant
Get This Quantity Discounted If your promotion is of the form "Buy 2 get 1 free" this should be 1. If relevant
Free Shipping Type The type of free shipping being offered. If relevant
Free Gift Value If your promotion is of the form, "Spend $200 and get a free gift card for $20" this should be $20. If relevant
Free Gift Description If your promotion is of the form, "Spend $200 and get a free gift card for $20" this should be "Gift card" If relevant

Feed Validation

There are two aspects to validating the feed:

Schema Validation

Please ensure that the feed validates against the relevant XSD: http://verticals.dynamiccreative.com/v1/retail_standard.xsd

Feed Item Validation

As the feed is developed, please provide the feed through to your technical representative for review. We will perform additional checks over and above the schema validation that we undertake that often require rework before the feed is ready to be consumed by the Dynamic Creative Ad Builder. Generally, most issues can be resolved quickly across one or two review cycles.

Common Validation Issues

Problem: XML does not conform to XSD Schema

Solution: Ensure the feed validates against the XSD Schema as provided

Problem: url_value attributes are not valid

Solution: url_value attributes for first_category, second_category and so on should allow us to generate a landing page to show all of the products within that category. Only the path is required, do not include the protocol or hostname.

Problem: all relevant category elements are not provided

For example, a product is available on a website via a menu structure of Suits > Formal Suits > Wedding Suits

The item is provided in the feed as follows:

<item>
  <sku>12345</sku>
  <first_category url_value=”suits/formal/wedding”>Wedding Suits</first_category>
 ... snipped

Solution: url_value attributes for first_category, second_category and so on should allow us to generate a landing page to show all of the products within that category. Only the absolute path is required, do not include the protocol or hostname.

<item>
  <sku>12345</sku>
  <first_category url_value=”suits”>Suits</first_category>
  <second_category url_value=”suits/formal”>Formal Suits</second_category>
  <third_category url_value=”suits/formal/wedding”>WeddingSuits</third_category>
... snipped

Problem: filter url_value attributes are not provided correctly

If your website supports filtering by attributes such as brand or colour or size, we require those url_value attributes so that we can correctly generate a landing page for relevant products.

Solution: Please refer to the example XML above to see the correct usage of a url_value for a brand attribute.

Still need help? Contact Us Contact Us