Create Campaign Recommendations Request
Campaign Recommendations endpoint will provide recommendations on eligible campaigns for a particular recommendationType. Currently, we support Target ROAS recommendation type.
URL: POST /api/v2/snapshot/recommendations
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier for the advertiser. This is the advertising account id. This parameter can take only one advertiser Id for each snapshot report request. |
| recommendationType | The type of the recommendation required | string | Y | Values of recommendation type: targetROAS |
| format | Choose the format type for your snapshot | string | Y | Types of formats: gzip. Note: gzip allows decompression while file is being transferred over the network, hence it is a faster and simpler way to download the reports |
| reportMetrics | reportMetrics | string | Y | Please see below table for possible report metrics |
Report Metrics
| Element | Description | Data Type | Required | Possible Values |
|---|---|---|---|---|
| reportDate | The snapshot date for the report. | date | Y | The date should be in “yyyy-MM-dd” format. This parameter can take only one report date for the last 90 days for each snapshot report request. |
| campaignId | The Id of the campaign | Integer | Y | Unique ID for the given campaign. |
| recommendedTargetROAS | Recommended Target ROAS value | float | Y | The recommendation value can be between 1 and 31.27. |
| troasRecommendedDailyBudget | The recommended daily budget to set for the campaign to help maximize sales at the suggested ROAS target | float | N | We recommend passing this value to obtain target ROAS budget |
| troasIncrementalSalesLower | The lower range of the potential incremental sales we predict your campaign can generate if you update your campaigns with our recommendation following the learning phase | float | N | We recommend passing this value |
| troasIncrementalSalesUpper | The upper range of the potential incremental sales we predict your campaign can generate if you update your campaigns with our recommendation following the learning phase | float | N | We recommend passing this value |
| troasRecommendationId | Recommendation id for the target ROAS recommendation | string | N | We highly recommend passing troasRecommendationId in the report metrics |
Sample Request
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/recommendations' \ --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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 'Content-Type: application/json' \ --data '{ "advertiserId": 600001, "recommendationType": "targetROAS", "format": "gzip", "reportMetrics": [ "reportDate", "campaignId", "recommendedTargetROAS" ] }' Sample Request 2
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/recommendations' \ --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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 'Content-Type: application/json' \ --data '{ "advertiserId": 600001, "recommendationType": "targetROAS", "format": "gzip", "reportMetrics": [ "reportDate", "campaignId", "recommendedTargetROAS", "troasRecommendationId", "troasRecommendedDailyBudget", "troasIncrementalSalesLower", "troasIncrementalSalesUpper" ] }'
curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/recommendations' \ --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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 'Content-Type: application/json' \ --data '{ "advertiserId": 600001, "recommendationType": "targetROAS", "format": "gzip", "reportMetrics": [ "reportDate", "campaignId", "recommendedTargetROAS" ] }' Updated 9 days ago