📘 Parameter Parameter Description Type Required Possible Values advertiserId ID of advertiser integer Y Unique numeric identifier Filter[adGroupId] returns response for specific ad group IDs listed.Note: Max size is 25 integer At least one of Filter[adGroupId] or Filter[creativeId] must be included in the request Unique numeric identifier Filter[creativeId] returns response for specific creative Ids listed.Note: Max size is 25 string At least one of Filter[adGroupId] or Filter[creativeId] must be included in the request Unique numeric identifier Filter[lastModifiedDate] Returns list of creative ad group associations created/modified after the date specified date ISO 8601 timezone, Date should be in format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX startIndex You can use this parameter to fetch specific number of creative ad group associations from a list. This indicates the starting position of the list integer N Valid 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
integer N Valid 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
cURL
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 }'
cURL
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 }'Element Description Type totalResults Total number of rows returned in the response integer response response is an array.
here
**_
array
Element Description Type advertiserId ID of the advertiser integer adGroupId ID of the AdGroup where the creative is added integer creativeId ID of creative to be associated string urlTracker Specifies the tracking and click-through URLs for each supported ad unit
here
**_
Array adGroupStatus adGroup Status.ENUM Values: DRAFT, SCHEDULED, SUBMITTED, LIVE string creativeStatus creative StatusENUM Values : DRAFT, PENDING_APPROVAL, APPROVED, REJECTED string creationDate Date when the creative was added to the ad group. Data type date lastUpdatedDate Date when creative ad group association was last modified. Data type date badgeSettings List of badge configurations. Each object can have:
_**The badgeSettings objects are detailed
here
**_
Array showPrice If true, strike through price will be displayed in the creative. Boolean associatedItems List of item IDs to be associated with the creative. Max size: 5 Array<string>
Parameters Notes Type adUnit Ad 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 clickUrlDesktopMWeb Click 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 clickUrlApp Click 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 dcmClickUrlDesktopMWeb DCM click tracker for Desktop & mWeb string dcmClickUrlApp DCM click tracker for App string dcmImprUrlDesktopMWeb DCM impression tracker for Desktop & mWeb string dcmImprUrlApp DCM impression tracker for App string iasImprUrlDesktopMWeb IAS impression tracker for Desktop & mWeb string iasImprUrlApp IAS impression tracker for App Array dvImprUrlDesktopMWeb DV impression tracker for Desktop & mWeb Boolean dvImprUrlApp DV impression tracker for App Array<string> iasDesktopMWebTag IAS IVT/Viewability tracking on Desktop & mWeb string dvDesktopMWebTag DV IVT/Viewability tracking on Desktop & mWeb string
Each object represent the each badge setting. Optional field, badgeSettings type array, mandatorily specify associatedItems if enabled is set to true.
Element Description Type enabled Specifies whether the badge is enabled or disabled. boolean type Type of Badge 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 fieldsDedicated fields for DCM click tracking have been introduced: dcmClickUrlDesktopMWeb, dcmClickUrlApp. Viewability tracking updateThe previous desktopMWebTag field has been replaced with separate fields to support IAS and DV viewability tags independently: iasDesktopMWebTag and dvDesktopMWebTag
JSON
{
"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" ] } ]
}JSON
{ "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" ] } ]
}
