HomeGuidesAPI Reference
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 <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'
--data "{ "advertiserId": 123,  "creativeId": "e02a09b2-1e3c-2g22-bf47-8a123c35002a"  }"

Response


ElementDescriptionType
response
  • metadata
    • name
  • adUnits: Ad units on creative platform: marqueeDesktop, marqueeApp, skylineDesktop, skylineApp, brandboxDesktop, brandboxApp, galleryDesktop, galleryApp
    Each ad unit contains the following fields:
    • headline: Character limit 25 characters. Data type is string
    • subhead: Character limit 30 characters. Data type is string
    • cta: Call to action. Character limit 16 characters. Data type is string
    • imageAltText: Field to provide description of what’s visually represented in your ad. Data type is string. Character limit 150 characters
    • logoAltText: Field to provide description to logo image. Data type is string. Character limit 150 characters
    • legalDisclaimerText: Data type is string.
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

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": "" }, "galleryApp": { "headline": "Gentle & soft", "cta": "Shop now", "imageAltText": "Parents choice products are easy on babies skin", "logoAltText": "Parents Choice logo", "legalDisclaimerText": "" }, "skylineApp": { "headline": "Gentle & soft", "logoAltText": "Parents Choice logo" } } } ], "totalResults": 1 }

Updated about 1 month ago