Create the Creatives
Create creatives for a specific advertiser
URL: POST/api/v1/creatives
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser | integer | Y | A valid advertiser Id |
| metadata | Fields belonging in a creative:
| JSON object | Y | The values:
|
| adUnits | Ad units on creative platform: marqueeDesktop, marqueeApp, skylineDesktop, skylineApp, brandboxDesktop, brandboxApp, galleryDesktop, galleryApp Each ad unit contains following fields:
| JSON object | Y | marqueeDesktop marqueeApp skylineDesktop skylineApp skylineDesktopV2 skylineAppV2 brandboxDesktop brandboxApp galleryDesktop galleryApp |
Creative Ad Unit Character Limits
Character limits vary across the various ad units, refer to the tables below for character length limits per ad unit.
marqueeDesktop / tablet
| Text | Character Limit |
|---|---|
| headline | 25 |
| subhead | 55 |
| cta | 16 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
marqueeApp
| Text | Character Limit |
|---|---|
| headline | 25 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
skylineDesktop
| Text | Character Limit |
|---|---|
| headline | 25 |
| subhead | 30 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
skylineApp
| Text | Character Limit |
|---|---|
| headline | 25 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
brandboxDesktop
| Text | Character Limit |
|---|---|
| headline | 25 |
| subhead | 55 |
| cta | 16 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
brandboxApp
| Text | Character Limit |
|---|---|
| headline | 25 |
| subhead | 55 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
galleryDesktop full/mini
| Text | Character Limit |
|---|---|
| headline | 25 |
| subhead | 55 |
| cta | 16 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
galleryApp
| Text | Character Limit |
|---|---|
| headline | 25 |
| cta | 16 |
| legalDisclaimerText | 600 |
| legalDisclaimerLabel | 12 |
| legalDisclaimerPopUpCopy | 600 |
Please refer to the Appendix to find the required, optional, and non-required assets for each ad unit
Sample Error Messages Thrown for Create Creative API
| Scenario | Error Message |
|---|---|
| field not found | $.<fieldName>: null found, string expected |
| text validations |
|
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 more information |
| 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 from Getting Started Guide to generate this value |
Sample Request: Create Creative
curl -X POST
--location ' https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer aaaa0000-aa00-aa00-aa00-aaaaaa000000' \
--header 'WM_CONSUMER.ID: aaaa1111-aa11-aa11-aa11-aaaaaa111111' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.INTIMESTAMP: 0000000000000' \
--header 'WM_SEC.AUTH_SIGNATURE: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000==' \
--data '{
"advertiserId": 00000000,
"metadata": { "name": "creative name", "folderId": "<folder_id>", "templateId": "436" },
"adUnits": {
"marqueeDesktop": { "headline": "The headline.",
"subhead": "The subhead.",
"cta": "Shop now",
"imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "desktopImage", "assetId": "<asset_id>" }, { "name": "desktopLogo", "assetId": "<asset_id>" }
]
},
"marqueeApp": {
"headline": "The headline.",
"subhead": "The subhead.",
"cta": "Shop now",
"imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [
{ "name": "mobileImage", "assetId": "<asset_id>" }, { "name": "mobileLogo", "assetId": "<asset_id>" }
]
},
"skylineDesktop": {
"headline": "The headline.",
"subhead": "The subhead.", "imageAltText": "A picture of our product", "logoAltText": "Our company logo", "legalDisclaimerText": "Disclaimer.", "legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.", "variantId": "436", "images": [ { "name": "desktopImage", "assetId": "<asset_id>" }, { "name": "desktopLogo", "assetId": "<asset_id>" }
]
},
"skylineApp": {
"headline": "The headline.",
"logoAltText": "Our company logo",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "mobileLogo", "assetId": "<asset_id>" }
]
},
"brandboxDesktop": {
"headline": "The headline.",
"subhead": "The subhead.",
"cta": "Shop now",
"imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "desktopImage", "assetId": "<asset_id>" } { "name": "desktopLogo", "assetId": "<asset_id>" }
]
},
"brandboxApp": {
"headline": "The headline.",
"subhead": "The subhead.",
"imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "mobileImage", "assetId": "<asset_id>" }, { "name": "mobileLogo", "assetId": "<asset_id>" } ]
},
"galleryDesktop": {
"headline": "The headline.",
"subhead": "The subhead.",
"cta": "Shop now",
"imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "desktopImage", "assetId": "<asset_id>" }, { "name": "desktopLogo", "assetId": "<asset_id>" }
]
},
"galleryApp": {
"headline": "The headline.", "cta": "Shop now", "imageAltText": "A picture of our product",
"logoAltText": "Our company logo",
"legalDisclaimerText": "Disclaimer.",
"legalDisclaimerLabel": "Popup title.",
"legalDisclaimerPopUpCopy": "Popup Disclaimer.",
"variantId": "436",
"images": [ { "name": "mobileImage", "assetId": "<asset_id>" }, { "name": "mobileLogo", "assetId": "<asset_id>" }
]
}
}
}'
Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
Click here for more information about Status Codes and Errors | string |
| details | Possible values of details:
| string |
| creativeId | ID of the creative. It is returned in response only if code=success | string |
| message | Details of the error if value of code is failure and validation errors were found | string |
Sample Response 1
[ { "code": "success", "details": ["success"], "creativeId": "e02a09b2-1e3c-2g22-bf47-8a123c35002a" }
]
Sample Response 2
[ { "code": "failure", "details": ["CREATIVE_VALIDATION_ERROR"], "message": "Found 8 validation error(s).\n$.adUnits.marqueeDesktop.headline: must be at least 1 characters long\n $.adUnits.marqueeDesktop.subhead does not end with a period(.), exclamation(!), question(?), or an asterisk(*).\n $.adUnits.marqueeDesktop.cta does not follow sentence casing.\n $.adUnits.marqueeDesktop.imageAltText: must be at least 1 characters long\n $.adUnits.marqueeDesktop.logoAltText: must be at least 1 characters long\n $.adUnits.marqueeDesktop.images: null found, array expected\n Disclaimer Pop up copy and Label should be used together.\n $.metadata.templateId: does not have a value in the enumeration [436]" }
] Updated 4 days ago