Add Creatives to Ad Groups

Associates a given creative with a specified ad group along with optional tracking URLs, and badge configurations

📘

URL: POST/api/v1/adGroupCreativeAssociations

Note:

  • This API supports batch operations with a max batch size of 5. For bulk operation, the advertiserId must be the same across all requests in the payload
  • An ad group can only include creatives that are APPROVED or PENDING. Furthermore, for an ad group to go live, it must contain at least one APPROVED creative

Request Parameters

ParameterNotesTypeRequired Possible Values
advertiserIdThe ID of the advertiserintegerYUnique numeric identifier
adGroupIdThe ID of the ad groupintegerYUnique numeric identifier
creativeIdThe ID of the creative to be added to the ad groupstringYUnique numeric identifier
urlTrackerSpecifies the tracking and click-through URLs for each supported ad unit

Note: To ensure complete ad delivery on all ad units, ensure that clickUrl* is provided for all ad units (marquee, skyline, gallery, brandbox, tile ) while associating a creative.
The urlTracker objects are detailed

here

string
badgeSettingsList of badge configurations. Each object can have:
  • type (Enum: ROLLBACK, EXPRESS_DELIVERY)
  • enabled (default: true)


Note: Badges can be enabled only for eligible creatives. Refer to the eligibleBadges field in the List Creatives API response to determine which badges are applicable for each creative"

The badgeSettings objects are detailed

here

Array NEnum Values: ROLLBACK, EXPRESS_DELIVERY
showPriceWhen true, the item’s price appears in the creative.
Default is false if the field is omitted.

Note:
You may set showPrice = true for eligible creatives only when exactly one item is associated with the creative.
BooleanN
  • true
  • false(default)
associatedItemsList of item IDs to be associated with the creative. Max size: 5

The items should be part of the campaign's featured itemset.
ArrayNvalid itemId

urlTracker Objects

ParameterNotesTypeRequiredPossible Values
adUnitAvailable ad units.
Note:
  • Use this field to configure landing pages and trackers for all supported ad units within a creative..
  • Value allowed when mediaType = BANNER for corresponding Campaign: SKYLINE, MARQUEE, GALLERY, BRANDBOX, TILE
stringYSKYLINE, MARQUEE, GALLERY, BRANDBOX, TILE
clickUrlDesktopMWebClick URL for Desktop & mWeb associated with specified adUnit. URLs must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)
These URLs are mandatory to pass when landing page Urls are not updated on adGroup level, But if its there on adGroup level these values become optional and its mandatory to be passed
stringY
clickUrlAppClick URL for App associated with the specified adUnit. Direct links must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)
These URLs are mandatory to pass when landing page Urls are not updated on adGroup level, But if its there on adGroup level these values become optional and its mandatory to be passed
stringY
dcmClickUrlDesktopMWebDCM click tracker for Desktop & mWebstringN
dcmClickUrlAppDCM click tracker for App.
Note: If this field is omitted, the system will automatically use the value provided in dcmClickUrlDesktopMWeb.
stringN
dcmImprUrlDesktopMWebDCM impression tracker for Desktop & mWebstringN
dcmImprUrlAppDCM impression tracker for AppstringN
iasImprUrlDesktopMWebIAS impression tracker for Desktop & mWebstringN
iasImprUrlAppIAS impression tracker for AppstringN
dvImprUrlDesktopMWebDV impression tracker for Desktop & mWebstringN
dvImprUrlAppDV impression tracker for AppstringN
iasDesktopMWebTagIAS IVT/ Viewability tracking on Desktop & mWebstringN
dvDesktopMWebTagDV IVT/ Viewability tracking on Desktop & mWebstringN

badgeSettings Objects

Each object represent the each badge setting. Optional field, badgeSettings type array, mandatorily specify associatedItems if enabled is set to true.

ParametersNotesTypeRequiredPossible Values
enabledSpecifies whether the badge is enabled or disabledbooleanNdefault: true
typeType of BadgestringYEnum values: ROLLBACK, EXPRESS_DELIVERY

👉

General guidelines

  • You must specify both clickUrlDesktopMWeb and clickUrlApp for each ad unit; missing URLs may prevent the ad from serving.
  • If dcmClickUrlApp is omitted, the system will automatically use the value provided in dcmClickUrlDesktopMWeb.
  • Supported ad units for this API are: SKYLINE, MARQUEE, GALLERY, BRANDBOX, TILE.
  • Refer to the adUnits field in the List Creative API response to determine which creatives are compatible with these ad unit groups. The List Creative API uses more specific identifiers for (e.g., skylineAppV2, galleryDesktop), but for this API, you should use the high-level types: SKYLINE, MARQUEE, GALLERY, BRANDBOX, TILE
  • The clickUrl* fields provided for a given high-level ad unit (e.g., SKYLINE) will apply to all versions of that ad unit, including skyline, skylineV2, and skylineV3.
  • When using associatedItems to link an item to a creative, the item must be part of the campaign’s featured itemset (promoted items)
  • If a creative already has an associated item (defined while building the creative), it can only be added to an ad group if that SKU’s item is included in the campaign’s featured itemset (promoted items)

