Sponsored Products Feed Integration¶
Abstract¶
Integration with Verizon Media’s Sponsored Products Feeds involves a series of steps outlined in this document, which you’ll need to follow in order to implement Sponsored Product Feeds for your brand website. The primary steps for integration with sponsored products are described in detail in Sponsored Product Integration v1.0.
Overview¶
Sponsored Products is a new publishing solution from Verizon Media aimed at major retailer brands and marketplaces, where customers search, discover and purchase various product offerings from online marketplace catalogs and offerings.
Brand-focused marketplaces that sell different brands on their websites will be able to grow supply to larger advertisers and other major brands, using Sponsored Products from Verizon Media.
In so doing, Sponsored Products enable publishers to increase revenue by 10-20% by leveraging strong purchase intent signals from customers coming to their websites.
Steps For Sponsored Products Feed Integration¶
You’ll need to follow these steps:
Implement a product feed that specifies general (Google product taxonomy) and custom categories set to the value of a particular product, like Nike shorts categorized as Mens’ activewear, activewear, mens shorts, and so on. Categories are specified as comma-separated values.
You’ll need to provide all the filters and categories that a consumer will navigate through on a website. Each product should be specified by a separate SKU ID.
For custom fields, ensure that you set up a meeting with your Verizon Media Account Manager or Solutions Engineer to define custom fields.
Feed Operations & File Formats¶
Verizon Media Dynamic Product Ads (DPA) provides support for the API endpoints and operations described in this section. Operations include creating, updating and deleting the sponsored product feed.
You can also download a sample product feed spreadsheet in .csv
format here
.
Sample product feeds can be .csv
or .tsv
files. For specific format requirements, refer to Bulk Operations Schema.
The current supported file formats include:
File Format |
Delimited? |
Encoding |
---|---|---|
|
Yes |
UTF-8, UTF-16 and UTF-32 |
|
UTF-8, UTF-16 and UTF-32 |
|
|
Yes |
UTF-8, UTF-16 and UTF-32 |
|
UTF-8, UTF-16 and UTF-32 |
|
|
UTF-8, UTF-16 and UTF-32 |
Note
gzip (GNU zip) is also a supported file transfer format. The gzip format produces files with a .gz
extension. For more information, refer to gzip and GNU Operating System.
Note
You must have a valid ftp server and make your feed available on the server.
Create a Product Feed¶
The following API can be used to create a product feed into Native Ad Platform.
Make a POST call to this endpoint:
https://api.gemini.yahoo.com/v3/rest/feed
Request:
{
"advertiserId": 11,
"status": "ACTIVE",
"userName": "ftp_username",
"feedType": "DPA_RECURRING",
"fileName": "yourfeedfile.csv",
"password": "password",
"feedUrl": "ftp://yourftpserver.yourwebsite.com",
"scheduleInfo": {
"feedFrequency": "DAILY",
"dayOfMonth": null,
"dayOfWeek": null,
"hourMinute": "12:00"
}
}
Note
There two feed types: DPA_ONE_TIME and DPA_RECURRING. DPA_ONE_TIME indicates that the feed will be loaded only once, so you do not need to include scheduleInfo
in your request. DPA_RECURRING indicates that the feed will be loaded repeatedly at the scheduled time.
Check Feed Status¶
To check the feed status, make a GET call to this endpoint with the feed id, which is the response from creating a feed:
https://api.gemini.yahoo.com/v3/rest/feed/status?feedId=1421
response
{
"errors": null,
"timestamp": "2017-04-12 21:07:36",
"response": {
"status": "COMPLETED",
"startedTime": "2017-03-31 00:29:02",
"finishedTime": "2017-03-31 00:29:02",
"resultFile": "token",
"results": {
"Product_Ad": {
"totalCount": 9,
"addedCount": 0,
"updatedCount": 9,
"failedCount": 0
}
}
}
}
Note
If the failedCount
is greater than zero, you can this API to download the error reporting file:
https://api.gemini.yahoo.com/v3/rest/feed/error?resource=token
Sponsored Product Feed Fields¶
Sponsored product feed fields are described in the table below.
Field name |
Type & size |
Description |
Required or optional |
---|---|---|---|
id |
string, Max size: 100 |
Unique id to identify the product, specifically a reference to the SKUID. The product sets, user recommendation and dot pixel custom events should use this id. All products with duplicate ids will be ignored. |
required |
title |
string, Max size: 100 |
The title of the product. This field will be used in the ad presentation. Title displayed is 20-50 characters. |
required |
description |
string, Max size: 4000 |
A short description of the product. This field will be used in the ad presentation. Description displayed is 20-150 characters. |
required |
image_link |
string |
Link to an image of the product. The image provided will be mapped to these formats for native ads: large 627x627px and HQ 1200x627px. |
required |
link |
string |
Landing page of the merchant when the ad is clicked. |
required |
google_product_category |
string, Max size: 250 |
Predefined values from Google’s product taxonomy. For example, Apparel & Accessories > Clothing > Dresses. |
optional |
custom_categories |
string |
Custom categories–for example, Men’s shoes, Shoes, Christmas sale, etc. |
required |
age_group |
string |
The age group the product is meant for. Accepted values are newborn, infant, toddler, kids, and adult. |
optional |
color |
string, Max size: 100 |
The color of the product. |
optional |
gender |
string |
Acceptable values are male, female, and unisex |
optional |
item_group_id |
string |
Similar products can share same item group id |
optional |
availability |
string |
Defines product availability. Accepted values are:
|
optional (will default to in stock if absent) |
condition |
string |
The condition of the product. Accepted values are new, refurbished, or used. |
required |
gtin |
string, Max size: 70 |
The Global Trade Item Number (GTINs) can include UPC, EAN, JAN, and ISBN. |
one of gtin/mpn/brand is required |
mpn |
string, Max size: 70 |
The number which uniquely identifies the product to its manufacturer. |
one of gtin/mpn/brand is required |
brand |
string, Max size: 70 |
The name of the brand. |
one of gtin/mpn/brand is required |
additional_image_link |
string, Max size: 2000 |
Comma separated multiple (max 10) additional image urls can be provided. |
optional |
material |
string, Max size: 200 |
Material or fabric of the product. |
optional |
pattern |
string, Max size: 100 |
The pattern or graphic print featured on a product. |
optional |
product_type |
string, Max size: 750 |
The retailer-defined category of the product as a string. Examples : TSV format: Home & Garden > Kitchen & Dining > Appliances > Refrigerators |
optional |
sale_price |
string |
The discounted price if the product is on sale. Currency should be specified as the ISO 4217 currency code. Specified as 9.99 USD |
optional |
sale_price_effective_date |
ISO‑8601 (YYYY‑MM‑DD) or YYYY‑MM‑DDTHH:MM or YYYY‑MM‑DDTHH:MM or YYYY‑MM‑DDTHH:MM-0000). |
The start and end date/time of the sale, separated by a slash. e.g., 2014-11-01T12:00-0300/2014-12- 01T00:00-0300. Dates without a time will default to 00:00 (midnight at the start of the date). Dates with a time but without a time zone will default to UTC. |
optional |
shipping |
string |
optional |
|
shipping_weight |
string |
optional |
|
shipping_size |
string |
optional |
|
last_changed_date |
string, representing epoch time |
Represents the time when the change in the catalog was made. |
optional |
custom_label_[0-5] |
string, Max size: 100 |
Can contain additional information about the item |
optional |