LogoLogo
  • Overview
  • What Ads Can Project Agora Commerce Serve?
  • Integration
    • API Introduction
    • Integration Workflow
      • Integration Summary
      • Integration Steps
    • Syncing Data
      • Syncing Data Via File Protocols
    • Syncing Catalog & Products
      • Syncing Catalog and Products Via File
    • Syncing Order Data
      • Syncing Order Data Via API
    • Reporting Clicks and Impressions
    • Integration Checklist
  • Integration Guides
    • HTTP Persistence & Ad Caching
    • Reference
    • Requesting Ads (the "Context" and its Parts)
    • Product Listing Ad Integration Guide
      • Requesting a Category Product Ad
      • Requesting a Search Term Product Ad
      • Requesting a Home Page Product Ad
    • Discovery Product Listing Ad Integration Guide
      • Requesting a Discovery Product Ad
    • Banner Ad Integration Guide
      • Banner Ad Content Standard
      • Requesting a Search Term Banner Ad
      • Requesting a Category Banner Ad
      • Requesting a Home Page Banner Ad
      • The Post Checkout Banner Ad Context
      • Graceful Fallback in the Event That No Ads Are Displayed
    • Banner X Ad Integration Guide
      • Banner X Ad Content Standard
      • Requesting a Category Banner X Ad
      • Requesting a Search Term Banner X Ad
      • Requesting a Home Page Banner X Ad
      • Banner X Ad Reference
      • Graceful Fallback in the Event That No Ads Are Displayed
Powered by GitBook
On this page
  • Workflow
  • Step 1: Retailer Account initialization
  • Step 2: Sponsored Product Listings Integration
  • Step 3: Discovery Sponsored Product Listings Integration
  • Step 4: Orders Reporting
  • Step 5: Banner integration
  • Step 6: In-listing Banner integration
  1. Integration
  2. Integration Workflow

Integration Steps

PreviousIntegration SummaryNextSyncing Data

Last updated 4 years ago

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:

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:

2.2 Report clicks and impression of an SPL:

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:

3.2 Report clicks and impression of a DSPL:

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:

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

Step 5: Banner integration

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

5.1 Request and response of a Banner:

5.2 Reporting impressions and clicks for Banners:

5.3 Reporting orders for Banners:

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

Step 6: In-listing Banner integration

Retailer integrates In-listing Banner ads to the Category, Subcategory and Search pages according to the following links:

5.1 Request and response of an In-listing Banner:

5.2 Reporting impressions and clicks for In-listing Banners:

5.3 Reporting orders for In-listing Banners:

Syncing Catalog and Products Via File
Product Listing Ad Integration Guide
Reporting Clicks and Impressions
Discovery Product Listing Ad Integration Guide
Reporting Clicks and Impressions
Syncing Order Data
Banner Ad Integration Guide
Reporting Clicks and Impressions
Syncing Order Data
Banner X Ad Integration Guide
Reporting Clicks and Impressions
Syncing Order Data