Technical requirements for sponsored listings campaign creation
Work with your Kevel team to ensure that your product catalog is set up for your advertisers to successfully promote their products in your Self-serve tool
Beta product
This product is currently in beta. It may not be available to all Kevel customers, and features described may change before the product is generally available.
When setting up your self-serve tool, your Kevel account team will work with you ensure that your Kevel ad server setup aligns with the technical requirements below.
Technical requirements
Selling sponsored listings campaigns via Kevel Self-serve currently requires the following campaign settings.
- Selection method: Auction (first or second priced)
- Pricing method: CPC
- Creative & ad type: Ads must be created from Kevel Catalog.
Catalog requirements
Product table requirements
In order to enable your advertisers to create sponsored listings campaigns, you must maintain a product table in Kevel Catalog that stores items available for your advertisers to promote.
When advertisers create sponsored listings campaigns, the self-serve application will create ads from the products your advertiser chooses to promote.
Your product table must carry table type: kevel/products
You can use search keys and UI configuration controls to define which attributes of your product catalog should be visible to advertisers, and which of those attributes should be available as filters. Your Kevel customer success contact can help you configure these catalog settings.
| Product catalog attribute characteristics | Exposure to advertisers |
|---|---|
| Exists on your product table but does not have a search key | Not exposed to advertisers in the Advertiser UI or API |
| Exists on your product table and has a search key | Not exposed to advertisers in the Advertiser UI. Exposed in the Advertiser API as a product attribute and filter |
Exists on your product table, has a search key, and Display Column = true | Advertisers can see this attribute in the Advertiser UI when selecting products for a campaign |
Exists on your product table, has a search key, Display Column = true, and Display Filter = true | Advertisers can filter on this attribute in the Advertiser UI when selecting products for a campaign, both with static and dynamic product selection types. |
The behavior of individual filters is defined using the same Catalog UI Configuration controls as the Kevel ad server UI.
In addition, the table should include the following data, search keys, and aliases:
| Data (Name need not match) | Search key types supported | Search key cardinality | Alias (Name must match exactly) | How it's used in Kevel Self-serve |
|---|---|---|---|---|
| Brand ID | number or string | single | kevel/brand-id | Required if your self-serve utilizes Brand ID to control advertiser access to the relevant subset of your product catalog. If Merchant ID is used for catalog access and Brand ID is not used, then this column is not required. For more information, see customization: advertiser catalog access |
| Merchant ID | number or string | single | kevel/merchant-id | Required if your self-serve utilizes Merchant ID to control advertiser access to the relevant subset of your product catalog. If Brand ID is used for catalog access and Merchant ID is not used, then this column is not required. For more information, see customization: advertiser catalog access |
| Product image | No search key required | No search key required | kevel/image | - This should be a URL of a hosted image - Advertisers see this image when selecting products to add to a campaign. - When an advertiser views an existing campaign, they see this image in the list of products promoted on that campaign. |
| Product title | text or string | single | self-serve/title | Advertisers see this in bold when selecting products. |
| Product description | text | single | self-serve/description | Advertisers see this in non-bolded text under the bold title text when selecting products. |
| Name of product | text | single | kevel/name | When an advertiser views an existing campaign, they see this name in the list of products promoted on that campaign. |
| Product ID | string or number | single | kevel/product-id | When an advertiser views an existing campaign, they see this ID in the list of products promoted on that campaign. |
| Brand name | text or string | single | kevel/brand-name | - Advertisers see and can filter by brand name when selecting products to add to a campaign. |
| Categories (optional) | ref | many | kevel/categories | - Must be a ref to categories in a separate table. - If provided, advertisers see the list of categories associated with a product when selecting products to add to a campaign. |
Category table requirements
If you want to allow your advertisers to see a list of categories associated with a product when selecting products to add to a campaign, then you must also include a category table.
Your category table must carry table type: kevel/categories
In addition, the table must include the following data, search keys, and aliases:
| Data (Name need not match) | Search key types supported | Search key cardinality | Alias (Name must match exactly) | How it's used in Kevel Self-serve |
|---|---|---|---|---|
| Category ID | No search key required | No search key required | No alias required | The category ID is generally used as the ref in the products table. However, category name can also be used. |
| Main category name | text | single | kevel/name | Category names are displayed to advertisers in two ways: - Advertisers see the list of categories associated with a product when selecting products to add to a campaign. - When category targeting is enabled, advertisers see these category names on the category targeting step. |
Updated 22 days ago