Sponsored Brands (earlier known as Search Brand Amplifier or SBA) is a unique Search solution to improve brand recognition and showcase your product portfolio. It’s a premium search placement that showcases your brand and a curated product portfolio to customers actively searching Walmart’s site and app for products like yours.
Note: We recommend begin using v2 as in future we plan to deprecate v1
Your logo, a custom headline and up to four SKUs
appear together above relevant search results, with clickable links.
Use the Sponsored
Brands Profile API to create, retrieve, update Sponsored Brands products
profile. Sponsored Brands profile for a campaign comprises of: Brand Logo
Image, Headline, Brand Name, and Logo Click URL.
You can, now,
create 2 profiles for a Sponsored Brands campaign to be able to switch between them
based on your campaign strategy. You can use v1 URLs to create single Sponsored
Brands profile and v2 URLs to create dual Sponsored Brands profiles.
Note: Sponsored Brands profile comprises of the following components:
Brand Logo
format: png, Size ≤200kb
should be 300px wide and 180px tall
Brand Name (max. 35 characters)
Headline Text (max 45 characters)
Logo Click URL
must be a https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of:
Search Page
Browse Page
Brand Shop
Brand Shelf
cannot contain any of the characters referenced in clickUrl requirements
Create Sponsored Brands Profile for Campaign
Description
Create a new Sponsored Brands profile, for a campaign, that is relevant to the products in the respective campaign. This defines the look and click behavior of your Sponsored Brands placement. Successfully created profiles will be assigned a unique Sponsored Brands Profile ID. You can create only one Sponsored Brands profile by using URL v1
Using v2 URL, you
can create dual Sponsored Brands profiles for a campaign
Note: A profile is created with review status set as “pending review” by default
v1 URL: POST/api/v1/sba_profile
Query Parameters
Parameter
Notes
Type
Required
Possible Values
campaignId
The ID of the campaign
integer
Y
A valid campaign ID
adGroupId
The ID of the ad group
integer
Y
A valid ad group ID
searchAmpName
The name of the Brand. This field should not be left empty.
string
Y
Name of the brand that is part of this profile. It should be max. 35 characters, all of which are NOT recommended to be special characters
headlineText
Custom headline text showcasing why customers should buy your products This field is required.
string
Y
Piece of text that explains your brand value within following constraints: • It should be max. 45 characters • It is recommended to NOT use all special characters in this field
clickUrl
The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. This field is required.
string
Y
Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
clickUrl requirements: 1) Any “:” in the URL should be replaced with “%3A” 2) Any “+” in the URL should be replaced with “%20″ 3) Any “||” in the URL should be replaced with “%7C%7C” 4) URL query string should not contain “typeahead=” parameter 5) For 3P sellers, add hidden_facet=retailer_id%3A<seller_id>to the end of clickURL
Note: If requirements not met, the request will fail with encode issue.
Headers
Header Name
Description
Required
Values
Authorization
The token will provide you the access to the API. It is same for all advertisers you access through the API.
Y
Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.ID
We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.
Y
Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this
WM_SEC.AUTH_SIGNATURE
Auth signature as an API key
Y
Use the signature generator code from Getting
Started Guide to generate this value
WM_SEC.KEY_VERSION
We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API
Y
1
WM_CONSUMER.intimestamp
Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp
Y
Use the
signature generator code (Getting Started Guide) to generate this value
The response code can have following values: success, failure
string
details
Details of
the error if value of response code is failure
string
sbaProfileId
ID of the SBA profile
integer
Sponsored Brands Profiles can be either created or not based upon different scenarios. Sample response here provides an idea of how the response looks like in either case.
[
{
"code": "failure",
"details": "",
" sbaProfileId ": 50001
},
{
"code": "failure",
"details": "The Click URL has not been correctly
encoded. Please encode and retry",
" sbaProfileId ": 0
}
]
v2 URL: POST/api/v2/sba_profile
Note:
Firstprofile created will be enabled by default
Second profile
created will be disabled by default
Any
new profile will be created as “pending review” by default
Only
enabled profile will serve on a live campaign
Only
two profiles can be created at max per ad group
If
you create two profiles for an ad group then:
Only
1 profile can be enabled at a time
To
disable an “enabled” profile, you need to enable the “disabled” profile
Query Parameters
Parameter
Notes
Type
Required
Possible Values
campaignId
The ID of the campaign
integer
Y
A valid campaign ID
adGroupId
The ID of the
ad group
integer
Y
A valid ad group ID
searchAmpName
The name of the Brand. This field should not be
left empty.
string
Y
Name of the brand that is part of this profile. It should be max. 35 characters, all of which are NOT recommended to be special characters
headlineText
Custom headline text showcasing why customers should buy your products This field is required.
string
Y
Piece of text that explains your brand value within following constraints: It should be max. 45 charactersIt is recommended to NOT use all special characters in this field
clickUrl
The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. This field is required.
string
Y
Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
clickUrl requirements: 1) Any “:” in the URL should be replaced with “%3A” 2) Any “+” in the URL should be replaced with “%20″ 3) Any “||” in the URL should be replaced with “%7C%7C” 4) URL query string should not contain “typeahead=” parameter 5) For 3P sellers, add hidden_facet=retailer_id%3A<seller_id>to the end of clickURL
Note: If requirements not met, the request will fail with encode issue.
Retrieve a specific Sponsored Brands profile for a specific campaign by providing campaign ID and ad group ID.
You can
retrieve only enabled Sponsored Brands profile by using URL v1. Using v2 URL, you
can retrieve both the enabled and disabled profiles, in case you have created
two profiles for the ad group.
v1 URL: GET/api/v1/sba_profile
Query Parameters
Parameter
Description
Type
Required
Possible Values
campaignId
The ID of the campaign for which the Sponsored Brands Profile is retrieved
Custom headline text showcasing why customers should buy your products
string
logoUrl
The direct link that is embedded in the logo
string
clickUrl
The destination URL or landing page URL. It is the website address that a visitor goes to when he/she clicks on the ad. Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
string
reviewStatus
The current status of Sponsored Brands Profile review performed by Ad Ops team. Possible values of reviewStatus are: pending, approved,rejected
string
reviewReason
If value of reviewStatus is rejected, you will receive the reason for why it was rejected.
Example: Invalid logo
Note: Value of reviewReason is “null” when reviewStatus is pending.
Custom headline text showcasing why customers should buy your products
string
logoUrl
The direct link that is embedded in the logo
string
clickUrl
The destination URL or landing page URL. It is the website address that a visitor goes to when he/she clicks on the ad. Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
string
reviewStatus
The current status of Sponsored Brands Profile review performed by Ad Ops team. Possible values of reviewStatus are: pending, approved,rejected
string
reviewReason
If value of reviewStatus is rejected, you will receive the reason for why it was rejected. Example: Invalid logo
Note: Value of reviewReason is “null” when reviewStatus is pending.
Update an existing Sponsored Brands profile for campaign.
You can only
update the enabled Sponsored Brands profile by using URL v1. Using v2 URL, you
can update both existing Sponsored Brands profiles for campaign if it has two
profiles (one is enabled, and the other is disabled).
Note:You can update Sponsored Brands profile for a live Sponsored Brands campaign as well. To update the enabled Sponsored Brands profile in a live campaign, you will have to pause the campaign, update the profile, and submit it for review. To avoid pausing the campaign, we recommend that you create a 2nd profile with the desired changes using v2 URL, submit a review request for its approval, and enable it once it is approved.
v1 URL: PUT/api/v1/sba_profile
Query Parameters
Parameter
Notes
Type
Required
Possible Values
campaignId
The ID of the campaign
integer
Y
A valid campaign ID
adGroupId
The ID of the ad group
string
Y
A valid ad group ID
searchAmpName
The name of the Brand. This field is required.
string
Y
Name
of the brand that is part of this profile. It should be max. 35 characters
all of which are NOT recommended to be special characters
headlineText
Custom headline text showcasing why customers should buy your products This field is required.
string
Y
Piece of text that explains your brand value within following constraints: 1) This field should not be left empty. 2) It should be max 45 characters. 3) It is recommended to NOT use all special characters in this field
clickUrl
The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. This field is required.
string
Y
Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
clickUrl requirements: 1) Any “:” in the URL should be replaced with “%3A” 2) Any “+” in the URL should be replaced with “%20″ 3) Any “||” in the URL should be replaced with “%7C%7C” 4) URL query string should not contain “typeahead=” parameter 5) For 3P sellers, add hidden_facet=retailer_id%3A<seller_id>to the end of clickURL
Note: If requirements not met, the request will fail with encode issue.
None of the profiles can be updated if a campaign review is pending or in-progress
An approved profile will be switched to pending review when it is updated
Query Parameters
Parameter
Notes
Type
Required
Possible Values
campaignId
The ID of the campaign
integer
Y
A valid campaign ID
adGroupId
The ID of the ad group
string
Y
A valid ad group ID
searchAmpName
The name of the Brand. This field is required.
string
Y
Name of the brand that is part of this profile. It should be max. 35 characters all of which are NOT recommended to be special characters
headlineText
Custom headline text showcasing why customers should buy your products This field is required.
string
Y
Piece of text that explains your brand value within following constraints: 1) This field should not be left empty 2) It should be max 45 characters 3) It is recommended to NOT use all special characters in this field
clickUrl
The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. This field is required.
string
Y
Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: 1) Search Page 2) Browse Page 3) Brand Shop 4) Brand Shelf
clickUrl requirements: 1) Any “:” in the URL should be replaced with “%3A” 2) Any “+” in the URL should be replaced with “%20″ 3) Any “||” in the URL should be replaced with “%7C%7C” 4) URL query string should not contain “typeahead=” parameter 5) For 3P sellers, add hidden_facet=retailer_id%3A<seller_id>to the end of clickURL
Note: If requirements not met, the request will fail with encode issue.
sbaProfileId
ID of the Sponsored Brands profile
integer
Y
A valid Sponsored Brands profile ID
status
Indicator of the enabled state of Sponsored Brands profile
Upload Logo Image to Sponsored Brands Profile for Campaign
Description:
Upload brand logo image for your brand on the Sponsored Brands profile using this operation
Using v1 URL, you can only upload logo for the enabled profile. However, if you have created 2 profiles, you should use v2 URL to update logo for the desired profile.
Note:
You can change the brand logo image if the campaign is in “proposal” state, by resubmitting POST request
Brand logo image:
format should be png with size ≤ 200kb
should be 300px wide and 180px tall
Brand name should not be more than 35 characters long
Logo click URL must be a https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of:
SBABaseProfileRequest is a JSON object specifying campaignId and adGroupId. campaignId and adGroupId are IDs of the campaign and ad group respectively. Both these IDs are type integer
string
Y
file
Any image file of the format png
The binary data for the suitable image file demonstrating your brand to potential buyers. Note: 1) Brand logo image file size should be ≤ 200kb 2) Supported format is png 3) Brand image should be 300px wide and 180px tallFile name field cannot be empty 4) It is recommended to NOT use all special characters in this field
SBABaseProfileRequest
is a JSON object specifying campaignId, adGroupId and sbaProfileId. campaignId adGroupId and sbaProfileId are IDs of the
campaign, ad group and Sponsored Brands Profile
respectively.
All
these IDs are type integer
string
Y
file
Any image file of the format png
The binary data for the suitable image file demonstrating your brand to potential buyers.
Note: 1) Brand logo image file size should be ≤ 200kb 2) Supported format is png 3) Brand image should be 300px wide and 180px tall 4) File name field cannot be empty 5) It is recommended to NOT use all special characters in this field
