Item set information APIs
Retrieve and validate Item Set status, contents, and configuration for Display workflows.
Overview
Use Item Set Information APIs to retrieve Item Set details, validate contents, monitor build status, and understand how an Item Set was constructed.
These endpoints do not create or update Item Sets. Instead, they help you discover, inspect, and validate existing Item Sets before using them in campaign measurement or audience targeting workflows.
Availability
Supported for Onsite Display Item Sets.
How it works
Different endpoints provide different levels of detail depending on what you need to learn about an Item Set.
1. List
Retrieve available Item Sets.
2. Select
Identify the correct Item Set.
3. Validate
Confirm build status is complete.
4. Inspect Contents
Review included products, brands, or categories.
5. Inspect Metadata
Review build logic and expressions.
6. Use
Apply the Item Set to campaigns or audiences.
Item Set Information endpoints
POST /api/v1/itemsets/listRetrieve Item Sets within an advertiser account, including build status, ownership, type, and sharing information.
POST /api/v1/itemsets/infoView the brands, categories, or products contained within a specific Item Set.
POST /api/v1/itemsets/expressionUnderstand how an Item Set was constructed, including brands, categories, attributes, and build logic.
How these APIs work together
Most workflows follow the sequence below:
- List Item Sets
- Identify the correct
itemsetId - Verify the Item Set status is
BUILD - Retrieve contents if you need to validate included products, brands, or categories
- Retrieve metadata if you need to understand build logic or expressions
- Use the Item Set in campaigns or audiences
Which endpoint should I use?
| I need to... | Endpoint |
|---|---|
| Find available Item Sets | List Item Sets |
| Check build status | List Item Sets |
| Verify products in an Item Set | Retrieve Item Set Contents |
| Understand category filters or expression logic | Retrieve Item Set Metadata |
| Determine whether an Item Set is measurement or targeting | List Item Sets |
| Understand how a targeting Item Set was built | Retrieve Item Set Metadata |
Validation scenarios
Use these endpoints to validate various components of the item sets in advertiser's account.
| Scenario | Use | To Confirm |
|---|---|---|
| Validate item set readiness | List Item Sets |
|
| Validate item set contents | Retrieve item set contents |
|
| Validate item set construction | Retrieve item set metadata |
|
Related pages
Updated about 2 hours ago
