Integration Steps

Workflow

Step 1: Retailer Account initialization

• Retailer sends the product feed in xml format

An important step of the retailer is to include in the product feed xml all the available categories in which each product belongs into. (1st level Parent categories, 2nd level parent categories, subcategories etc)

• Project Agora imports the product feed and provides the retailers with:

  • Team id

  • API key

  • Catalog id

  • Base url

• Project Agora configures test campaigns and provides retailer with snippet ad request codes

For product feed specifications, please check the following page:

Syncing Catalog and Products Via File

Step 2: Sponsored Product Listings Integration

The SPL format is integrated in the Category, Subcategory and Search pages and it's displayed in the same grid with the organic product results.

Retailer integrates Sponsored Product Listings by following the next steps:

2.1 Request and response of an SPL:

Product Listing Ad Integration Guide

2.2 Report clicks and impression of an SPL:

Reporting Clicks and Impressions (deprecated)

Project Agora checks the integration and confirms the success of the above process

Step 3: Discovery Sponsored Product Listings Integration

The DSPL format is integrated in the Homepage, Category, Subcategory, Search pages ,Product Pages and Cart Page and it's displayed in a separate grid from the organic product results.

Retailer integrates Sponsored Product Listings by following the next steps:

3.1 Request and response of a DSPL:

Discovery Product Listing Ad Integration Guide

3.2 Report clicks and impression of a DSPL:

Reporting Clicks and Impressions (deprecated)

Project Agora checks the integration and confirms the success of the above process

Step 4: Orders Reporting:

Retailer integrates Orders Reporting according to the following link:

Syncing Order Data

Project Agora checks the integration and confirms the success of the above process

Step 5: Static Banner integration

Retailer integrates Static Banner ads to the Homepage, Search and Category pages according to the following links:

5.1 Request and response of a Banner:

Banner Ad Integration Guide

5.2 Reporting impressions and clicks for Banners:

Reporting Clicks and Impressions (deprecated)

5.3 Reporting orders for Banners:

Syncing Order Data

Project Agora checks the integration and confirms the success of the above process

Step 6: Ingrid Static Banner integration

Retailer integrates Ingrid Static Banner ads to the Category, Subcategory and Search pages according to the following links:

6.1 Request and response of an Ingrid Banner:

Requesting an Ingrid Banner Ad

6.2 Reporting impressions and clicks for Ingrid Banners:

Reporting Clicks and Impressions (deprecated)

6.3 Reporting orders for Ingrid Banners:

Syncing Order Data