Retail Media Area

BETA

Agent Gateway is in BETA, and we're continuing to expand its capabilities. Your feedback helps shape what we build next—reach out to us through Relewise Support.

The Retail Media Area is available only for Datasets with the Retail Media feature enabled. See the Retail Media documentation for the underlying concepts and configuration guidance.

The Retail Media Area lets you inspect Advertisers, Campaigns, Display Ads, and Location settings, update Advertiser state and Campaign approval, schedules, and budgets, and review Campaign performance.

Get Started covers connection and access setup. REST paths below are relative to the Dataset base URL.

Available Capabilities

Capability	REST Endpoint	MCP Tool
List Advertisers	GET /retail-media/advertisers	list_advertisers
Get an Advertiser	GET /retail-media/advertisers/{advertiserId}	get_advertiser
List Campaigns	GET /retail-media/campaigns	list_campaigns
Get a Campaign	GET /retail-media/campaigns/{campaignId}	get_campaign
List Display Ads	GET /retail-media/advertisers/{advertiserId}/display-ads	list_display_ads
Get a Display Ad	GET /retail-media/advertisers/{advertiserId}/display-ads/{displayAdId}	get_display_ad
List Locations	GET /retail-media/settings/locations	list_retail_media_locations
Get Location settings	GET /retail-media/settings/locations/{locationKey}	get_retail_media_location
Update Advertiser state	PATCH /retail-media/advertisers/{advertiserId}	update_advertiser
Update Campaign approval, schedule, or budget	PATCH /retail-media/campaigns/{campaignId}	update_campaign
Get Campaign performance	GET /retail-media/campaigns/{campaignId}/performance	get_campaign_performance

Inspect Retail Media Configuration

List entities to discover Advertiser and Campaign IDs (GUIDs), Display Ad IDs (strings), and Location Keys (strings). Display Ad requests require the owning Advertiser ID; a detail request with a different Advertiser returns no match. Retrieve Location settings to inspect nested Placements and Variations.

All four lists, including Locations, support the shared page-number pagination through REST and MCP. Keep filters unchanged and advance while pageNumber is below pagination.totalPages. In My Relewise, Ask AI lists return only the first 50 matches and use isTruncated to indicate more matches.

Display Ad Data Values are JSON-encoded in valueJson; interpret them using the returned Data Type. Configuration fields ending in Json contain SDK JSON. Preserve supported $type metadata when parsing or forwarding promotion restrictions, conditions, and filters. See Filters for embedded filter structure.

Change State, Schedule, or Budget

Read the current configuration before updating it. These operations modify live configuration while preserving targeting, conditions, and promotions. Archived Advertisers and Campaigns cannot be changed.

Set Advertiser state to Active or Inactive, or Campaign state to Approved or Proposed. An Approved Campaign can serve only when its schedule, budget, and eligibility also permit it.

For REST PATCH requests and MCP updates, omitted or null outer values preserve the corresponding setting. Supplied schedule and budget objects replace those settings:

• Schedule: Include both boundaries if both should remain set. An omitted or null inner boundary clears that boundary.
• Budget: Use type: "cpm" and supply costPerMille. An omitted or null maximumTotalCost removes the spending cap. Values use the Campaign's existing monetary unit; do not infer a currency code. Request and response budget schemas differ, so use the update schema when constructing a request.

Interpret Campaign Performance

Choose a UTC interval of at most 366 days. Future end times are capped at now. Responses include time buckets and entity breakdowns for the requested interval; no comparison period is added.

Sponsored Product views, sales quantity, and revenue include all channels and are not ad-attributed conversions. Revenue is separated by currency; never combine different currencies into one total. Display Ads provide promotion and click metrics. Keep the returned metric terminology when presenting results. These reports do not provide spend or ROAS.

For complete inputs, encoded configuration guidance, and response schemas, use the API reference or MCP tool discovery.