Update Existing Ad Group- Creative association

Note: PUT API requests will overwrite all current values and are not intended to be used as incremental updates like PATCH operations

Update click URLs and 3p trackers for creatives previously added to ad group, by specifying the request parameters.
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

📘

URL: PUT/api/v1/adGroupCreativeAssociations

Request Parameters


ParameterNotesTypeRequired Possible Values
advertiserIdThe ID of the advertiserintegerYUnique numeric identifier
adGroupIdThe ID of the ad groupintegerYUnique numeric identifier
creativeIdThe ID of creative that has been previously added and is scheduled for an updatestringYUnique numeric identifier
urlTrackerUse this parameter to Specify click URLs and 3P trackers for each ad unit. It is an array holding following elements:

  • adUnit: Available ad units
    Data type: string
    Required: N
    Values: marquee,
    skyline,
    brandbox,
    gallery

  • 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)
    Data type: string
    Required: N
    Values: valid URL

  • 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)
    Data type: string
    Required: N

  • dcmClickUrlDesktopMWeb: DCM Click URL for Desktop & mWeb associated with specified adUnit. DCM redirect URLS must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)
    Data type: string
    Required: N

  • dcmClickUrlApp: DCM Click URL for app associated with specified adUnit. DCM redirect URLS must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)
    Data type: string
    Required: N

  • iasClickUrlDesktopMWeb: IAS Click URL for Desktop & mWeb associated with specified adUnit
    Data type: string
    Required: N

  • iasClickUrlApp: IAS Click URL for app associated with specified adUnit
    Data type: string
    Required: N

  • dvClickUrlDesktopMWeb: : DV Click URL for Desktop & mWeb associated with specified adUnit
    Data type: string
    Required: N

  • dvClickUrlApp: DV Click URL for app associated with specified adUnit
    Data type: string
    Required:

  • desktopMWebTag: 3p viewability and IVT trackers. IAS or DV only.
    Data type: string
    Required: N
string

Sample Request

curl -X PUT \
'https://developer.api.us.stg.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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" }, { "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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" } ] }
]' Sample Request (Batch Operation) curl -X PUT \
'https://developer.api.us.stg.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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" }, { "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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" } ] }, { "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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" }, { "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", "iasClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "iasClickUrlApp" : "https://test.com/def.jpeg", "dvClickUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dvClickUrlApp" : "https://test.com/def.jpeg", "desktopMWebTag" : "https://test.com/abc.js" } ] } ]' 

Response


ElementDescriptionType
codeThe response code can have following values:
• success
• failure
string
detailsDetails will populate success or error message depending upon value of codestring
adGroupIdID of the ad group being updatedinteger
creativeIdID of the creativestring

Sample Response

[ { "code": "success", "details": "ADGROUP_CREATIVE_ASSOCIATION_UPDATED_SUCCESSFULLY", "adGroupId": 1, "creativeId": "abcd-1234" }
] 

Sample Response(Batch Operation)

[ { "code": "success", "details": ["string"], "adGroupId": 1, "creativeId": "abcd-1234" }, { "code": "failure", "details": ["string"], "adGroupId": 1, "creativeId": "abcd-12345" }
]