This article describes how to access the Connexity Product Key Feed, also called 'Publisher Exports'. The Product Key Feed is a primary method for publishers to integrate merchant product offer data in order to monetize content on Connexity.
Links to Key Topics In This Article
OVERVIEW
What is the Product Key Feed?
The Product Feed is a primary method for publishers to integrate merchant product offer data in order to monetize content on Connexity. Downloading files from the feed produces files in JSON or CSV format that Publishers can utilize to develop commerce monetization components within their own content sites.
What files are available?
Below is a list of the types of files a publisher can access
| File | Description |
| Offer files | Contains actual offer content |
| Merchant Info | Contains merchant data for every merchantId appearing in the offer feed files |
| Category Info | Contain taxonomy tree of category and atoms |
| Index Files | A single file listing the urls that are used to access all other available files for the publisher |
| Build Info | Basic info about the feed files ( time of last update, file count, etc.) |
| Attribute Mapping | Mapping of attribute ID to value ID, including names and labels ( * not enabled by default) |
| ECPC | Contains the ECPCs for the offer content |
| Product | Contains product data |
| PLA | Contain PLA feeds |
Format
All files are GZIP compressed with the exception of the build info files to optimize download bandwidth. The content of the offer files is UTF-8 encoded and the structure is either JSON- or CSV-formatted, depending on the file extension you choose. The CSV-formatted files are TAB separated. Please note that the CSV-formatted files are currently only available for the offer files. We plan to release the CSV-formatted merchants, categories, and publisher_build files in the near future.
Additionally, we may add more elements to the JSON-formatted files without notification. We will provide notification if an element is to be deprecated. Similarly, we may add additional fields to the CSV formatted files. To be best prepared for this situation, please structure your code to read the CSV column headers, rather than being reliant on column order as the column order may change if we add or deprecate fields.
---
Latest Changes
This section reviews the most recent updates made to publisher exports
Date: 2020-08-26
Change: Added new field to the offer file
Google Category Id
-The export now contains the new field googleCategoryId for all publishers. It contains the Google category for the given offer
Date: 2019-04-08
Change: Added new field to the offer file
Unit Pricing Fields
The export now contains two new fields,
-unitPricingMeasure
-unitPricingBaseMeasure
Note: This feature is currently activated only for European feeds. Please contact your account manager to have this feature enabled for a US feed.
HOW TO DOWNLOAD FILES
Authentication
Every URL must have your Publisher ID and API key appended as parameters as follows (replace [PUBLISHER_ID] and [API_KEY] with your credentials in ALL samples in these instructions):
https://publisherexports.connexity.com/feeds/[FILE_NAME]? publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Sample Request URL
https://publisherexports.connexity.com/feeds/mid/index.txt.gz?publisherId=12345&apiKey=5735c3e128a7fe4290857585e9b9f0w3
This applies to the index URLs, as well as any URL listed within the index. An invalid or missing Publisher ID or API key will prevent the file from being downloaded.
Opening downloaded files
As mentioned above, all files are GZIP compressed. Once you download the file of your choosing you will need to unzip the downloaded files to see the json/csv formatted file content.
Sample Command to Uncompress
gunzip index.txt.gz
Downloading Index files
The index provides a list of URLs for every file available for download. There are several versions of the index, accessible at different URLs, depending on how you prefer to download the feed files. The file paths in the index are updated every time a new feed set is generated. The recommended practice is to download the index file every time you are downloading a new feed set to ensure you have the correct paths.
By default, the index displays JSON formatted offer files in addition to the merchants.json, categories.json, and publisher_build.json files . You can append a format param to the sample request url to control the format of those files, format=json or format=csv.
Sample Request URL
https://publisherexports.connexity.com/feeds/mid/index.txt.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example Content:
https://pubresources.connexity.com/hc/en-us/articles/9761805014557-Publisher-Exports-v2
https://publisherexports.connexity.com/feeds/mid/merchants.json.gz
https://publisherexports.connexity.com/feeds/mid/categories.json.gz
https://publisherexports.connexity.com/feeds/mid/publisher_build.json
https://publisherexports.connexity.com/feeds/mid/613153_ecpc.gz
https://publisherexports.connexity.com/feeds/mid/277311_part001.json.gz
https://publisherexports.connexity.com/feeds/mid/277371_part001.json.gz
https://publisherexports.connexity.com/feeds/mid/287381_part001.json.gz
https://publisherexports.connexity.com/feeds/mid/287997_part001.json.gz
https://publisherexports.connexity.com/feeds/mid/296676_part001.json.gz
Sample Request URL for csv formatted files for offer data:
https://publisherexports.connexity.com/feeds/mid/index.txt.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY}&format=csv
Example Content:
https://pubresources.connexity.com/hc/en-us/articles/9761805014557-Publisher-Exports-v2
https://publisherexports.connexity.com/feeds/mid/merchants.json.gz
https://publisherexports.connexity.com/feeds/mid/categories.json.gz
https://publisherexports.connexity.com/feeds/mid/publisher_build.json
https://publisherexports.connexity.com/feeds/mid/613153_ecpc.gz
https://publisherexports.connexity.com/feeds/mid/merchants.csv.gz
https://publisherexports.connexity.com/feeds/mid/categories.csv.gz
https://publisherexports.connexity.com/feeds/mid/publisher_build.csv
https://publisherexports.connexity.com/feeds/mid/613153_ecpc.csv.gz
https://publisherexports.connexity.com/feeds/mid/277311_part001.csv.gz
https://publisherexports.connexity.com/feeds/mid/277371_part001.csv.gz
https://publisherexports.connexity.com/feeds/mid/287381_part001.csv.gz
https://publisherexports.connexity.com/feeds/mid/287997_part001.csv.gz
Sample Request for mature files:
https://publisherexports.connexity.com/feeds/mature/mid/index.txt.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Sample Response:
https://pubresources.connexity.com/hc/en-us/articles/9761805014557-Publisher-Exports-v2
https://publisherexports.connexity.com/feeds/mature/mid/merchants.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/categories.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/publisher_build.json
https://publisherexports.connexity.com/feeds/mature/mid/613153_ecpc.gz
https://publisherexports.connexity.com/feeds/mature/mid/287997_part001_mature.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/296676_part001_mature.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/298753_part001_mature.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/313201_part001_mature.json.gz
Downloading Offer Files
Offer files contain merchant offer content. These files can be grouped by either:
-
Merchant offer files
a) Contains all the offers for a given merchant
b) File name format: [merchantId]_part[NNN].[json|csv].gz
-If a merchant has a very high number of offers, there will be multiple [merchantId]_part[NNN]. [json|csv].gz files containing the offers for that merchant
c) This is the preferred method for downloading merchant offer files as it is the most efficient method. -
Merchant/atom offer files
a) Contains all the offers for a single merchant within a single category
b) File name format: [merchantId]_[atomId].[json|csv].gz
c) This method is used if you want to retrieve offers for specific merchants and/or select specific categories. This download method is the least efficient way to download offer data as there will be many more files to download.
Example Request URLsMerchant Offer Files
JSON:
https://publisherexports.connexity.com/feeds/mid/[MERCHANT_ID]_part[NNN].json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/[MERCHANT_ID]_part[NNN].csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Merchant/atom Offer Files
JSON:
https://publisherexports.connexity.com/feeds/[MERCHANT_ID]_[ATOM_ID].json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/[MERCHANT_ID]_[ATOM_ID].csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example JSON Content
{
"offers": {
"offer": [
{
"rawUrl": "http://clickserve.dartsearch.net/link/click?lid=43700043373941375&ds_s_kwgid=58700000406303617&ds_url_v=2",
"atomId": "331",
"categoryId": "330",
"type": "OFFER",
"sku": "192485192308",
"url": {
"value": "https://rd.bizrate.com/rd?t=http%3A%2F%2Fclickserve.dartsearch.net%2Flink%2Fclick%3Flid%3D43700043373941375%26ds_s_kwgid%3D58700000406303617%26ds_url_v%3D2%26cnxclid%3DSZ_REDIRECT_ID&mid=201885&cat_id=330&atom=331&prod_id=&oid=9998250560&pos=1&b_id=18&bid_type=10&bamt=be85fa8f6ad737f6&cobrand=1&ppr=0753b1f639179e1d&a=c1c15df77db6d013f3988d87ff6c96e3&rf=af1&af_assettype_id=12&af_creative_id=2973&af_id=[PUBLISHER_ID]&af_placement_id=1&dv=6a980664502a3ae8afccb1bec1ea9eaa28267feaa4540b58"
},
"id": "9998250560",
"shipType": "FREE",
"title": "Tory Burch Lettuce Ware Oval Serving Platter, Pale Pink",
"revType": "2",
"price": {
"value": "$139.00",
"integral": "13900"
},
"stock": "IN",
"originalPrice": {
"value": "$198.00",
"integral": "19800"
},
"manufacturer": "Tory Burch",
"description": "Directly from Tory Burch - The Lettuce Ware Oval Serving Platter was created in collaboration with iconic potter Dodie Thayer. Known as the 'Pottery Queen of Palm Beach,' Dodie was a true American artisan and entrepreneur, whose pieces have been...",
"images": {
"image": [
{
"value": "https://d6.cnnx.io/image/obj/9998250560;sq=400;p=0;t=ooPwmIQDTT7OTxVRVUE-bxiyoBoj-GdO4DRRcHTOn6XJ0BaoTm15Yqg5Qoav_-6LOHIA7xrC1qcVNJ0MQO8aAcaTP1I1-zPT",
"xsize": 400,
"ysize": 400
}
]
},
"merchantId": "201885",
"merchantProductId": "192485192308",
"shipAmount": {
"value": "$0.00",
"integral": "0"
},
"markdownPercent": "29.80",
"ean13": "0192485192308",
"estimatedCPC": {
"value": "$0.05",
"integral": "5"
},
"gtin": "0192485192308",
"upc": "192485192308",
"googleCategoryId": "Home & Garden > Kitchen & Dining > Tableware > Serveware > Serving Platters"
}
]
}
}
Example CSV Content
rawUrl atomId categoryId pid type sku url id shipType title revType priceValue priceIntegral stock originalPriceValue originalPriceIntegral manufacturer description image merchantId merchantProductId shipAmountValue shipAmountIntegral markdownPercent brandId promoText ean13 estimatedCPCValue estimatedCPCIntegral energyEfficiencyClass unitPrice deliveryPeriod tireFuelEfficiency tireWetGrip tire_noise_emission asin gtin upc googleCategoryId
https://www.lyst.com/track/redirect/827878533/?_country=US&atc_medium=cpc&atc_source=connexity&atc_campaign=CONNEXITY-US-PLA-CSS&atc_grouping=css&atc_country=US 100001760 100001746
OFFER
https://rd.bizrate.com/rd?t=https%3A%2F%2Fwww.lyst.com%2Ftrack%2Fredirect%2F827878533%2F%3F_country%3DUS%26atc_medium%3Dcpc%26atc_source%3Dconnexity%26atc_campaign%3DCONNEXITY-US-PLA-CSS%26atc_grouping%3Dcss%26atc_country%3DUS%26szredirectid%3DSZ_REDIRECT_ID&mid=301794&cat_id=100001746&atom=100001760&prod_id=&oid=20941393038&pos=1&b_id=18&bid_type=8&bamt=be85fa8f6ad737f6&cobrand=1&ppr=609cb6d102015a38&a=997857b5f4fc74bf39d26adae011fc9f&rf=af1&af_assettype_id=12&af_creative_id=2974&af_id=[PUBLISHER_ID]&af_placement_id=1&dv=6a980664502a3ae83b9d3ff07eddf8c4309709a14d552f7a 20941393038 FREE Ssense Exclusive Amber Playsuit Dress 2 $490.00 49000 IN $490.00 49000 POSTER GIRL Women's POSTER GIRL Ssense Exclusive Amber Playsuit Dress - Purple - Playsuits Sleeveless sheer stretch nylon mesh short dress in purple. Adjustable elasticized spaghetti shoulder straps in green. Cowl neckline · Cut-out at side-seams and back ·...
https://d9.cnnx.io/image/obj/20941393038;sq=400;p=0;t=ooPwmM0WTWKaBQ9dCVQlaXG3APsrIqMlUDhbHVgdpLei9III6-B7il-Qo5XZDn-XLsCARuBync30a3QupkmqaulAZCc_uUC6ZgsPSjBuiMx101jQ15m_PT_1ILK1nzsoXRWE4US3Ka3OGSW_mp9VswsGd9edsb4BexJ_sg== 301794 17953469348 $0.00 0
$0.01 1
Apparel & Accessories > Clothing > Baby & Toddler Clothing > Baby & Toddler Dresses
https://www.lyst.com/track/redirect/796507616/?_country=US&atc_medium=cpc&atc_source=connexity&atc_campaign=CONNEXITY-US-PLA-CSS&atc_grouping=css&atc_country=US 10299 10060500 OFFER https://rd.bizrate.com/rd?t=https%3A%2F%2Fwww.lyst.com%2Ftrack%2Fredirect%2F796507616%2F%3F_country%3DUS%26atc_medium%3Dcpc%26atc_source%3Dconnexity%26atc_campaign%3DCONNEXITY-US-PLA-CSS%26atc_grouping%3Dcss%26atc_country%3DUS%26szredirectid%3DSZ_REDIRECT_ID&mid=301794&cat_id=10060500&atom=10299&prod_id=&oid=18986897604&pos=1&b_id=18&bid_type=10&bamt=42cebdc0db812186&cobrand=1&ppr=aabb6ef7d17d226d&a=997857b5f4fc74bf39d26adae011fc9f&rf=af1&af_assettype_id=12&af_creative_id=2974&af_id=[PUBLISHER_ID]&af_placement_id=1&dv=6a980664502a3ae83b9d3ff07eddf8c4309709a14d552f7a 18986897604 CUSTOM Velvet Shirt 2 $105.83 10583 IN $249.00 24900 ERL Men's ERL Velvet Shirt - Natural - Casual shirts Loose fit shirt by ERL in stretch cotton velvet, featuring a small patch pocket on the chest with tone-on-tone embroidered logo lettering. Classic collar, mother-of-pearl buttons. Straight cut with small... https://d10.cnnx.io/image/obj/18986897604;sq=400;p=0;t=ooPwmM0WTWKaBQ9cCVQlafl2eCQ2lfHCkU3no1eW6lvMNXDsLoWFSOUmHhJmBfHSTdwGd-yNUZVRmnLpLb7x8gBB15TC9rHStPD1yZclwNbIRzVtvOZY3YpFPkg-wrLzeXKJl01Cb35zOkSzW-M= 301794 12348036970 $20.00 2000 57.50 3607934890942 $0.01 1
3607934890942 Apparel & Accessories > Clothing > Shirts & Tops
Offer File Data Fields
Connexity has worked with publishers to identify fields that are most critical to publisher success and provided them below. Contact our technical support team if there are specific fields you require access to.
| Field | Definition | Notes |
| rawUrl | The deeplink to the offer as provided by the shop. |
This URL can’t be used for tracking redirects, so don’t use it for that purpose, you won’t get paid.
|
| atomId | The most granular unit in Biztate | |
| url | Redirect URL for the product offer’s page on Bizrate. | If you wish to group your redirects for campaign tracking and/or reporting purposes, append either the ‘af_campaign_id’ or ‘af_placement_id’ parameter to this URL. Please see placement_id for more details. |
| shipType | Type of Shipping | |
| stock | Stock info about the offer. |
Accepted values :
|
| categoryId | Category ID. Unique Id that describes a single category | |
| title | Title of the product being offered. | |
| type | Defines the granularity of the data, either PRODUCT or OFFER. | |
| id | The offer ID. This is a unique identifier for each product offer. | |
| pid | Connexity’s product ID (when available) | Multiple offers may share the same pid when different merchants are selling the same product. |
| description | The detailed description of the product being offered. | |
| merchantId | The merchant ID. This is unique to every merchant. | |
| merchantProductId | A product ID assigned to this offer by the merchant. | Connexity cannot guarantee the uniqueness of this value as it is assigned by the merchant who is selling the product. |
| shipAmount | Expected costs for shipping | |
| images | The URL for the product image | See ‘Image Urls’ section below for further information. |
| manufacturer | The product’s manufacturer | |
| sku | Merchant provided SKU. Used in conjunction with Manufacturer & UPC/EAN to map listings |
Examples include ISBN for books, MPN for Computer Hardware & Software, and Manufacturer Model Number for Electronics. |
| revType | A value that defines the revenue type assigned to this product. | See ‘Rev Type’ section below for further information. |
| ean13 | European Article Numbers also called International Article Numbers is similar to the UPC except EAN is a 13-digit number that contains country code as the leading digit. |
We include US UPC Codes with a leading zero into this field as EAN code. This field is also where the ISBN is provided for books. Example EAN vs UPC: EAN = 0012345678905 UPC = (0)012345678905 or 012345678905 |
|
estimatedCPC |
Estimated cost per click | estimatedCPC for a valid click on a single offer, therefore will give you the most accurate insight into the monetization opportunities. The real CPC for a valid offer click depends on many different factors, which are not known before the click happens, therefore this eCPC value is only a best guess, the final/real CPC can vary. |
| originalPrice | The regular purchase price before any discounts. | |
| price | The current purchase price. | |
| markdownPercent | The discount percentage from originalPrice to price. | |
| brandId | The product’s brand identifier. | |
| promoText | Description of promotional offer. | |
| energyEfficiencyClass ** EU only |
The energy efficiency class of the product. | |
| unitPrice ** EU only |
The price of the base unit of the product. | Example: €15,92 / 100 ml) |
| deliveryPeriod ** EU only |
The shipping period for the product. | |
| tireFuelEfficiency, tireWetGrip, tireNoiseEmission ** EU only |
EU tire label information for tire products, as provided by the merchant. |
|
| asin | Amazon Standard Identification Number | |
| gtin | Global Trade Item Number | |
| upc | Universal Product Number | |
| attributes * disabled by default |
Mapping from attributeId to valueId | See ‘Attributes section below for further information. |
| unitPricingMeasure ** by default EU only |
The measure or weight of the Product. |
Example: 125ml |
| unitPricingBaseMeasure ** by default EU only |
The measure on which the price per packaging unit is based. |
Example: 100ml |
| googleCategoryId | The Google category of the offer | |
| certificationAuthority (**EU only) | The authority or certification body responsible for issuing the certification | 'EC' or 'European Commission' |
| certificationName (**EU only) | The name of the certification | 'EPREL'. Represents energy efficiency certifications in the EU |
| eprelCertificationCode (**EU only) | The code of the certification |
feed.
** EU only: these attributes are available for feed to European customers
Image Urls
Connexity provides a single image url per offer in the feed. However, it is still possible to retrieve images of different sizes by changing the url's size parameters. For square images, the single parameter, sq, can be used to return images with equal width and height. Alternatively, you can specify the width (w) and height (h) parameters for nonsquare images (note: extra space gets padded with white).
400 x 400 pixels: http://d1-pub.bizrate.com/image/obj/1000000;sq=400;p=1
100 x 200 pixels: http://d1-pub.bizrate.com/image/obj/1000000;w=100;h=200;p=1
Rev Type
Provides greater insight into the monetization opportunities in the content itself by identifying revenue types by offer (CPA vs CPC).
Rev Type Summary
revType=1 (CPA - Affiliate) - Based on commission from sales over 30 days
revType=2 (CPC )- Cost per click based on merchant / publisher performance
Offers are associated with a merchant that is either a CPC or a CPA merchant.
- CPA: Cost per Acquisition - represents the commission percentage earned for a sale
- CPC: Cost per Click - Refers to the amount bid by a merchant for each click
Downloading Merchant Info Files
The merchants.json file is included in the root of your home directory and includes merchant information corresponding to each merchant id (MID) in the offer feed files.
File name format: merchants.json.gz
Sample request URLS:
JSON:
https://publisherexports.connexity.com/feeds/mid/merchants.json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/merchants.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]&format=csv
Example JSON Content
{
"merchant": [
{
"mid": "24",
"merchantInfo": {
"name": "1800Flowers.com",
"url": "https://rd.bizrate.com/rd?t=http%3A%2F%2Fwww.1800flowers.com%2F&mid=24&cat_id=&prod_id=&oid=&pos=1&b_id=18&a=527c5574026bae1d9585ffc8da981cc6&rf=af1&af_assettype_id=12&af_creative_id=2973&af_id=621511&af_placement_id=1",
"merchantUrl": "https://www.1800flowers.com/",
"logoUrl": "https://s10.cnnx.io/merchant/24.gif",
"logoUrlSmall": "https://s10.cnnx.io/merchant/little/24.gif"
},
"merchantRating": {
"rating": {
"dimensionalAverages": {
"average": [
{
"value": "0.0",
"dimension": "ffOverallRating"
}
]
}
}
}
},
{
"mid": "29",
"merchantInfo": {
"name": "Lands' End",
"url": "https://rd.bizrate.com/rd?t=http%3A%2F%2Fwww.landsend.com%2F&mid=29&cat_id=&prod_id=&oid=&pos=1&b_id=18&a=bebafbceaa4efb644d80f4e2302ac53e&rf=af1&af_assettype_id=12&af_creative_id=2973&af_id=621511&af_placement_id=1",
"merchantUrl": "http://www.landsend.com/",
"logoUrl": "https://s10.cnnx.io/merchant/29.gif",
"logoUrlSmall": "https://s10.cnnx.io/merchant/little/29.gif"
},
"merchantRating": {
"rating": {
"dimensionalAverages": {
"average": [
{
"value": "0.0",
"dimension": "ffOverallRating"
}
]
}
}
}
}
]
}
*Note: Although merchantRating Field is displayed in the offer json data above, we no longer provide data for this field
Example CSV Content
mid name url merchantUrl logoUrl logoUrlSmall ffProductMetExpectation ffCustomerSupport ffProductAvailability ffLikelihoodToBuyAgain ffOverallRating
24 1800Flowers.com https://rd.bizrate.com/rd?t=http%3A%2F%2Fwww.1800flowers.com%2F&mid=24&cat_id=&prod_id=&oid=&pos=1&b_id=18&a=527c5574026bae1d9585ffc8da981cc6&rf=af1&af_assettype_id=12&af_creative_id=2973&af_id=621511&af_placement_id=1 https://www.1800flowers.com/ https://s10.cnnx.io/merchant/24.gif https://s10.cnnx.io/merchant/little/24.gif 0.0
29 Lands' End https://rd.bizrate.com/rd?t=http%3A%2F%2Fwww.landsend.com%2F&mid=29&cat_id=&prod_id=&oid=&pos=1&b_id=18&a=bebafbceaa4efb644d80f4e2302ac53e&rf=af1&af_assettype_id=12&af_creative_id=2973&af_id=621511&af_placement_id=1 http://www.landsend.com/ https://s10.cnnx.io/merchant/29.gif https://s10.cnnx.io/merchant/little/29.gif 0.0
Downloading Build Info Files
A small file named publisher_build.json contains basic info about the feed files.
File name format: publisher_build.[json|csv]
Example Request URLs
JSON:
https://publisherexports.connexity.com/feeds/mid/publisher_build.json?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/publisher_build.csv?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]&format=csv
Example JSON Content
{
"build": {
"timestamp": "2022-07-14 16:30:07",
"version": "valid_offers_2022-07-14-15-20-09_963",
"totalFiles": 211
}
}
Example CSV Content
timestamp version totalFiles
2022-07-14 16:30:07 valid_offers_2022-07-14-15-20-09_963 211
Downloading Category Info Files
The categories.json file is a full taxonomy tree of categories and atoms. It provides a description for every cid (category id) and atomId found in the offer files.
File name format: categories.[json|csv].gz
Example Request URLs
JSON:
https://publisherexports.connexity.com/feeds/mid/categories.json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/categories.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example JSON Content
{
"taxonomy": {
"categories": {
"category": [
{
"name": "Computers & Software",
"probability": 0,
"url": "https://www.bizrate.com/computers_software/?rf=af1&af_assettype_id=10&af_creative_id=2975&af_id=[PUBLISHER_ID]&af_placement_id=1",
"children": {
"category": [
{
"name": "Headsets & Microphones",
"probability": 0,
"url": "https://www.bizrate.com/headsets_microphones/?rf=af1&af_assettype_id=10&af_creative_id=2975&af_id=[PUBLISHER_ID]&af_placement_id=1",
"atoms": {
"atom": [
{
"name": "Headsets & Microphones",
"probability": 0,
"id": 9402
}
]
},
"id": 482,
"mature": false
}
]
}
}
]
}
}
}
Example CSV Content
name categoryId atomId minimumBid probability childCategories atoms url mature
Computer Game Controllers 492 0.0 10050 https://www.bizrate.com/game-controllers/?rf=af1&af_assettype_id=10&af_creative_id=2975&af_id=[PUBLISHER_ID]&af_placement_id=1 false
Computer Game Controllers 10050 0.0
Computer Keyboards 493 0.0 10051 https://www.bizrate.com/computer-keyboards/?rf=af1&af_assettype_id=10&af_creative_id=2975&af_id=[PUBLISHER_ID]&af_placement_id=1 false
Downloading ECPC Files
If your account has the stand-alone ecpc feature enabled, an additional ecpc file will be listed in the index.txt.gz file. This file contains the offer ids and the respective ECPC’s for each offer.
File name format: [PUBLISHER_ID]_ecpc.gz or [PUBLISHER_ID]_ecpc.csv.gz
Sample request URLS:
JSON: https://publisherexports.connexity.com/feeds/mid/[PUBLISHER_ID]_ecpc.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV: https://publisherexports.connexity.com/feeds/mid/[PUBLISHER_ID]_ecpc.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example JSON Content
{"id":"15985679857","ecpc":0.01}
{"id":"15985692757","ecpc":0.00}
{"id":"16029673357","ecpc":0.02}
{"id":"18421253447","ecpc":0.01}
{"id":"16052476957","ecpc":0.03}
{"id":"16063348357","ecpc":0.02}
{"id":"18421262747","ecpc":0.01}
Example CSV Content
id ecpc
17930367559 0.00
20270789502 0.41
17951769859 0.05
20276782602 0.02
Downloading Mature/Adult Files
These files only contain offers/content for mature/adult categories and are not included in the other feeds. The mature offers are provided in the same format as the individual feed files, using the naming convention:
[merchantId]_part[NNN]_mature.[json|csv].gz (for offer files grouped by merchant)
[merchantId]_[atom]_mature.[json|csv].gz (for merchant/atom offer files)
The index URL for mature files is similar to the index file URL referenced at the beginning of the documentation. The difference is the url path includes /feeds/mature/mid/ instead of /feeds/mids/. The process for downloading and unzipping these files to view the file content is the same as the instructions in above sections.
Example index file
https://publisherexports.connexity.com/feeds/mature/mid/index.txt.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example index file
https://publisherexports.connexity.com/feeds/mature/mid/merchants.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/categories.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/publisher_build.json
https://publisherexports.connexity.com/feeds/mature/mid/613153_ecpc.gz
https://publisherexports.connexity.com/feeds/mature/mid/287997_part001_mature.json.gz
https://publisherexports.connexity.com/feeds/mature/mid/296676_part001_mature.json.gz
Downloading Product Files
These files contain product data. By default this product feature is disabled for publishers. Please contact your Account Manager if you need access to this data.
File name format: products.json.gz or products.csv.gz
Sample request URLS:
JSON:
https://publisherexports.connexity.com/feeds/mid/products.json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/products.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example JSON Content
{
"products": {
"product": [
{
"id": "1000000",
"title": "Our Shining Hour by Sammy Davis, Jr. (CD - 07/26/1994)",
"type": "PRODUCT",
"atomId": "10094",
"categoryId": "5212",
"upc": "042283744622",
"image": "http://d1-pub.bizrate.com/image/obj/1000000;sq=400;p=1"
},
{
"id": "1000001",
"title": "Private Time by Walter Beasley Project (Cassette - 08/22/1995)",
"type": "PRODUCT",
"atomId": "10092",
"categoryId": "5209",
"upc": "731452818249",
"image": "http://d2-pub.bizrate.com/image/obj/1000001;sq=400;p=1"
}
]
}
}
Example CSV Content
id title description type atomId categoryId brand upc sku image totalReviews avgScore
1000000 Our Shining Hour by Sammy Davis, Jr. (CD - 07/26/1994) PRODUCT 10094 5212 042283744622 http://d1-pub.bizrate.com/image/obj/1000000;sq=400;p=1
1000001 Private Time by Walter Beasley Project (Cassette - 08/22/1995) PRODUCT 10092 5209 731452818249 http://d2-pub.bizrate.com/image/obj/1000001;sq=400;p=1
Downloading PLA Index Files
The index provides a list of URLs for every file available for download. There are several versions of the index, accessible at different URLs, depending on how you prefer to download the feed files. The file paths in the index are updated every time a new feed set is generated. It is important to download the index file every time you are downloading a new feed set to ensure you have the correct paths.
The PLA index displays CSV formatted offer files in addition to the merchants.json, categories.json, and publisher_build.json files.
Sample Request URL
https://publisherexports-beta.connexity.com/feeds/mid/index_pla.txt.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Downloading PLA Feed Files
Provides PLA feeds that are compatible with Google feed specifications. This differs from Offer files in that PLA enabled publishers can download these PLA feeds for upload to their Google ad accounts directly and without further transformation. Learn more about utilizing PLA Feed Data.
File name format: {mid}_pla_part{part}.csv.gz, {mid}_pla_{atomId}.csv.gz
Sample request URLS:
part:
https://publisherexports-beta.connexity.com/feeds/mid/{mid}_pla_part{part}.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
atom:
https://publisherexports.connexity.com/feeds/{mid}_pla_{atomId}.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example CSV Content
id title description link image_link condition availability price sale_price material pattern google_product_category gender age_group color size item_group_id brand gtin mpn shipping_weight shipping product_type identifier_exists energy_efficiency_class min_energy_efficiency_class max_energy_efficiency_class
1234567890 ProductTitle Product description very good product https://linkToProduct-On-The-Internet https://linkToProductImage-On-The-Internet new in_stock 24.99 USD Office Supplies > Filing & Organization > Calendars, Organizers & Planners unisex Grey 1234567890 Brand Name 1234567890 mpnGY1-UPC US:::0.00 USD yes
1234567890 ProductTitle Product description very good product https://linkToProduct-On-The-Internet https://linkToProductImage-On-The-Internet new in_stock 24.99 USD Office Supplies > Filing & Organization > Calendars, Organizers & Planners unisex Grey 1234567890 Brand Name 1234567890 mpnGY1-UPC US:::0.00 USD yes
PLA File Data Fields
The following fields are present in the PLA feed files and will be populated if provided in the publisher export job:
| Field | Definition | Required |
| id | Product Identifier | Required |
| title | Product title | Required |
|
description |
Product description |
Required |
| link | Landing page url | Required |
| image_link | Image url | Required |
| condition | Products condition (new, used, etc.) | Optional |
| availability | Products availability | Required |
| price | Price of product | Required |
|
sale_price |
Price if product on sale |
Optional |
|
material |
Product material (required for clothing categories) | Required for clothing categories |
| pattern | Product pattern (required for clothing categories) | Required for clothing categories |
| google_product_category | Product category. Google will map to a category if not provided. | Optional |
| gender | Gender for which product is intended | Required for clothing categories |
| age_group | Age group for which product is intended | Required for clothing categories |
| color | Product color | Required for clothing categories |
| size | Product size | Required for clothing categories |
| item_group_id | ID for a group of products that come in different versions Product’s brand name |
Required for clothing categories |
| brand | Product’s brand name |
Required (For all new products, except movies, books, and musical recording brands) Optional for all other products. |
| gtin | Product’s global trade item number | Required for all products with a GTIN assigned by the manufacturer. |
| mpn | Your product’s Manufacturer Part Number (mpn) | Required (Only if your product does not have a manufacturer assigned GTIN) Optional for all other products. |
| shipping_weight | The weight of the product used to calculate the shipping cost | Optional |
| shipping | Your product's shipping cost, shipping speeds, and the locations your product ships to. | Required |
| product_type | Product category that you define for your product | Optional |
| identifier_exists | Use to indicate whether or not the unique product identifiers (UPIs) GTIN, MPN, and brand are available for your product. | Required - required and set to true if gtin, mpn, or brand not provided |
| energy_efficiency_class | Your product’s energy label | Optional (except when required by local law or regulations) |
| min_energy_efficiency_class | Your product’s energy label Available for EU & CH only |
Optional (except when required by local law or regulations) |
| max_energy_efficiency_class | Your product’s energy label Available for EU & CH only |
Optional (except when required by local law or regulations) |
| custom_label_0 |
The Connexity merchant ID. This is unique to every merchant. |
Allows you to create specific filters. |
| custom_label_1 | Contains the ECPC for the offer content | Allows you to create specific filters. |
| custom_label_2 | ecpc Multiplier Key value (please see eCPC multiplier File documentation for details) |
Allows you to create specific filters. |
| certificationAuthority (**EU only) | The authority or certification body responsible for issuing the certification | Optional (except when required by local law or regulations) |
| certificationName (**EU only) | The name of the certification | Optional (except when required by local law or regulations) |
| eprelCertificationCode (**EU only) | The code of the certification | Optional (except when required by local law or regulations) |
| unitPrice (**EU only) | The price of the base unit of the product | Optional (except when required by local law or regulations) |
| unitPricingMeasure (**EU only) | The measure or weight of the Product | Optional (except when required by local law or regulations) |
| unitPricingBaseMeasure (**EU only) | The measure on which the price per packaging unit is based | Optional (except when required by local law or regulations) |
PLA limitations
- Batch PLA feeds are not supported.
- Mature PLA feeds are not supported.
- JSON feeds are not supported.
Attributes
By default, publishers do not receive the attribute mapping information with each offer and are not able to download the attribute file. Attributes provide the opportunity to group and filter offers according to product features (for example size, storage space, resolution, color, speed, weight etc).
For CSV format, value pairs are separated by ';'. Note that an attribute ID may appear multiple times if it matches several attribute values at the same time.
CSV formatted attribute field example:
625551:4821;625551:1;324045:4821;296935:12;265558:10242
JSON formatted attribute field example:
offer: [ { ... "attributes": [ {"id":"296935","values":["12"]}, {"id":"265558","values":["10242"]}, {"id":"625551","values":["4821","1"]}, {"id":"324045","values":["4821"]} ] ... }]
Downloading Attribute Mapping Files
If your account has the attribute feature enabled, an additional file attribute_mapping.json.gz (or attribute_mapping.csv.gz) will be listed in the index.txt.gz file. This file contains the mapping from the attributeId to the respective attributeName as well as to the valueIds and the attributeValues.
File name format: attribute_mapping.[json|csv].gz
Sample request URLS:
JSON:
https://publisherexports.connexity.com/feeds/mid/attributes/attribute_mapping.json.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
https://publisherexports.connexity.com/feeds/mid/attributes/attribute_mapping.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
Example JSON Content Example
[
{
"attributeId": "777442",
"attributeName": "Swimsuit Styles",
"values": [
{
"valueId": "",
"attributeValue": ""
}
]
},
{
"attributeId": "777440",
"attributeName": "Jeans Fit",
"values": [
{
"valueId": "270429",
"attributeValue": "Straight Leg"
},
{
"valueId": "270430",
"attributeValue": "Slim Fit"
},
{
"valueId": "279706",
"attributeValue": "Loose Fit"
}
]
}
]
Example CSV Content
attributeId attributeName valueId attributeValue
777440 Jeans Fit 304109 Regular Fit
777440 Jeans Fit 298077 Relaxed Fit
777440 Jeans Fit 298073 Boot Cut
777440 Jeans Fit 558569 Skinny Fit
Downloading ECPC Multiplier Files
This file provides Publishers data to identify the best performing content, using Publisher IDs, to optimize towards the best possible eCPC. The file contains a Publisher ID, Placement ID, eCPC Multiplier, and an eCPC Multiplier Key. Using this data in conjunction with the Offer File gives Publishers a more accurate eCPC metric to optimize for, and to identify top performing content.
The eCPC multiplying factor, for any active Placement IDs that have been used to track feed based monetization, can be applied to the offer eCPC to provide a more accurate earnings estimation.
By default this feature is NOT enabled for publishers. The URL for accessing this file is not displayed in the index file. Please contact your account manager to active this for you.
File name format: ecpc_multiplier_feed.[json|csv].gz
Sample request URLS:
JSON:
http://publisherexports.connexity.com/feeds/ecpc_multiplier_feed.csv.gz?publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]
CSV:
http://publisherexports.connexity.com/feeds/ecpc_multiplier_feed.csv.gz?publisherId=[PUBLISHER_ID&apiKey=[API_KEY]
Example JSON Content Example
offer
0
rawUrl "https://www.retailername.…Connexity&utm_medium=CSE"
atomId "10118"
categoryId "8014"
type "OFFER"
sku "740233"
url {…}
id "27031029909718"
shipType "UNKNOWN"
title "Thanksgiving Feast"
revType "2"
price {…}
stock "IN"
originalPrice {…}
manufacturer "Retailer Name"
description "Get FREE shipping on… to form the perfect..."
images {…}
merchantId "1269"
merchantProductId "7223533"
markdownPercent "50.00"
estimatedCPC
value "$0.10"
integral "10"
googleCategoryId "Media > Books"
ecpcMultiplierKey "ce0783a771874b3b30b3611a0…b12403ace142515a4c1994299c"
Example CSV Content
publisherId placementId ecpcMultiplier ecpcMultiplierKey
123456 200 0.51 ce0783a771874b3b30b3611a0…b12403ace142515a4c1994299c
How to Use the eCPC Multiplier
In the above example the estimatedCPC value ($0.10) would be multiplied by the ecpcMultiplier factor (0.51) to provide the publisher with a more accurate estimated CPC value ($0.05) for this offer and Placement ID: $0.10 * 0.51 = $0.05. Use this ECPC to identify high performing content.
Notes:
-If there is no ecpcMultiplierKey match between the offer and a placementID multiplier then the ECPC value in the offer file is to be used.
-Only Placement IDs that have been used to track feed based traffic will be represented in the ECPC Multiplier File.
Checking for Updates
Checking for updates to determine if new feed files are available for download, you can compare the version attribute of the current publisher_build.json with the one from the last download (note: the timestamp attribute would work just as well). You can also determine when the feed files were last updated by checking the "LastModified" HTTP header of the index file's URL. The time in "Last-Modified" will only change when the feed files have been updated.
An example using curl:
$curl -s -D - 'https://publisherfeeds.connexity.com/feeds/index.txt.gz? publisherId=[PUBLISHER_ID]&apiKey=[API_KEY]' -o /dev/null HTTP/1.1
200 OK
Server: Apache-Coyote/1.1
Content-Disposition: attachment; filename=index.txt.gz
Last-Modified: Wed, 24 Sep 2014 13:23:58 GMT
Content-Encoding: gzip
Transfer-Encoding: chunked Date: Wed, 24 Sep 2014 16:10:20 GMT
We recommend storing this value with each download and using it to compare with the current "LastModified" date. New feed files are available when the current "LastModified" is more recent than the stored date of the last download.
HOW TO USE SHORT OFFER URLS
The Short Offer URL pattern was created to handle the parallel tracking use case. With parallel tracking, users are delivered directly to the merchant’s landing page while click measurement happens in the background. Traditional Connexity redirect URLs can not be created in a dynamic fashion using tracking templates, so the Short Offer URL pattern was created for this purpose. Only the unique offer id and the publisher tracking parameters are necessary to create an offer url.
Example Short Offer URL Pattern:
https://rd.bizrate.com/r/[offer_id]?rf=af1&af_id=[publisher_id]&af_assettype_id=12&af_creative_id=2976&af_placement_id=[publisher_placement_id]&af_campaign_id=[publisher_campaign_id]&af_rid=[publisher_click_id]
| Field | Definition | Required |
| offer_id | Connexity Offer ID | Required |
| rf | Should always be “af1” for publishers | Required |
|
af_id |
Publisher Identifier | Required |
|
af_rid |
Publisher Request Id (String - max 255 chars) | Required - Must be {gclid} for Google, {msclkid} for Bing, or {fbclid} for Facebook |
| af_assettype_id | Publisher Asset Type (Integer) Defines Connexity Content Source (e.g. feeds=12, catalog_api=10, deeplink=14). | Required - Use ‘af_assettype_id=12’ for Short Offer Urls |
| af_creative_id | Sub-classification of Publisher Asset Type (Integer) Defines context of usage. (e.g. feeds using short offer url = 2976) | Required - Use ‘af_creative_id=2976’ for Short Offer Urls |
| af_placement_id | This parameter is restricted to 50 alphanumeric (letters and numbers [a-zA-Z] and [0-9] and special characters - . _ ) characters. Will not work with special characters such as & / + " Placement IDs will be reported under the default value of 1 if no value is provided. | Optional |
| af_campaign_id | Publisher Campaign Id (String - max 255 chars) | Optional |
| gb | Indicates if parallel tracking event from Google or Bing | Required if provided by Google/Bing on the click url |
Note: There is no limit on af_campaign_id variants, but af_rid should be used if the value is unique at the click level.
How to use Short Offer URL
Publishers may wish to set up tracking templates on the Bing/Google side to either send a redirect event to their click handler and then proxy the request to Connexity, or send the redirect events directly to Connexity. The Short Offer Url may be used in either case.
Example Google Tracking Template for af_id 99999 and placement_ id 1234:
https://rd.bizrate.com/r/{product_id}?rf=af1&af_id=99999&af_assettype_id=12&af_creative_id=2976&&af_rid={gclid}&af_placement_id=1234&af_campaign_id={lpurl}&af_assettype_id=12&af_creative_id=2976https://rd.bizrate.com/r/{ProductId}?rf=af1&af_id=99999&af_assettype_id=12&af_creative_id=2976&&af_rid={msclkid}&af_placement_id=1234&af_campaign_id={lpurl}&af_assettype_id=12&af_creative_id=2976For more information regarding Bing/Google tracking templates please consult their documentation.
Comments
0 comments
Article is closed for comments.