👉

Rules for Badges, showPrice, items, and clickUrl

  • Badge activation
    • Badges can be enabled only for eligible creatives. Refer to the eligibleBadges field in the List Creatives API response to determine which badges are applicable for each creative.
    • if badgeSettings is omitted or is an empty array → badges disabled for the creative
    • badgeSettings present without an enabled field → enabled defaults to true
    • When a badge is enabled, the clickUrl for DesktopMWeb and App must be same.
  • showPrice
    • showPrice can be set to true only when
      • exactly 1 item is associated to the creative
      • if the creative is created after 06/30/2025
  • Item limits
    • Up to 5 items can be associated to a creative
    • Retrieve valid itemId values from itemId in POST /api/v1/items/list
  • clickUrl if badge or price is enabled
    • 1 item linked → clickUrl must point to that item’s product detail page (PDP).
    • 2–5 items linked → clickUrl must point to a shelf page generated from the creative’s featured item set.
  • If you want to set your creative’s landing page to a Brand Shop or Shelf page, use the advertisingUrl value returned from the POST /api/v1/brand-landing-pages/list endpoint.

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the APIYPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide. This key can be repurposed for SP API access as well.
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 further explanation on this
WM_SEC.AUTH_SIGNATUREAuth signature as an API keyYUse the signature generator code from Getting Started Guide to generate this value
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestampYUse the signature generator code (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 APIY1

Sample Request - Creative Association with only Rollback badge enabled

curl --location --request POST 'https: //developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '[ { "advertiserId": 1, "adGroupId": 1, "creativeId": "abcd-1234", "urlTracker": [ { "adUnit": "MARQUEE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "GALLERY", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "SKYLINE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "BRANDBOX", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "TILE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": true, "type": "ROLLBACK" } ], "showPrice": false, "associatedItems": [ "12345", "3456" ] }
]'

Sample Request - with all badges enabled

curl --location --request POST 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '[ { "advertiserId": 1, "adGroupId": 1, "creativeId": "abcd-1234", "urlTracker": [ { "adUnit": "MARQUEE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "GALLERY", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "SKYLINE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "BRANDBOX", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "TILE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": true, "type": "ROLLBACK" }, { "enabled": true, "type": "EXPRESS_DELIVERY" } ], "showPrice": true, "associatedItems": [ "12345" ] } ]'

Sample Request (Batch Operation)

curl --location --request POST 'https: //developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '[ { "advertiserId": 1, "adGroupId": 1, "creativeId": "abcd-1234", "urlTracker": [ { "adUnit": "MARQUEE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "GALLERY", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "SKYLINE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "BRANDBOX", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "TILE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": false, "type": "ROLLBACK" } ], "showPrice": false, "associatedItems": [ "12345", "65341" ] }, { "advertiserId": 1, "adGroupId": 2, "creativeId": "abcd-1234", "urlTracker": [ { "adUnit": "MARQUEE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "GALLERY", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "SKYLINE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "BRANDBOX", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit": "TILE", "clickUrlDesktopMWeb": "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp": "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb": "https://test.net", "dcmClickUrlApp": "https://test.net", "dcmImprUrlDesktopMWeb": "https://test.com/abd.jpeg", "dcmImprUrlApp": "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb": "https://test.com/def.jpeg", "iasImprUrlApp": "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb": "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": true, "type": "EXPRESS_DELIVERY" } ], "showPrice": false, "associatedItems": [ "12345" ] }
]' 


Response

ElementDescriptionType
codeThe response code can have following values:
  • success
  • failure

Click here for more information about Status Codes and Errors
string
detailsDetails will populate success or error message depending upon value of codearray
adGroupIdID of the ad group being added to the ad grouplong
creativeIdID of the creativestring

Sample Response - Creative Association with only Rollback badge enabled

[ { "code": "success", "details": [ "CREATIVE_AD_GROUP_ASSOCIATION_MARQUEE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_GALLARY_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_BRANDBOX_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_SKYLINE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_TILE_CREATE_SUCCESS"], "adGroupId": 1, "creativeId": "abcd-1234" }
] 

Sample Response - with all badges enabled

[ { "code": "success", "details": [ "CREATIVE_AD_GROUP_ASSOCIATION_MARQUEE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_GALLARY_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_BRANDBOX_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_SKYLINE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_TILE_CREATE_SUCCESS"], "adGroupId": 1, "creativeId": "abcd-1234" }
] 

Sample Response (Batch Operation)

[ { "code": "success", "details": [ "CREATIVE_AD_GROUP_ASSOCIATION_MARQUEE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_GALLARY_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_BRANDBOX_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_SKYLINE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_TILE_CREATE_SUCCESS" ], "adGroupId": 1, "creativeId": "abcd-1234" }, { "code": "success", "details": [ "CREATIVE_AD_GROUP_ASSOCIATION_MARQUEE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_GALLARY_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_BRANDBOX_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_SKYLINE_CREATE_SUCCESS", "CREATIVE_AD_GROUP_ASSOCIATION_TILE_CREATE_SUCCESS" ], "adGroupId": 2, "creativeId": "abcd-1234" }
]