Plugin Retaligence
There are two API endpoints that we use – “locations” and “products”
Retailigence is acquired by ShopAdvisor.
Prerequisites
Geolocation information from AdParameters in VAST. When this is not served through VAST, the geoInfo will be defaulted a New York zip code 10020.
The Retailigence Instance
The Retailigence Instance works with two API ends points – “locations” and "products". This is a thin wrapper around Retailigence’s API. For more information on what are the acceptable values for each of the parameter, look at Retailigence documentation and ask a friendly Retailigence contact.
Giuseppe Calabrese Director, Ad Sales & Operations 646-479-7733
Products API
Returns a search result consisting of Products, Retailers and Store Locations in response to a query that includes User Location
By productId
Arguments
[options={}] (Object): The options object.[options.surrogate] (reference): The current movie clip that contains your placeholder.[options.api] (string): Set to'products'[options.productId] (string): Product ID based on Retailigence / ShopAdvisor.
var Retailigence = $b.getPlugin('retailigence')
var r = new Retailigence({
surrogate: this,
api: 'products',
productId: '70001'
})
By brand
Arguments
[options={}] (Object): The options object.[options.surrogate] (reference): The current movie clip that contains your placeholder.[options.api] (string): Set to'products'[options.brand] (string): Brand name to be searched
var Retailigence = $b.getPlugin('retailigence')
var r = new Retailigence({
surrogate: this,
api: 'products',
brand: 'Apple'
})
By keywords
Arguments
[options={}] (Object): The options object.[options.surrogate] (reference): The current movie clip that contains your placeholder.[options.api] (string): Set to'products'[options.keywords] (string): Keywords to be searched
var Retailigence = $b.getPlugin('retailigence')
var r = new Retailigence({
surrogate: this,
api: 'products',
keywords: 'crayon'
})
By product name
Arguments
[options={}] (Object): The options object.[options.surrogate] (reference): The current movie clip that contains your placeholder.[options.api] (string): Set to'products'[options.name] (string): Product name to be searched
var Retailigence = $b.getPlugin('retailigence')
var r = new Retailigence({
surrogate: this,
api: 'products',
name: 'Xbox One'
})
Locations API (Retailer Query)
Returns Retailers and Store Locations in response to a query that includes User Location
By retailer ID
Arguments
[options={}] (Object): The options object.[options.surrogate] (reference): The current movie clip that contains your placeholder.[options.api] (string): Set to'locations'[options.retailerId] (string): ID of the retailer given by Retailigence / ShopAdvisor.
Example:
var Retailigence = $b.getPlugin('retailigence')
var r = new Retailigence({
surrogate: this,
api: 'locations',
retailerId: '2a07c9ae-aac8-4893-9853-4e4e467bde22' // Safeway
})