Sample Response -Entity Snapshot

To Retrieve campaign Entity Report

Sample Response 1 for Offsite display

[ { "code" : "success", "snapshotId" : "1a", "details" : "https://advertising.walmart.com/display/file/1a", "jobStatus". : "done" }
]

The snapshot file is in JSON format that includes response for each entity type.The response would be captured in one gzip file.

Sample Response 1 for Onsite display

[ { "code" : "success", "snapshotId". : "1b", "details" : "https://advertising.walmart.com/display/file/1b", "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 1a

curl-X GET\ 'https://advertising.walmart.com/display/file/1a?advertiserId=600001' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “1a”. The file format is “json”

{ "campaignId": 100, "campaignExtId": 200, "name": "Test Camp 2", "status": "ACTIVE", "campaignType": "Offsite", "advertiserId": 600001, "creationDate": "2022-12-08T10:27:36.153", "lastUpdatedDate": "2022-12-08T10:27:38.623" }

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 1b

curl-X GET\ 'https://advertising.walmart.com/display/file/1b?advertiserId=600001' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “1b”. The file format is “json”

 { "campaignId": 12, "campaignExtId": 312, "name": "Test Campaign 3", "description": "Test Campaign sample description", "status": "LIVE", "campaignType": "GD", "advertiserId": 600001, "creationDate": "2022-12-08T10:27:36.153", "lastUpdatedDate": "2022-12-08T10:27:38.623" },
{ "campaignId": 12486, "campaignExtId": 3120869422, "name": "Test Campaign 4", "description": "Test Campaign sample description", "status": "SCHEDULED", "campaignType": "GD", "advertiserId": 600001, "creationDate": "2022-12-08T10:27:36.153", "lastUpdatedDate": "2022-12-08T10:27:38.623" }

To Retrieve lineItem Entity Report

Sample Response 2 for Offsite display

[ { "code" : "success" , "snapshotId" : "2a", "details" : "https://advertising.walmart.com/display/file/2a" , "jobStatus" : "done" }
]

Sample Response 2 for Onsite display

[ { "code" : "success" , "snapshotId" : "2b", "details" : "https://advertising.walmart.com/display/file/2b", "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 2a

curl-X GET\ 'https://advertising.walmart.com/display/file/2a?advertiserId=600003' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “2a”. The file format is “json”

 { "campaignId": 100, "lineItemId": 1, "lineItemExtId": 200, "name": "nameTestNew", "status": "INACTIVE" }, { "campaignId":101, "lineItemId": 2, "lineItemExtId": 300, "name": "nameTestNew2", "status": "INACTIVE" }

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 2b

curl-X GET\ 'https://advertising.walmart.com/display/file/2b?advertiserId=600003' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “2b”. The file format is “json”

{ "campaignId": 10000, "lineitemId": 10032, "lineitemExtId": 567010056, "name": "Test LineItem Name 1", "status": "DRAFT", "startDate": "2023-03-08T19:59:41", "endDate": "2023-03-27T19:59:41", "budgetType": "LIFETIME", "totalBudget": 12, "dailyBudget": 2, "rateType": "CPM", "deliveryRateType": "EVENLY", "frequencyCapDay": 12, "frequencyCapWeek": 11, "frequencyCapMonth": 10, "rate": 12, "bookedImpressions": 1000, "baseBid": 10, "maxBid": 20, "targeting": { "or": [ { "and": [ { "contextual": [ { "id": 1, "name": "baby foods", "reach": "tier_1", "mappingType": "PRODUCT_CATEGORY" }, { "id": 2, "name": "baby diapers", "reach": "tier_3", "mappingType": "PRODUCT_FAMILY" } ] }, { "behavioral": [ { "audienceType": "RETAIL", "attribute": "HISTORICAL", "id": 1, "name": "tropicana", "mappingType": "PRODUCT_CATEGORY" }, { "audienceType": "BRAND", "attribute": "HISTORICAL", "id": 2, "name": "sprite" }, { "audienceType": "CUSTOM", "attribute": "RULE_BASED", "id": 3, "name": "barbie brand buyers 1x12" }, { "audienceType": "PERSONA", "attribute": "LIFESTYLE", "id": 4, "name": "Home Interior Improvement" }, { "audienceType": "BRAND", "attribute": "LAPSED_BUYERS", "id": 5, "name": "WMG_10032599_Lapsed Buyers of pillsbury" } ] }, { "not": [ { "contextual": [ { "id": 10, "name": "baby diapers", "reach": "tier_1", "mappingType": "PRODUCT_CATEGORY" } ] } ] } ] }, { "runOfSite": false }, { "keywords": [ { "keywordText": "tkey1", "matchType": "BROAD", "reviewStatus": "PENDING_REVIEW", "reviewComments": "conquesting" } ] }, { "geoTargets": [ { "id": 252413, "name": "Alabama", "locationType": "STATE" }, { "id": 552093, "name": "Alaska", "locationType": "STATE" }, { "id": 1692208, "name": "Abbeville", "locationType": "CITY" } ] } ] }, "creationDate": "2023-03-06T17:04:57.463", "lastUpdatedDate": "2023-03-09T16:57:39.933" }

To Retrieve both campaign and lineItem Entities Report Together

Sample Response 3 for Offsite display

[ { "code" : "success" , "snapshotId" : "3a", "details" : "https://advertising.walmart.com/display/file/3a", "jobStatus" : "done" }
]

Sample Response 3 for Onsite display

[ { "code" : "success" , "snapshotId" : "3b", "details" : "https://advertising.walmart.com/display/file/3b" , "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 3a

curl-X GET\ 'https://advertising.walmart.com/display/file/3a?advertiserId=600003' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “3a”. The file format is “json”

{ "campaigns": [ { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite1", "startDate": "2023-01-01T00:00Z", "endDate": "2023-01-31T23:59Z", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-13T20:29:43.443Z", "lastUpdatedDate": "2022-12-13T20:29:43.443Z" }, { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite2", "startDate": "2022-12-21T00:00Z", "endDate": "2023-01-31T23:59Z", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-16T19:17:30.623Z", "lastUpdatedDate": "2023-06-23T22:06:12.533Z" }, { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite3", "startDate": "2022-12-21T00:00Z", "endDate": "2023-01-31T23:59Z", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-16T19:47:44.983Z", "lastUpdatedDate": "2023-06-23T22:06:01.043Z" } ], "lineItems": [ { "name": "Test Lineitem 1", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "ACTIVE" }, { "name": "Test Lineitem 2", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "INACTIVE" }, { "name": "Test Lineitem 3", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "ACTIVE" } ]
}

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 3b

curl-X GET\ 'https://advertising.walmart.com/display/file/3b?advertiserId=600003' \ --header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779'\

Example of the content of snapshot with id “3b”. The file format is “json”

{ "campaigns": [ { "campaignId": 1, "campaignExtId": 100, "name": "Test Campaign 1", "campaignType": "NGD", "status": "LIVE", "advertiserId": 0, "creationDate": "2022-10-06T00:02:34.987", "lastUpdatedDate": "2023-04-19T03:03:57.54" } ], "lineItems": [ { "campaignId": 1, "lineItemId": 1, "lineItemExtId": 100, "name": "Test Line 1", "status": "LIVE", "startDate": "2022-10-06T00:00:00", "endDate": "2025-04-01T23:59:59", "budgetType": "DAILY", "totalBudget": 8.68, "dailyBudget": 100.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "baseBid": 50.0, "maxBid": 50.0, "frequencyCapDay": 5, "frequencyCapWeek": 10, "frequencyCapMonth": 20, "creationDate": "2022-10-06T04:05:34.63", "lastUpdatedDate": "2023-08-10T18:28:46.733", "targeting": { "and": [ { "runOfSite": true }, { "geoTargets": [ { "id": 2840, "name": "United States", "locationType": "COUNTRY" } ] } ] } } ]
}

Sample Response in case of no snapshotId Provided in Request

 [ { "code": "failure", "snapshotId": "", "details": "400 BAD_REQUEST \"Required String parameter 'snapshotId' is not present\"", "jobStatus": "" }
]