Guides

Creative metadata

Use this API to retrieve creative metadata

📘

URL: POST/api/v1/creatives/metadata

Request Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID for the specific advertiserintegerYA valid advertiser ID
creativeIdThe ID of the creativestringYA valid creative ID

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease 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_SIGNATUREAuth signature as an API key.YUse the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.Y1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.YUse the signature generator code from Getting Started Guide to generate this value

Sample Request

curl -X POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/creatives/metadata' \
--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": 123,  "creativeId": "e02a09b2-1e3c-2g22-bf47-8a123c35002a"  }"

Response

ElementDescriptionType
response
  • metadata
    • name
  • adUnits: Ad units on creative platform: marqueeDesktop, marqueeApp, skylineDesktop, skylineApp, skylineDesktopV2, skylineAppV2, skylineDesktopV3, skylineAppV3, brandboxDesktop, brandboxApp, galleryDesktop, galleryApp, tileDesktop, tileApp
    ad units contain the following fields:
    • headline: Data type is string
    • subhead: Data type is string
    • cta: Call to action. Data type is string
    • imageAltText: Field to provide description of what’s visually represented in your ad. Data type is string.
    • logoAltText: Logo image description. Data type is string.
    • legalDisclaimerLabel: This is the title text of the popup disclaimer. Data type is string
    • legalDisclaimerPopUpCopy: This is the text of the popup disclaimer. Data type is string.
    • legalDisclaimerText: Data type is string.
    • backgroundColorHex: Color hex is always "#" followed by 6 digits between 0 and F on the hexadecimal scale.
      • This field only applies to Skyline v3 ad units and is optional
    • textColor: ENUM [gray, white]
      • This field only applies to Skyline v3 ad units and is optional

    Note: Please refer to table

    Creative Ad Unit Character Limits

    for character length limits per ad unit.
string
totalResultsNumber of responses returned by the API that match the request criteriainteger

Note: Please refer to Appendix to verify what assets are used for building each ad Unit



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

TextCharacter Limit
headline25
subhead55
cta16
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

marqueeApp

TextCharacter Limit
headline25
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

skylineDesktop

TextCharacter Limit
headline25
subhead30
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

skylineApp

TextCharacter Limit
headline25
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
logoAltText150

skylineDesktopV2

TextCharacter Limit
headline35
subhead40
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

skylineAppV2

TextCharacter Limit
headline35
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
logoAltText150

skylineDesktopV3

TextCharacter Limit
headline35
subhead40
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

skylineAppV3

TextCharacter Limit
headline35
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

brandboxDesktop

TextCharacter Limit
headline25
subhead55
cta16
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

brandboxApp

TextCharacter Limit
headline25
subhead55
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

galleryDesktop full/mini

TextCharacter Limit
headline25
subhead55
cta16
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

galleryApp

TextCharacter Limit
headline25
cta16
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

tileDesktop

TextCharacter Limit
headline30
subhead35
cta15
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

tileApp

TextCharacter Limit
headline30
subhead35
cta15
legalDisclaimerText600
legalDisclaimerLabel12
legalDisclaimerPopUpCopy600
imageAltText150
logoAltText150

Sample Response

{ "response": [ { "metadata": { "name": "onsite-display-template-123" }, "adUnits": { "brandboxApp": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "marqueeApp": { "headline": "Gentle & soft", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "galleryDesktop": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "marqueeDesktop": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "brandboxDesktop": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "skylineDesktop": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "skylineApp": { "headline": "Gentle & soft", "logoAltText": "Parents Choice logo" }, "skylineDesktopV2": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "skylineAppV2": { "headline": "Gentle & soft", "logoAltText": "Parents Choice logo" }, "skylineDesktopV3": { "headline": "Gentle & soft", "subhead": "Your subhead goes here", "logoAltText": "Parents Choice logo", "backgroundColorHex": "#abcdef", "textColor": "gray", "imageAltText": "image alt text" }, "skylineAppV3": { "headline": "Gentle & soft", "logoAltText": "Parents Choice logo", "backgroundColorHex": "#000000", "textColor": "white", "imageAltText": "image alt text" }, "galleryApp": { "headline": "Gentle & soft", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "tileDesktop": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "tileApp": { "headline": "Gentle & soft", "subhead": "Easy on babies skin.", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" } } } ], "totalResults": 1 }

Updated 8 days ago