Guides

Creative Metadata v2

📘

URL: POST /api/v2/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 \
--location 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v2/creatives/metadata' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_CONSUMER.ID: <consumerId>' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.INTIMESTAMP: 0000000000000' \
--header 'WM_SEC.AUTH_SIGNATURE: '**************' \
--data '{ "advertiserId": 00000000, "creativeId": "aaaa3333-aa33-aa33-aa33-aaaaaa333333" }' \

Response

ElementDescriptionType
response
  • metadata
    • name
    • folderId
  • adUnits: Each object within adUnits contains the following fields:
    • adUnitName: name of the ad unit
      • Desktop ad units: marqueeDesktop, brandboxDesktop, galleryDesktop, tileDesktop, skylineDesktop, skylineDesktopV2, skylineDesktopV3
      • App ad units: marqueeApp, tileApp, brandboxApp, galleryApp, skylineApp, skylineAppV2, skylineAppV3
    • headline: String.
    • subhead: String.
    • cta: Call to action. String.
    • imageAltText: Field to provide description of what’s visually represented in your ad. String.
    • logoAltText: Field to provide description to logo image. String.
    • legalDisclaimerText: 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
JSON object
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": [ { "advertiserId": "01234567", "metadata": { "name": "sampleName", "folderId": "00000000-0000-0000-0000-000000000000", "templateId": 000 }, "adUnits": [ { "adUnitName": "marqueeApp", "headline": "Sample Headline", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "marqueeDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineAppV2", "headline": "Sample Headline", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineAppV3", "headline": "Sample Headline", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy", "backgroundColorHex": "#FFFFFF", "textColor": "gray" }, { "adUnitName": "tileDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxApp", "headline": "Sample Headline", "subhead": "Sample Subhead", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "galleryDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineDesktopV2", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "tileApp", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineDesktopV3", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy", "backgroundColorHex": "#FFFFFF", "textColor": "white" }, { "adUnitName": "skylineDesktop", "headline": "Sample Headline", "subhead": "Sample Subhead", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "galleryApp", "headline": "Sample Headline", "cta": "Click Here", "imageAltText": "Sample image alt text", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "skylineApp", "headline": "Sample Headline", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "checkInVideo", "legalDisclaimerLabel": "Sample label", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxDesktopVideo", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" }, { "adUnitName": "brandboxAppVideo", "headline": "Sample Headline", "subhead": "Sample Subhead", "cta": "Click Here", "logoAltText": "Sample logo alt text", "legalDisclaimerLabel": "Sample label", "legalDisclaimerText": "Sample disclaimer text", "legalDisclaimerPopUpCopy": "Sample disclaimer popup copy" } ] } ], "totalResults": 1
}

Updated 2 days ago