Skip to main content

Overview

Use enriched creative search to retrieve an account’s creatives together with the product collection constraints of each creative’s template. This helps you prepare product assignments and check how many collections and products a template supports without a separate template lookup for every creative. Each result contains the latest creative version, identified by a creative ID that stays the same across edits. Template constraints include retailer-specific overrides.
Availability: AvailableThis endpoint is available in the Experimental and Release Candidate versions of the Retail Media API. Experimental endpoints may change without prior notice. See the versioning policy.
The endpoint requires the RetailMedia_Campaign_Read scope and permission to view creatives in the account. See Authentication and App Scopes.

Endpoints


Search Enriched Creatives

Returns the latest non-archived version of each matching creative, with optional filters on creative, retailer, template, and page type.

Path Parameters

Query Parameters

Request Attributes

All attributes below are nested under data.attributes. The resource type is CreativeSearchEnrichedRequest. All filters are optional; send attributes: {} to search without filters. The pageTypes contract accepts Unknown, Search, Home, Browse, Checkout, Category, ProductDetail, Confirmation, Merchandising, Deals, Favorites, SearchBar, and CategoryMenu. Actual matches depend on configured placements. Sample Request

Response Attributes

Results are returned as a paginated array under data. Each result has a stable creative id, resource type of CreativeSearchEnrichedResponse, and the following read-only attributes in data[].attributes.

Product Collection Constraints

These values describe what the template allows, with retailer-specific overrides applied. They do not report how many products are currently assigned to a creative or line item. For example, productCollectionsMin: 0 and productCollectionsMax: 0 mean that the template has no product collections. A minimum of 0 with a positive or unlimited maximum allows optional collections. A positive minimum requires at least that many collections; productsPerCollectionMin specifies the minimum number of products in each collection. The response also includes a metadata object with pagination fields: For the next page, keep the same filters and increase offset by limit. A search with no matches returns 200 OK, an empty data array, and metadata.count: 0. Sample Response — 200 OK

Stable Creative IDs

The id stays the same across creative edits. Store this ID for creative retrieval and update operations. It can differ from the latest-version ID returned by Search for Creatives. This endpoint uses the CreativeSearchEnrichedRequest and CreativeSearchEnrichedResponse resource types. It adds the seven template constraint attributes, omits brandId and lineItems from the response, and has no brandIds request filter.

Errors and Warnings

Invalid IDs within a filter produce warnings rather than failing the request. The service drops invalid IDs and searches using the valid IDs that remain. If any supplied ID filter contains only invalid IDs, the response is 200 OK with an empty data array, metadata.count: 0, and warnings. This does not broaden the search to all creatives.