Skyline v3 Background Color Recommendations

Initiate background color recommendation generation. May take up to 30 seconds.

📘

URL: POST /api/v1/creatives/colors/background/recommendations

Request Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID of the specific advertiser.integerYA valid advertiser ID
assetIdsList of asset IDs to analyze for color recommendations. Recommendations are generated for the combination of assetIds specified.array (UUID)YArray of valid asset IDs

Sample Request

curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/colors/background/recommendations' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v00-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.INTIMESTAMP: 1565309779' \ --data '{ "advertiserId": 12345678, "assetIds": ["123e4567-e89b-12d3-a456-426614174000", "987e6543-e21b-45d3-a123-456789abcdef"] }'

Response

ElementDescriptionType
recommendationIdUnique identifier for the background color recommendation job.string (UUID)
statusStatus of the recommendation job.string

Error Response

FieldDescriptionOptional field/Nullable?TypePossible values
codecode returns failure in error scenariosNstringfailure
detailsList of error codes associated with the request. Use these codes for programmatic error handling.NarrayRefer to this link for detailed error messages
messageHigh-level summary of the error, when available. Ystring 
errorsDetailed information about one or more errors, including the affected field (when applicable), error code, and a human-readable description.Yarray<object> 

errors Array Object Details

FieldDescriptionOptional field/Nullable?TypePossible values
fieldJSON field associated with the error. Omitted if the error applies to the request as a whole.Ystring 
errorTypeMachine-readable error code that uniquely identifies the error condition. Applications should use this value for error handling logic.Nstring 
descriptionHuman-readable explanation of the error, including why the request failed and, when possible, how to resolve itNstring 

Sample Response - success

[ { "recommendationId": "123abc456-a00b-123a-a456-1234567890", "status": "PENDING" }
]

Sample Response - Failure

{ "code": "failure", "details": [ "string" ],   "message": "string", "errors": [ { "field": "string", "errorType": "string", "description": "string" } ]
}

Did this page help you?