General Information
During the integration period, an experienced customer support and integration specialist will be assigned to you, whom you can always contact promptly (usually our partners create a chat).
Systems Integration
Integration consists of two stages:
- General integration with the website or application to transfer data about products and visitor behavior.
- Implementation of Smart Placement sponsored placements and transmission of events about user interactions with them.
User Behavior Transmission
For the Retail Rocket "Sponsored Placements" system, user behavior is necessary in two aspects: obtaining user events to provide the advertiser with content targeting functionality based on the user profile – targeting by user interests in categories, and tracking user interactions with sponsored content – calculating display efficiency.
Description of general integration for transferring data about products and visitor behavior:
-
To transfer product data, you can choose one of two options:
- Prepare a YML file. Example and description at the link.
- Set up product data transfer from the site. Example instruction at the link
-
To transfer user behavior data via API, you can use the instructions found in this documentation. Here you will find:
-
User behavior transmission can also be configured by installing Java Script tracking codes on the website pages.
The integration type using JS SDK is only suitable for websites.
A mobile application must be integrated only via API.
Integration of Sponsored Blocks
Drawing up an Integration Map with the Java Script Integration Type
In the case of integration via Java Script, we will prepare an instruction for installing blocks on the site.
A list of website pages with locations where sponsored content is planned to be displayed will be compiled. For each location, we will prepare an identifier, select the page type and content type.
The result should be a table (integration map):
| Placement | Block ID | Page Type | Content Type |
|---|---|---|---|
| Product card before comments | 608d286f30e9b69fee2be370 | Product card | Product shelf |
| Product card after comments | 608d28c10f3b6f6091ae818c | Product card | Product shelf, banner |
| Search page | 608d2887b50326449cb41224 | Search result | Banner |
| Home page, banner spot | 608d28f9b0a04d23b9aea5e5 | Other | Banner |
From your side, you will only need to place these codes in the required locations on the site; all block layout and sending of user interaction events with blocks will be on our side.
Drawing up an Integration Map with the API Integration Type
To implement sponsored placements via the Smart Placement API, we will separately prepare an implementation map with visualization of your website or application pages and sponsored content on those pages. Also, the map will contain detailed accurate instructions for each block/section/content type.
With the integration map in hand, the online store's programmer, using the API documentation for receiving sponsored placements, requests content at each page display, processes the response depending on the received content type, and embeds the promo material into the online store interface.
General instructions for integration via API can be found at the following links: