What the API Can Do

​

Overview

The Retail Media API exposes capabilities across ten domains. Use this page to find the right endpoint for what you want to build, or to understand the full scope of what the API supports. All endpoints below are available in the 2027-01 Release Candidate. Replace /2027-01/ with the version prefix for your target version.

• Account management — access and configure accounts, brands, and sellers
• Audiences — build and manage audience segments for targeting
• Balances and billing — fund campaigns and pull billing reports
• Campaigns — create and manage campaigns and their budgets
• Catalog and retailer planning — explore retailers, browse categories, and export product data
• Creatives and assets — build display ads from retailer templates
• Keywords — manage keyword targeting and bids for Sponsored Products
• Line items — set up ad placements for Sponsored Products and Onsite Display
• Performance reporting — measure campaign results with async and sync reports
• Promoted products — control which products are advertised on a line item

---

​

Account management

Discover and configure the accounts, brands, and sellers that campaigns run under. Start here to find account IDs, set up brand and seller relationships, manage platform fees, and verify the identity of the calling API credentials.

---

​

Audiences

Build and manage audience segments used to target Onsite Display line items. Create segments from contact lists, update membership in bulk, and search available audiences for an account.

---

​

Balances and billing

Manage the budget pools that campaigns draw from. Create balances, add funds, adjust dates, and link or unlink campaigns. Pull billing reports to reconcile spend.

---

​

Campaigns

Create and manage campaigns — the containers that group line items and hold shared attribution settings, flight dates, and budget. A campaign must exist and be linked to at least one balance before any line item can deliver.

---

​

Catalog and retailer planning

Explore the retailer landscape before building campaigns. Browse categories, get keyword and category recommendations for your SKUs, check minimum bids, export your product catalog, and monitor catalog ingestion health.

---

​

Creatives and assets

Build the display ads used in Onsite Display campaigns. Upload image assets, create creatives from the retailer’s available templates, and manage the creative library for an account.

---

​

Keywords

Add and manage keyword targets for Sponsored Products line items. Set individual bids per keyword, add or remove keywords in bulk, and submit them for retailer review before they can serve.

---

​

Line items

Configure the individual ad placements within a campaign. Sponsored Products line items compete in auction and target by keyword or category; Onsite Display line items run on preferred deals and target by audience, add-to-basket behavior, or store. Both types share endpoints for budget overrides and bid multipliers.

​

Sponsored Products (auction)

​

Onsite Display (preferred deals)

​

Shared

---

​

Performance reporting

Measure what your campaigns delivered. Async reports cover the full range of metrics and dimensions; submit a report, poll for completion, then download the output. Sync reports return results immediately for lightweight real-time checks.

​

Asynchronous reports

​

Synchronous reports

---

​

Promoted products

Specify which products appear on a line item and control their active state. Each product can carry its own bid; a line item supports up to 500 promoted products.