ATG Recommendations Campaign Guide
Campaigns are the mechanism by which you can apply merchandising rules across ATG Recommendations.
You can use them anywhere you display smart product recommendations.
Location-Based Campaigns
Location-based campaigns are assigned to specific locations (slots).
In order to use location-based campaigns you need to alter the Container <DIV> Element for Recommendations . Replace the campaign namecampaign name for the campaigns below, if you are using a custom campaign the correct campaign name will be supplied to you.
<div id="campaign name" class="cs-slot">
.
.
.
</div>
Sitewide Campaigns
In addition to campaigns that can be assigned to specific locations (slots), ATG Recommendations provides a number of optional sitewide campaigns that can be applied to all recommendations on your site.
Sitewide campaigns are applied in addition to any location-specific campaigns you may be using. For example, if a recommendation slot on a clearance item’s product page uses the inCategory campaign and you have also enabled the sitewide “In Price Type” campaign, the slot will be populated with recommendations that are in the current category and are marked as clearance items.
To enable any of the sitewide campaigns on your web site, contact your client services account manager or send email to ATG Recommendations Support.
Dynamic Campaigns
Dynamic Campaigns can be either Location-Based or Sitewide, but behave in a way that is configurable at page-render time. Please refer to the Dynamic Campaign Documentation for more information.
Stock Location-Based Campaigns
Following is a list of provided location-based campaigns. In order to utilize these campaigns, simply use their respective campaign name as described above. Note: in order for these campaigns to function properly on non-product pages, you must instrument these non-product-detail pages correctly.
- In Brand
campaign name: inBrand- Product Detail Page:
Restricts product recommendations to be within the current product’s brand. - Other Page Types:
Restricts product recommendations to be within the brand of the supplied brand tag. Unlike the product detail pages you must
define the brand for the page.
- Not In Brand
campaign name: notInBrand- Product Detail Page:
Restricts product recommendations to be outside the current product’s brand. - Other Page Types:
Restricts product recommendations to be outside the brand of the supplied brand tag. Unlike the product detail pages you must
define the brand for the page.
- In Category
campaign name: inCategory- Product Detail Page:
Restricts product recommendations to be within the current product’s category. - Other Page Types:
Restricts product recommendations to be with the category of the current page. The current category is determined by the category that you define for the page.
- Not In Category
campaign name: notInCategory- Product Detail Page:
Restricts product recommendations to be outside the current product’s category. - Other Page Types:
Restricts product recommendations to be outside the category of the current page. The current category is determined by the category that you define for the page.
- Top Sellers
campaign name: topSellers- Restricts product recommendations to the most popular products on your site.
- Top Sellers in Brand
campaign name: topSellersInBrand- Product Detail Page:
Restricts the product recommendations to the most popular products on your site within this product’s brand. - Other Page Types:
Restricts the product recommendations to the most popular products on your site within this page’s brand.
- Top Sellers in Category
campaign name: topSellersInCategory- Product Detail Page:
Restricts the product recommendations to the most popular products on your site within this product’s category. - Other Page Types:
Restricts the product recommendations to the most popular products on your site within this page’s category.
- Upsell in Category
campaign name: upSellInCategory- Product Detail Page:
Restricts the product recommendations to the products within this product’s category. Additionally, the price of recommended products will be greater than that of the current product. - Other Page Types:
This campaign does not function on non-product-detail pages.
- Upsell in Brand
campaign name: upSellInBrand- Product Detail Page:
Restricts the product recommendations to the products within this product’s brand. Additionally, the price of recommended products will be greater than that of the current product. - Other Page Types:
This campaign does not function on non-product-detail pages.
- Upsell in Brand And Category
campaign name: upSellInBrandAndCategory- Product Detail Page:
Restricts the product recommendations to the products within this product’s brand and category. Additionally, the price of recommended products will be greater than that of the current product. - Other Page Types:
This campaign does not function on non-product-detail pages.
- In Group
campaign name: inGroup- Product Detail Page:
Restricts the product recommendations to products within the same group or groups as this product. You may specify a product’s group with the catalog attribute<c:groups>. Or, if a product belongs to multiple groups,group name</c:groups><c:groups>. Please see the Catalog Format Guide for more information on catalog formats.group name one, group name two, etc.</c:groups> - Other Page Types:
This campaign does not function on non-product-detail pages
- In Group And Brand
campaign name: inGroupAndBrand- Product Detail Page:
Restricts the product recommendations to products within the same group or groups as this product. You may specify a product’s group with the catalog attribute<c:groups>. Or, if a product belongs to multiple groups,group name</c:groups><c:groups>. Please see the Catalog Format Guide for more information on catalog formats.group name one, group name two, etc.</c:groups>
Additionally, only recommend products within this product’s brand. - Other Page Types:
This campaign does not function on non-product-detail pages
- In Group And Category
campaign name: inGroupAndCategory- Product Detail Page:
Restricts the product recommendations to products within the same group or groups as this product. You may specify a product’s group with the catalog attribute<c:groups>. Or, if a product belongs to multiple groups,group name</c:groups><c:groups>. Please see the Catalog Format Guide for more information on catalogs.group name one, group name two, etc.</c:groups>
Additionally, only recommend products within this product’s category. - Other Page Types:
This campaign does not function on non-product-detail pages
- In Price Type
campaign name: inPriceType- Product Detail Page:
Restricts the product recommendations to products within the same price type as this product. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price> - Other Page Types:
This campaign does not function on non-product-detail pages
- In Price Type And Brand
campaign name: inPriceTypeAndBrand- Product Detail Page:
Restricts the product recommendations to products within the same price type as this product. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price>
Additionally, only recommend products within this product’s brand. - Other Page Types:
This campaign does not function on non-product-detail pages
- In Price Type And Category
campaign name: inPriceTypeAndCategory- Product Detail Page:
Restricts the product recommendations to products within the same price type as this product. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price>
Additionally, only recommend products within this product’s category. - Other Page Types:
This campaign does not function on non-product-detail pages
- In Cart Price Types
campaign name: inCartPriceTypes- All Page Types:
Restricts the product recommendations to products within the same price types as products currently in the cart. For example, if a customer has only sale products in the cart, only sale products will be recommended; if the customer has both sale and clearance items in the cart, only sale and/or clearance products will be recommended.. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price>
- Sale Products
campaign name: inSaleProducts- All Page Types:
Restricts the product recommendations to products with the price type ‘sale’. To mark a product as a sale product, specify the ‘sale’ price type in the catalog<g:price type='sale'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
- Sale Products In Brand
campaign name: saleProductsInBrand- Product Detail Page:
Restricts the product recommendations to products with the price type ‘sale’. To mark a product as a sale product, specify the ‘sale’ price type in the catalog<g:price type='sale'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s brand. - Other Page Types:
Restricts the product recommendations to products with the price type ‘sale’. Additionally, restricts product recommendations to be within the brand of the supplied brand tag. Unlike the product detail pages you must define the brand for the page.
- Sale Products In Category
campaign name: saleProductsInCategory- Product Detail Page:
Restricts the product recommendations to products with the price type ‘sale’. To mark a product as a sale product, specify the ‘sale’ price type in the catalog<g:price type='sale'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s category. - Other Page Types:
Restricts the product recommendations to products with the price type ‘sale’. Additionally, restricts product recommendations to be within the category of the supplied category tag. Unlike the product detail pages you must define the category for the page.
- Product Detail Page:
- Clearance Products
campaign name: clearanceProducts- All Page Types:
Restricts the product recommendations to products with the price type ‘clearance’. To mark a product as a clearance product, specify the ‘clearance’ price type in the catalog<g:price type='clearance'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
- Clearance Products In Brand
campaign name: clearanceProductsInBrand- Product Detail Page:
Restricts the product recommendations to products with the price type ‘clearance’. To mark a product as a clearance product, specify the ‘clearance’ price type in the catalog<g:price type='clearance'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s brand. - Other Page Types:
Restricts the product recommendations to products with the price type ‘clearance’. Additionally, restricts product recommendations to be within the brand of the supplied brand tag. Unlike the product detail pages you must define the brand for the page.
- Clearance Products In Category
campaign name: clearanceProductsInCategory- Product Detail Page:
Restricts the product recommendations to products with the price type ‘clearance’. To mark a product as a clearance product, specify the ‘clearance’ price type in the catalog<g:price type='clearance'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s category. - Other Page Types:
Restricts the product recommendations to products with the price type ‘clearance’. Additionally, restricts product recommendations to be within the category of the supplied category tag. Unlike the product detail pages you must define the category for the page.
- Product Detail Page:
- Outlet Products
campaign name: outletProducts- All Page Types:
Restricts the product recommendations to products with the price type ‘outlet’. To mark a product as a outlet product, specify the ‘outlet’ price type in the catalog<g:price type='outlet'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
- Outlet Products In Brand
campaign name: outletProductsInBrand- Product Detail Page:
Restricts the product recommendations to products with the price type ‘outlet’. To mark a product as a outlet product, specify the ‘outlet’ price type in the catalog<g:price type='outlet'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s brand. - Other Page Types:
Restricts the product recommendations to products with the price type ‘outlet’. Additionally, restricts product recommendations to be within the brand of the supplied brand tag. Unlike the product detail pages you must define the brand for the page.
- Outlet Products In Category
campaign name: outletProductsInCategory- Product Detail Page:
Restricts the product recommendations to products with the price type ‘outlet’. To mark a product as a outlet product, specify the ‘outlet’ price type in the catalog<g:price type='outlet'>1.23</g:price>. Please see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s category. - Other Page Types:
Restricts the product recommendations to products with the price type ‘outlet’. Additionally, restricts product recommendations to be within the category of the supplied category tag. Unlike the product detail pages you must define the category for the page.
- Product Detail Page:
- New Products
campaign name: newProducts- All Page Types:
Restricts the product recommendations to new products. Products can be explicitly marked as new or not new by providing the catalog attribute<c:new>true|false</c:new>. This is the preferred method to indicate product newness. Otherwise, ATG will consider a product as new if it was added to the catalog within the last ___N___ days, where the default value for N is 14 (e.g. two weeks). You may change this value by contacting Client Services. Also, see the Catalog Format Guide for more information on catalogs.
- New Products In Brand
campaign name: newProductsInBrand- Product Detail Page:
Restricts the product recommendations to new products. Products can be explicitly marked as new or not new by providing the catalog attribute<c:new>true|false</c:new>. This is the preferred method to indicate product newness. Otherwise, ATG will consider a product as new if it was added to the catalog within the last ___N___ days, where the default value for N is 14 (e.g. two weeks). You may change this value by contacting Client Services. Also, see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s brand. - Other Page Types:
Restricts the product recommendations to new products. Additionally, restricts product recommendations to be within the brand of the supplied brand tag. Unlike the product detail pages you must define the brand for the page.
- New Products In Category
campaign name: newProductsInCategory- Product Detail Page:
Restricts the product recommendations to new products. Products can be explicitly marked as new or not new by providing the catalog attribute<c:new>true|false</c:new>. This is the preferred method to indicate product newness. Otherwise, ATG will consider a product as new if it was added to the catalog within the last N days, where the default value for N is 14 (i.e. two weeks). You may change this value by contacting Client Services. Also, see the Catalog Format Guide for more information on catalogs.
Additionally, only recommend products within this product’s brand. - Other Page Types:
Restricts the product recommendations new products. Additionally, restricts product recommendations to be within the category of the supplied category tag. Unlike the product detail pages you must define the category for the page.
- Product Detail Page:
Stock Sitewide Campaigns
Following is a list of sitewide campaigns that are currently available and can be enabled by contacting Client Services.
- In Group
- Applies When:
The current product belongs to one or more groups. - Product Detail Page:
Restricts the product recommendations to products within the same group or groups as this product. You may specify a product’s group with the catalog attribute<c:groups>. Or, if a product belongs to multiple groups,group name</c:groups><c:groups>. Please see the Catalog Format Guide for more information on catalog formats.group name one, group name two, etc.</c:groups> - Other Page Types:
This campaign does not function on non-product-detail pages
- Applies When:
- In Price Type
- Applies When:
The current product has specified a price type. - Product Detail Page:
Restricts the product recommendations to products within the same price type as this product. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price> - Other Page Types:
This campaign does not function on non-product-detail pages
- Applies When:
- In Cart Price Types
- Applies When:
One or more of the products in the current cart have a specified price type - All Page Types:
Restricts the product recommendations to products within the same price types as products currently in the cart. For example, if a customer has only sale products in the cart, only sale products will be recommended; if the customer has both sale and clearance items in the cart, only sale and/or clearance products will be recommended. You may specify a product’s price type by including the ‘price-type’ attribute of the ‘price’ element in your catalog<g:price type='. Please see the Catalog Format Guide for more information on catalogs.price type'>1.23</g:price>
- Applies When:
- Minimum Inventory
- Applies When:
Always. - All Page Types:
Restricts recommendations to products with inventory greater than a given threshold. By default, this threshold is zero. To utilize this campaign, you must provide product inventory in your catalog. A catalog product without an indicated inventory will be considered to have infinite inventory for the purposes of this campaign. That is, those products will always be recommendable. Please see the Catalog Format Guide for more information on catalogs.
- Applies When:
Custom Campaigns
Not quite what you were looking for? We can also provide custom campaigns to support your merchandising needs. Contact ATG Client Services for more information.
