List SBA Profile for Campaign
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 | integer | Y | A valid campaign ID |
| adGroupId | The ID of the ad group belonging to this campaign | integer | Y | A valid ad group ID |
Sample Request
curl -X GET \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/sba_profile?campaignId=600001&adGroupId=500003' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'accept: application/json' \ Response
| Element | Description | Type |
|---|---|---|
| searchAmpName | The name of the Brand | string |
| headlineText | 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:
| 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. | string |
| sbaProfileId | Id of the Sponsored Brands profile | integer |
Sample Response
[ { "searchAmpName": "Pepsi", "headlineText": "The coolest cold drink", "logoUrl": "logo URL", "clickUrl": "https://www.walmart.com", "reviewStatus": "pending", "reviewReason": null, "sbaProfileId": 50001 }
]
[ { "searchAmpName": "Pepsi", "headlineText": "The coolest cold drink", "logoUrl": "logo URL", "clickUrl": "https://www.walmart.com", "reviewStatus": "rejected", "reviewReason": "Invalid Logo", "sbaProfileId": 50001 }
]
v2 URL: GET/api/v2/sba_profile
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| campaignId | The ID of the campaign for which the Sponsored Brands Profile is retrieved | integer | Y | A valid campaign ID |
| adGroupId | The ID of the ad group belonging to this campaign | integer | Y | A valid ad group ID |
Sample Request
curl -X GET \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile?campaignId=600001&adGroupId=500003' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'accept: application/json' \ Response
| Element | Description | Type |
|---|---|---|
| searchAmpName | The name of the Brand | string |
| headlineText | 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:
| 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. | string |
| sbaProfileId | Id of the enabled Sponsored Brands profile | integer |
| status | Indicates if a profile is activated to serve | string |
Sample Response
[ { "searchAmpName": "Pepsi", "headlineText": "The coolest cold drink", "logoUrl": "logo URL", "clickUrl": "https://www.walmart.com", "reviewStatus": "pending", "reviewReason": null, "sbaProfileId": 50001, "status": "enabled" }
]
[ { "searchAmpName": "Pepsi", "headlineText": "The coolest cold drink", "logoUrl": "logo URL", "clickUrl": "https://www.walmart.com", "reviewStatus": "rejected", "reviewReason": "Invalid Logo", "sbaProfileId": 50001, "status": "disabled" }
]
Updated about 2 months ago