Guides

List Creatives added to Ad Group(s)

List creative(s) previously added to ad group, by specifying the request parameters

📘

URL: POST /api/v1/adGroupCreativeAssociations/list

Request Parameters

ParameterParameter DescriptionTypeRequiredPossible Values
advertiserIdID of advertiserintegerYUnique numeric identifier
Filter[adGroupId]returns response for specific ad group IDs listed.
Note: Max size is 25		integerAt least one of Filter[adGroupId] or Filter[creativeId] must be included in the requestUnique numeric identifier
Filter[creativeId]returns response for specific creative Ids listed.
Note: Max size is 25		stringAt least one of Filter[adGroupId] or Filter[creativeId] must be included in the requestUnique numeric identifier
Filter[lastModifiedDate]Returns list of creative ad group associations created/modified after the date specifieddateISO 8601 timezone, Date should be in format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
startIndexYou can use this parameter to fetch specific number of creative ad group associations from a list. This indicates the starting position of the list
Note: To return the first ten adGroupCreativeAssociations, set startIndex=0 and count=10		integerNValid integer value.
count

You can use this parameter in combination with startIndex to fetch specific number of creative ad group associations from a list.

Note: To return the first ten adGroupCreativeAssociations, set startIndex=0 & defaultCount=100, maxCount=100, minCount=1

integerNValid integer value

Note:

  • At least one of Filter[adGroupId] or Filter[creativeId] must be included in the request
  • If you pass only Filter[adGroupId] - details of creative ad group association for specified adGroupIds are returned
  • If you pass only Filter[creativeId] - details of creative ad group association for the specified creativeIds are returned
  • If you pass both Filter[adGroupId] and Filter[creativeId]: details of creative ad group associations for the matching combination of adGroupIds and creativeIds from the list specified, are returned

Sample Request - List all AdGroup Creative Associations in the account

curl --location --request POST 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations/list' \
--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, "startIndex": 0, "count": 10 }'

Sample Request - List ad group creative association by providing multiple filters

curl --location --request POST 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations/list' \
--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, "Filter[adGroupId]": [1], "Filter[creativeId]": ["abcd-1234"], "Filter[lastModifiedDate]": "string", "startIndex": 0, "count": 10 }'

Response

ElementDescriptionType
totalResultsTotal number of rows returned in the responseinteger
response

response is an array.
_**The response objects are detailed

here

**_

array

response Objects

ElementDescriptionType
advertiserIdID of the advertiserinteger
adGroupIdID of the AdGroup where the creative is addedinteger
creativeIdID of creative to be associatedstring
urlTracker

Returns the effective tracker configuration for each ad unit. This includes the final URLs and trackers applied after resolving defaultUrlTracker and any ad-unit-level urlTracker overrides provided in create or update requests.
Note: defaultUrlTracker is not returned by this endpoint

_**The urlTracker objects are detailed

here

**_

Array
adGroupStatusadGroup Status.
ENUM Values: DRAFT, SCHEDULED, SUBMITTED, LIVE		string
creativeStatuscreative Status
ENUM Values: DRAFT, PENDING_APPROVAL, APPROVED, REJECTED		string
creationDateDate when the creative was added to the ad group. Data type date
ISO 8601 timezone format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
lastUpdatedDateDate when creative ad group association was last modified. Data type date
SO 8601 timezone format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX
badgeSettings

List of badge configurations. Each object can have:

  • type
  • enabled

_**The badgeSettings objects are detailed

here

**_

Array
showPriceIf true, strike through price will be displayed in the creative.
Possible Values:
  • true
  • false (default)
Boolean
associatedItemsList of item IDs to be associated with the creative. Max size: 5Array<string>

urlTracker array Objects

ParametersNotesType
adUnitAd unit for which landing pages and trackers are configured.
Note: For standard display banner ads, the supported values are: SKYLINE, MARQUEE, GALLERY, BRANDBOX, TILE		string
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)string
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)string
dcmClickUrlDesktopMWebDCM click tracker for Desktop & mWebstring
dcmClickUrlAppDCM click tracker for Appstring
dcmImprUrlDesktopMWebDCM impression tracker for Desktop & mWebstring
dcmImprUrlAppDCM impression tracker for Appstring
iasImprUrlDesktopMWebIAS impression tracker for Desktop & mWebstring
iasImprUrlAppIAS impression tracker for AppArray
dvImprUrlDesktopMWebDV impression tracker for Desktop & mWebBoolean
dvImprUrlAppDV impression tracker for AppArray<string>
iasDesktopMWebTagIAS IVT/Viewability tracking on Desktop & mWebstring
dvDesktopMWebTagDV IVT/Viewability tracking on Desktop & mWebstring

badgeSettings Objects

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

ElementDescriptionType
enabledSpecifies whether the badge is enabled or disabled.
default: true		boolean
typeType of Badge
Enum values: ROLLBACK, EXPRESS_DELIVERY		string

Note:

  • Update on Tracker Field Corrections: We identified and corrected an issue in the API where some impression tracker fields were incorrectly labeled as click trackers. The following updates have been made:
    • Field correction for impression trackers
    • The DCM, IAS, and DV impression tracker fields were previously mislabeled as click trackers. These have now been correctly renamed:
      • dcmClickUrlDesktopMWeb, dcmClickUrlApp, dvClickUrlDesktopMWeb, dvClickUrlApp, iasClickUrlDesktopMWeb, iasClickUrlApp, and desktopMWebTag → replaced with dcmImpr*, iasImpr* and dvImpr* fields.
    • New click tracker fields
      • Dedicated fields for DCM click tracking have been introduced: dcmClickUrlDesktopMWeb, dcmClickUrlApp.
    • Viewability tracking update
      • The previous desktopMWebTag field has been replaced with separate fields to support IAS and DV viewability tags independently: iasDesktopMWebTag and dvDesktopMWebTag



    Sample Response - List all AdGroup Creative Associations in the account

    {
"totalResults": 1, "response": [ { "advertiserId": 1, "adGroupId": 1, "creativeId": "abcd-1234", "adGroupStatus": "ACTIVE", "creativeStatus": "APPROVED", "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" } ], "creationDate": "string", "lastUpdatedDate": "string", "badgeSettings": [ { "enabled": true, "type": "ROLLBACK" }, { "enabled": false, "type": "EXPRESS_DELIVERY" } ], "showPrice": false, "associatedItems": [ "12345", "65341" ] } ]
}

    Sample Response - List ad group creative association by providing multiple filters

    { "totalResults": 1, "response": [ { "advertiserId": 1, "adGroupId": 1, "creativeId": "abcd-1234", "adGroupStatus": "ACTIVE", "creativeStatus": "APPROVED", "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" } ], "creationDate": "string", "lastUpdatedDate": "string", "badgeSettings": [ { "enabled": true, "type": "ROLLBACK" }, { "enabled": false, "type": "EXPRESS_DELIVERY" } ], "showPrice": false, "associatedItems": [ "12345", "65341" ] } ]
}