SBA Profile
Overview
Search Brand Amplifier (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 Sam's Club's site and app for products like yours.
Your logo, a custom headline, and up to four SKUs appear together above relevant search results, with clickable links. Use the Search Brand Amplifier profile API to create, retrieve, or update Search Brand Amplifier products profiles.
A Search Brand Amplifier profile comprises the following components
- Brand Logo
- format: .png
- size ≤ 200 Kb
- should be 100*100 px
- Brand Name (maximum of 35 characters)
- Headline Text (maximum of 45 characters)
- Logo Click URL
- must be a https://www.samsclub.com
- should be a browse or search page for the brand
- cannot contain any of the characters referenced in clickUrl requirements
Note: Only enabled SBA profile can be updated by using v1 version of URL. We recommend to use v2 version of the APIs (/api/v2/sba_profile), as v1 version will be deprecated in a future release.
To understand details about ‘Request Header' or 'Authorization’, please refer to the Authorization Guide
List All SBA Profiles
Description: Retrieve the SBA profile for a given Campaign and Ad Group.
End Point: /api/v2/sba_profile
HTTP Method: GET
Query Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
campaignId | The ID of the campaign. It returns a specific campaign in response | Integer | N | A valid campaignId |
adGroupId | ID of the ad group | Integer | Y | A valid adgroupId |
Sample Request
Response
Element | Description | Type |
---|---|---|
searchAmpName | Brand Name | String |
headlineText | Headline to be displayed on Banner ad | String |
logoUrl | Url for for the brand image that is displayed on the ad | String |
clickUrl | Url that customer is directed to when they click on the ad | String |
reviewStatus | Status of AdOps review of SBA profile. Expected values: pending , complete | String |
reviewReason | Reason for rejection of SBA profile.If approved , this field is returned as null value | String |
sbaProfileId | 5 digit ID for the SBA profile | Integer |
status | Status of the SBA profile. Expected values : enabled, disabled | String |
campaignId | The ID of the campaign | Integer |
adGroupId | ID of the ad group that is part of the campaign | Integer |
Sample Response
[
{
"searchAmpName": "Hello",
"headlineText": "SBAProfile",
"logoUrl": "https://i5.walmartimages.com/dfw/9fa19e5c-d9/k2-_c18d5e56-990e-4e30-a6d1-150df1204eb7.v2.png",
"clickUrl": "https://www.samsclub.com",
"reviewStatus": "pending",
"reviewReason": null,
"sbaProfileId": 11674,
"status": "enabled",
"campaignId": 21913,
"adGroupId": 770837591
}
]
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
400 | Bad Request |
|
403 | Forbidden |
|
404 | Not Found |
|
422 | Operation Not Allowed | Please use AdGroupMedia endpoints for AdGroupMedia |
429 | Too Many Requests | <Exception Message> |
500 | Internal Server Error | There was an error processing the request |
Create SBA Profile
Description: Create an SBA profile for an Adgroup or multiple SBA profiles for AdGroups all at once.
End Point: /api/v2/sba_profile
HTTP Method: POST
Body Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
campaignId | The ID of the campaign. It returns a specific campaign in response | Integer | Y | A valid campaign ID |
adgroupId | ID of the ad group that is part of the campaign | Integer | Y | Unique numeric identifier |
searchAmpName | The Brand name that will be displayed to the customer | String | Y | Brand name |
clickUrl | The click url that the customer will be directed when they click on the advertisement | String | Y | Clickable URL must be https://www.samsclub.com URL that displays product(s) for the advertised brand. 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 |
Sample Request
Response
Element | Description | Type |
---|---|---|
code | Possible values of response code: success or failure | String |
details | Details of the error if response code is failure | String |
sbaProfileId | ID of the SBA profile | Integer |
Sample Response
[
{
"code": "success",
"details": "",
"sbaProfileId": 11674
},
{
"code": "failure",
"details": "",
"sbaProfileId": 11675
}
]
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
200 | OK |
|
400 | Bad Request |
|
403 | Forbidden |
|
404 | Not Found |
|
422 | Operation Not Allowed |
|
429 | Too Many Requests | <Exception Message> |
500 | Internal Server Error | There was an error processing the request |
Update SBA Profile
Description: You can update Search Brand Amplifier profile for a live Search Brand Amplifier campaign as well. To update the enabled Search Brand Amplifier profile in a live campaign, you will have to pause the campaign, update the profile, and submit it for review.
End Point: /api/v2/sba_profile
HTTP Method: PUT
Body Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
campaignId | The ID of the campaign. It returns a specific campaign in response | Integer | Y | A valid campaign ID |
adgroupId | ID of the ad group that is part of the campaign | Integer | Y | Unique numeric identifier |
sbaProfileId | The ID of the SBA profile to be edited | Integer | Y | A valid SBA profile ID |
searchAmpName | The Brand name that will be displayed to the customer | String | Y | Brand name |
headlineText | The headline of the advertisement that will be displayed to the customer | String | Y | Headline String |
clickUrl | The click url that the customer will be directed when they click on the advertisement | String | Y | http://samsclub.com** |
status | The status of the SBA profile | String | Y | enabled, disabled |
Sample Request
Response
Element | Description | Type |
---|---|---|
code | Possible values of response code: success, failure | String |
details | Details of the error if response code is failure | String |
sbaProfileId | ID of the Search Brand Amplifier profile | Integer |
Sample Responses
[
{
"code": "success",
"details": "",
"sbaProfileId": 11674
},
{
"code": "success",
"details": "",
"sbaProfileId": 11675
}
]
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
400 | Bad Request |
|
403 | Forbidden |
|
404 | Not Found |
|
422 | Operation Not Allowed |
|
429 | Too Many Requests | <Exception Message> |
500 | Internal Server Error | There was an error processing the request |
Upload SBA Profile Logo
Description: Upload a logo image to an SBA profile by SBA profile ID.
End Point: /api/v2/sba_profile_image_upload
HTTP Method: POST
Form Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
file | Image to be uploaded(File must be less than 1MB) | File | Y | Valid directory on computer of image to be uploaded |
sbaBaseProfileRequest | The campaign ID, adgroupId and sbaProfile ID of the SBA profile that the image will be uploaded to | String | Y | {"campaignId": "54321", "adGroupId": "777777777", "sbaProfileId": "12345"} |
Sample Request
Response
Element | Description | Type |
---|---|---|
code | Possible values of response code: success, failure | String |
details | Details of the error if response code is failure | String |
sbaProfileId | ID of the Search Brand Amplifier profile | Integer |
Sample Response
[
{
"code": "success",
"details": "",
"sbaProfileId": 11674
}
]
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
200 | OK |
|
400 | Bad Request |
|
403 | Forbidden |
|
404 | Not Found | AdGroup not found |
422 | Operation Not Allowed |
|
429 | Too Many Requests | <Exception Message> |
500 | Internal Server Error |
|