Using Discovery APIs
Retrieve targeting, geotargeting, and landing page IDs for Display workflows.
Overview
Discovery APIs provide access to the reference data used throughout Walmart Connect Display workflows.
Most Campaign Management, Creative, Audience, and Reporting APIs require IDs rather than human-readable values. Discovery APIs provide the IDs and metadata needed to build valid requests.
Use Discovery APIs to:
- Retrieve targeting IDs
- Retrieve geotargeting IDs
- Retrieve Brand Shop and Shelf identifiers
Availability
Discovery APIs support Onsite Display workflows.
How it works
Discovery APIs are typically the first step in a workflow.
Rather than manually managing IDs, partners use Discovery APIs to retrieve the latest reference data directly from Walmart Connect.
Discovery APIs
Retrieve reference data and IDs.
Build Requests
Use IDs in Campaign, Audience, and Creative APIs.
Create Objects
Create campaigns, audiences, creatives, and targeting.
Launch
Activate delivery workflows.
Report
Use metadata to interpret reporting results.
Discovery API categories
Walmart Connect offers several Discovery API categories that support campaign setup, targeting, creative association, and reporting workflows.
POST api/v2/targeting/listRetrieve audience and contextual targeting identifiers.
POST api/v1/geoLocations/listRetrieve country, state, city, and DMA targeting IDs.
POST api/v1/brand-landing-pages/listRetrieve Brand Shop and Shelf identifiers for campaign landing page destinations.
Choosing the right Discovery API
Use the table below to determine which Discovery API category best matches your workflow.
| Need | Discovery API Category |
|---|---|
| Audience IDs and contextual targeting IDs | Targeting |
| Country, state, city, DMA, and ZIP targeting IDs | Geotargeting |
| Brand Shop and Shelf identifiers | Brand Landing Pages |
Common workflows
Campaign creation
Retrieve targeting IDs, geotargeting IDs, and landing page IDs before creating campaigns and ad groups.
Audience creation
Retrieve targeting IDs before creating custom audiences.
Landing page setup
Retrieve Brand Shop and Shelf IDs before configuring campaign destinations.
Reporting and validation
Retrieve metadata needed to validate campaign setup and interpret reporting outputs.
Common use cases
- Populate UI dropdowns
- Validate targeting inputs
- Retrieve IDs for specific geotargets
- Retrieve Brand Shop and Shelf identifiers
- Build valid Campaign Management requests
- Build valid Audience Management requests
What happens next
After retrieving discovery data:
- Create campaigns and ad groups
- Build audiences
- Configure targeting
- Configure Brand Shop and Shelf destinations
Related pages
Updated about 4 hours ago
